Queues - Get

指定されたキューの説明を返します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}?api-version=2017-04-01

URI パラメーター

Name In Required Type Description
namespaceName
path True
  • string

名前空間名

queueName
path True
  • string

キュー名。

resourceGroupName
path True
  • string

Azure サブスクリプション内のリソース グループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント API バージョン。

応答

Name Type Description
200 OK

キューの説明が正常に返されました。

Other Status Codes

操作が失敗した理由を示す ServiceBus エラー応答。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

QueueGet

Sample Request

GET https://management.azure.com/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647?api-version=2017-04-01

Sample Response

{
  "id": "/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647",
  "name": "sdk-Queues-5647",
  "type": "Microsoft.ServiceBus/Namespaces/Queues",
  "properties": {
    "lockDuration": "PT1M",
    "maxSizeInMegabytes": 163840,
    "requiresDuplicateDetection": false,
    "requiresSession": false,
    "defaultMessageTimeToLive": "P10675199DT2H48M5.4775807S",
    "duplicateDetectionHistoryTimeWindow": "PT10M",
    "maxDeliveryCount": 10,
    "sizeInBytes": 0,
    "messageCount": 0,
    "status": "Active",
    "autoDeleteOnIdle": "P10675199DT2H48M5.4775807S",
    "enablePartitioning": true,
    "enableExpress": false,
    "createdAt": "2017-05-26T18:07:32.4592931Z",
    "updatedAt": "2017-05-26T18:07:34.6243761Z",
    "accessedAt": "0001-01-01T00:00:00Z"
  }
}

定義

EntityStatus

エンティティの状態。

ErrorResponse

エラー応答は、ServiceBus サービスが受信要求を処理できない場合を示します。 理由はエラー メッセージに示されます。

MessageCountDetails

メッセージ数の詳細。

SBQueue

キュー リソースの説明。

EntityStatus

エンティティの状態。

Name Type Description
Active
  • string
Creating
  • string
Deleting
  • string
Disabled
  • string
ReceiveDisabled
  • string
Renaming
  • string
Restoring
  • string
SendDisabled
  • string
Unknown
  • string

ErrorResponse

エラー応答は、ServiceBus サービスが受信要求を処理できない場合を示します。 理由はエラー メッセージに示されます。

Name Type Description
code
  • string

エラー コード。

message
  • string

操作が失敗した理由を示すエラー メッセージ。

MessageCountDetails

メッセージ数の詳細。

Name Type Description
activeMessageCount
  • integer

キュー、トピック、またはサブスクリプション内のアクティブなメッセージの数。

deadLetterMessageCount
  • integer

配信不能メッセージの数。

scheduledMessageCount
  • integer

スケジュールされたメッセージの数。

transferDeadLetterMessageCount
  • integer

デッドレターに転送されたメッセージの数。

transferMessageCount
  • integer

別のキュー、トピック、またはサブスクリプションに転送されたメッセージの数。

SBQueue

キュー リソースの説明。

Name Type Description
id
  • string

リソース ID

name
  • string

リソース名

properties.accessedAt
  • string

メッセージが最後に送信された日時、またはこのキューに対する受信要求が最後に発生した時刻。

properties.autoDeleteOnIdle
  • string

ISO 8061 timeSpan アイドル間隔の後に、キューが自動的に削除されます。 最小時間は、5 分です。

properties.countDetails

メッセージ数の詳細。

properties.createdAt
  • string

メッセージが作成された正確な時刻。

properties.deadLetteringOnMessageExpiration
  • boolean

メッセージの有効期限が切れたときに、このキューで配信不能メッセージがサポートされているかどうかを示す値。

properties.defaultMessageTimeToLive
  • string

ISO 8601 のデフォルトメッセージの有効期間をライブ値にします。 これは、メッセージが Service Bus に送信されてから、メッセージの有効期限が切れるまでの期間です。 これは、TimeToLive がメッセージ自体に設定されていない場合に使用される既定値です。

properties.duplicateDetectionHistoryTimeWindow
  • string

重複データ検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

properties.enableBatchedOperations
  • boolean

サーバー側のバッチ処理操作が有効かどうかを示す値。

properties.enableExpress
  • boolean

エクスプレス エンティティが有効かどうかを示す値。 高速キューは、永続ストレージに書き込む前に、メモリ内にメッセージを一時的に保持します。

properties.enablePartitioning
  • boolean

キューを複数のメッセージ・ブローカーに分割するかどうかを示す値。

properties.forwardDeadLetteredMessagesTo
  • string

配信不能メッセージを転送するキュー/トピック名

properties.forwardTo
  • string

メッセージを転送するキュー/トピック名

properties.lockDuration
  • string

ピークロックの ISO 8601 の期間の期間。つまり、メッセージが他の受信者に対してロックされる時間です。 ロック期間の最大値は 5 分です。デフォルト値は 1 分です。

properties.maxDeliveryCount
  • integer

最大配信数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 デフォルト値は 10 です。

properties.maxSizeInMegabytes
  • integer

キューの最大サイズ (MB 単位)。 既定値は 1024 です。

properties.messageCount
  • integer

キュー内のメッセージ数です。

properties.requiresDuplicateDetection
  • boolean

このキューで重複データ検出が必要かどうかを示す値。

properties.requiresSession
  • boolean

キューがセッションの概念をサポートするかどうかを示す値。

properties.sizeInBytes
  • integer

キューのサイズ (バイト単位)。

properties.status

メッセージング エンティティの状態に使用できる値を列挙します。

properties.updatedAt
  • string

メッセージが更新された正確な時刻。

type
  • string

リソースの種類