通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Queues - Get

服务:
Service Bus
API 版本:
2024-01-01

返回指定队列的说明。

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

URI 参数

名称 在 必需 类型 说明
namespaceName
 path True

string

minLength: 6
maxLength: 50

命名空间名称
queueName
 path True

string

minLength: 1

队列名称。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

资源组的名称。 名称不区分大小写。
subscriptionId
 path True

string

唯一标识Microsoft Azure 订阅的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version
 query True

string

minLength: 1

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

SBQueue

队列说明已成功返回。
Other Status Codes

ErrorResponse

描述作失败的原因的 ServiceBus 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

QueueGet

示例请求

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=2024-01-01

示例响应

状态代码:
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

创建资源的标识的类型。
EntityStatus

实体状态。
Error

错误对象。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorResponse

资源管理错误响应。
MessageCountDetails

消息计数详细信息。
SBQueue

队列资源的说明。
systemData

与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

EntityStatus

枚举

实体状态。

值 说明
Active
Disabled
Restoring
SendDisabled
ReceiveDisabled
Creating
Deleting
Renaming
Unknown

Error

Object

错误对象。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorResponse[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorResponse

Object

资源管理错误响应。

名称 类型 说明
error

Error

错误对象。

MessageCountDetails

Object

消息计数详细信息。

名称 类型 说明
activeMessageCount

integer (int64)

队列、主题或订阅中的活动消息数。
deadLetterMessageCount

integer (int64)

死信的消息数。
scheduledMessageCount

integer (int64)

计划消息数。
transferDeadLetterMessageCount

integer (int64)

传输到死信的消息数。
transferMessageCount

integer (int64)

传输到另一个队列、主题或订阅的消息数。

SBQueue

Object

队列资源的说明。

名称 类型 说明
id

string

资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

资源所在的地理位置
name

string

资源的名称
properties.accessedAt

string (date-time)

上次发送消息时，或上次发出此队列的接收请求。
properties.autoDeleteOnIdle

string (duration)

ISO 8061 timeSpan 空闲间隔后，队列会自动删除。 最短持续时间为 5 分钟。
properties.countDetails

MessageCountDetails

消息计数详细信息。
properties.createdAt

string (date-time)

创建消息的确切时间。
properties.deadLetteringOnMessageExpiration

boolean

一个值，该值指示消息过期时此队列是否具有死信支持。
properties.defaultMessageTimeToLive

string (duration)

ISO 8601 默认消息时间跨度为实时值。 这是消息过期的持续时间，从消息发送到服务总线时开始。 这是未在消息本身上设置 TimeToLive 时使用的默认值。
properties.duplicateDetectionHistoryTimeWindow

string (duration)

定义重复检测历史记录持续时间的 ISO 8601 timeSpan 结构。 默认值为 10 分钟。
properties.enableBatchedOperations

boolean

指示是否启用服务器端批处理作的值。
properties.enableExpress

boolean

一个值，该值指示是否启用 Express Entities。 快速队列将消息暂时保存在内存中，然后再将其写入永久性存储。
properties.enablePartitioning

boolean

一个值，该值指示队列是否要在多个消息中转站之间分区。
properties.forwardDeadLetteredMessagesTo

string

用于转发死信消息的队列/主题名称
properties.forwardTo

string

用于转发消息的队列/主题名称
properties.lockDuration

string (duration)

扫视锁的 ISO 8601 时间跨度持续时间;也就是说，为其他接收方锁定消息的时间量。 LockDuration 的最大值为 5 分钟;默认值为 1 分钟。
properties.maxDeliveryCount

integer (int32)

最大传递计数。 在传递数之后，消息会自动死机。 默认值为 10。
properties.maxMessageSizeInKilobytes

integer (int64)

队列可以接受的消息有效负载的最大大小（以 KB 为单位）。 此属性仅在高级版中使用，默认值为 1024。
properties.maxSizeInMegabytes

integer (int32)

队列的最大大小（以兆字节为单位），即为队列分配的内存大小。 默认值为 1024。
properties.messageCount

integer (int64)

队列中的消息数。
properties.requiresDuplicateDetection

boolean

一个值，该值指示此队列是否需要重复检测。
properties.requiresSession

boolean

一个值，该值指示队列是否支持会话的概念。
properties.sizeInBytes

integer (int64)

队列的大小（以字节为单位）。
properties.status

EntityStatus

枚举消息实体状态的可能值。
properties.updatedAt

string (date-time)

消息的确切更新时间。
systemData

systemData

与此资源相关的系统元数据。
type

string

资源的类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”

systemData

Object

与创建和上次修改资源相关的元数据。

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改资源的标识的类型。
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

上次修改资源的标识的类型。