Queues - Get
Retorna uma descrição para a fila especificada.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}?api-version=2021-11-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
namespace
|
path | True |
string |
O nome do namespace |
queue
|
path | True |
string |
O nome da fila. |
resource
|
path | True |
string |
Nome do grupo de recursos na assinatura do Azure. |
subscription
|
path | True |
string |
Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço. |
api-version
|
query | True |
string |
Versão de API do cliente. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Descrição da fila retornada com êxito. |
|
Other Status Codes |
Resposta de erro do ServiceBus que descreve por que a operação falhou. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nome | Description |
---|---|
user_impersonation | representar sua conta de usuário |
Exemplos
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
{
"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"
}
}
Definições
Nome | Description |
---|---|
created |
O tipo de identidade que criou o recurso. |
Entity |
Status de entidade. |
Error |
O objeto de erro. |
Error |
As informações adicionais do erro de gerenciamento de recursos. |
Error |
A resposta de erro de gerenciamento de recursos. |
Message |
Detalhes da Contagem de Mensagens. |
SBQueue |
Descrição do recurso de fila. |
system |
Metadados relativos à criação e à última modificação do recurso. |
createdByType
O tipo de identidade que criou o recurso.
Nome | Tipo | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
EntityStatus
Status de entidade.
Nome | Tipo | Description |
---|---|---|
Active |
string |
|
Creating |
string |
|
Deleting |
string |
|
Disabled |
string |
|
ReceiveDisabled |
string |
|
Renaming |
string |
|
Restoring |
string |
|
SendDisabled |
string |
|
Unknown |
string |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
additionalInfo |
As informações adicionais do erro. |
|
code |
string |
O código de erro. |
details |
Os detalhes do erro. |
|
message |
string |
A mensagem de erro. |
target |
string |
O destino do erro. |
ErrorAdditionalInfo
As informações adicionais do erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
info |
object |
As informações adicionais. |
type |
string |
O tipo de informação adicional. |
ErrorResponse
A resposta de erro de gerenciamento de recursos.
Nome | Tipo | Description |
---|---|---|
error |
O objeto de erro. |
MessageCountDetails
Detalhes da Contagem de Mensagens.
Nome | Tipo | Description |
---|---|---|
activeMessageCount |
integer |
Número de mensagens ativas na fila, tópico ou assinatura. |
deadLetterMessageCount |
integer |
Número de mensagens mortas. |
scheduledMessageCount |
integer |
Número de mensagens agendadas. |
transferDeadLetterMessageCount |
integer |
Número de mensagens transferidas para mensagens mortas. |
transferMessageCount |
integer |
Número de mensagens transferidas para outra fila, tópico ou assinatura. |
SBQueue
Descrição do recurso de fila.
Nome | Tipo | Description |
---|---|---|
id |
string |
ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
location |
string |
A localização geográfica em que o recurso reside |
name |
string |
O nome do recurso |
properties.accessedAt |
string |
Última vez que uma mensagem foi enviada ou a última vez em que houve uma solicitação de recebimento para essa fila. |
properties.autoDeleteOnIdle |
string |
Iso 8061 timeSpan idle interval after which the queue is automatically deleted. A duração mínima é de 5 minutos. |
properties.countDetails |
Detalhes da Contagem de Mensagens. |
|
properties.createdAt |
string |
A hora exata em que a mensagem foi criada. |
properties.deadLetteringOnMessageExpiration |
boolean |
Um valor que indica se essa fila tem suporte a mensagens mortas quando uma mensagem expira. |
properties.defaultMessageTimeToLive |
string |
Tempo de vida da mensagem padrão ISO 8601 para valor dinâmico. Essa é a duração após a qual a mensagem expira, começando de quando a mensagem é enviada ao Barramento de Serviço. Esse é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si. |
properties.duplicateDetectionHistoryTimeWindow |
string |
Estrutura timeSpan ISO 8601 que define a duração do histórico de detecção duplicado. O valor padrão é 10 minutos. |
properties.enableBatchedOperations |
boolean |
Valor que indica se as operações em lote do lado do servidor estão habilitadas. |
properties.enableExpress |
boolean |
Um valor que indica se as Entidades Expressas estão habilitadas. Uma fila expressa mantém uma mensagem na memória temporariamente antes de escrevê-la no armazenamento persistente. |
properties.enablePartitioning |
boolean |
Um valor que indica se a fila deve ser particionada entre vários agentes de mensagens. |
properties.forwardDeadLetteredMessagesTo |
string |
Nome da fila/tópico para encaminhar a mensagem de Mensagens Mortas |
properties.forwardTo |
string |
Nome da fila/tópico para encaminhar as mensagens |
properties.lockDuration |
string |
Duração do intervalo de tempo iso 8601 de um peek-lock; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros receptores. O valor máximo para LockDuration é de 5 minutos; o valor padrão é 1 minuto. |
properties.maxDeliveryCount |
integer |
A contagem máxima de entregas. Uma mensagem é automaticamente enviada para a fila de mensagens mortas após esse número de entregas. O valor padrão é 10. |
properties.maxMessageSizeInKilobytes |
integer |
Tamanho máximo (em KB) do conteúdo da mensagem que pode ser aceito pela fila. Essa propriedade só é usada no Premium hoje e o padrão é 1024. |
properties.maxSizeInMegabytes |
integer |
O tamanho máximo da fila em megabytes, que é o tamanho da memória alocada para a fila. O padrão é 1024. |
properties.messageCount |
integer |
O número de mensagens na fila. |
properties.requiresDuplicateDetection |
boolean |
Um valor que indica se essa fila requer detecção duplicada. |
properties.requiresSession |
boolean |
Um valor que indica se a fila dá suporte ao conceito de sessões. |
properties.sizeInBytes |
integer |
O tamanho da fila, em bytes. |
properties.status |
Enumera os valores possíveis para o status de uma entidade de mensagens. |
|
properties.updatedAt |
string |
A hora exata em que a mensagem foi atualizada. |
systemData |
Os metadados do sistema relacionados a esse recurso. |
|
type |
string |
Tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs" |
systemData
Metadados relativos à criação e à última modificação do recurso.
Nome | Tipo | Description |
---|---|---|
createdAt |
string |
O carimbo de data/hora da criação de recursos (UTC). |
createdBy |
string |
A identidade que criou o recurso. |
createdByType |
O tipo de identidade que criou o recurso. |
|
lastModifiedAt |
string |
O tipo de identidade que modificou o recurso pela última vez. |
lastModifiedBy |
string |
A identidade que modificou o recurso pela última vez. |
lastModifiedByType |
O tipo de identidade que modificou o recurso pela última vez. |