Share via

Queues - Get

  • リファレンス
Service:
Service Bus
API Version:
2021-11-01

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

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

URI パラメーター

名前 / 必須 型 説明
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 バージョン。

応答

名前 型 説明
200 OK

SBQueue

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

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
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=2021-11-01

Sample Response

Status code:
200 
{
  "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,
    "maxMessageSizeInKilobytes": 10240,
    "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"
  }
}

定義

名前 説明
createdByType

リソースを作成した ID の種類。
EntityStatus

エンティティの状態。
Error

error オブジェクト。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorResponse

リソース管理エラー応答。
MessageCountDetails

メッセージ数の詳細。
SBQueue

キュー リソースの説明。
systemData

リソースの作成と最後の変更に関連するメタデータ。

createdByType

リソースを作成した ID の種類。

名前 型 説明
Application

string

Key

string

ManagedIdentity

string

User

string

EntityStatus

エンティティの状態。

名前 型 説明
Active

string

Creating

string

Deleting

string

Disabled

string

ReceiveDisabled

string

Renaming

string

Restoring

string

SendDisabled

string

Unknown

string

Error

error オブジェクト。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorResponse[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorResponse

リソース管理エラー応答。

名前 型 説明
error

Error

error オブジェクト。

MessageCountDetails

メッセージ数の詳細。

名前 型 説明
activeMessageCount

integer

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

integer

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

integer

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

integer

配信不能に転送されたメッセージの数。
transferMessageCount

integer

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

SBQueue

キュー リソースの説明。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

リソースが保存されている地理的な場所
name

string

リソースの名前
properties.accessedAt

string

メッセージが最後に送信されたとき、またはこのキューへの受信要求が最後に行われた時刻。
properties.autoDeleteOnIdle

string

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

MessageCountDetails

メッセージ数の詳細。
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

Express Entities が有効かどうかを示す 値。 高速キューは、永続ストレージに書き込む前に、メッセージを一時的にメモリに保持します。
properties.enablePartitioning

boolean

キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す 値。
properties.forwardDeadLetteredMessagesTo

string

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

string

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

string

ピーク ロックの ISO 8601 期間。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。
properties.maxDeliveryCount

integer

配信の最大数。 この配信数を越えた後のメッセージは自動的に配信不能になります。 既定値は 10 です。
properties.maxMessageSizeInKilobytes

integer

キューで受け入れられるメッセージ ペイロードの最大サイズ (KB 単位)。 このプロパティは現在 Premium でのみ使用され、既定値は 1024 です。
properties.maxSizeInMegabytes

integer

キューの最大サイズ (MB 単位)。 これは、キューに割り当てられたメモリのサイズです。 既定値は 1024 です。
properties.messageCount

integer

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

boolean

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

boolean

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

integer

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

EntityStatus

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

string

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

systemData

このリソースに関連するシステム メタデータ。
type

string

リソースの型。 例: "Microsoft.EventHub/Namespaces" または "Microsoft.EventHub/Namespaces/EventHubs"

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 型 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。
createdBy

string

リソースを作成した ID。
createdByType

createdByType

リソースを作成した ID の種類。
lastModifiedAt

string

リソースを最後に変更した ID の種類。
lastModifiedBy

string

リソースを最後に変更した ID。
lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。