Queues - Get

Referência

Serviço:: Service Bus

Versão da API:: 2024-01-01

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	O nome do namespace
queueName	path	True	string minLength: 1	O nome da fila.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	SBQueue	Descrição da fila retornada com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ServiceBus;

// Generated from example definition: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/examples/Queues/SBQueueGet.json
// this example is just showing the usage of "Queues_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceBusQueueResource created on azure
// for more information of creating ServiceBusQueueResource, please refer to the document of ServiceBusQueueResource
string subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
string resourceGroupName = "ArunMonocle";
string namespaceName = "sdk-Namespace-3174";
string queueName = "sdk-Queues-5647";
ResourceIdentifier serviceBusQueueResourceId = ServiceBusQueueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, namespaceName, queueName);
ServiceBusQueueResource serviceBusQueue = client.GetServiceBusQueueResource(serviceBusQueueResourceId);

// invoke the operation
ServiceBusQueueResource result = await serviceBusQueue.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ServiceBusQueueData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 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"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
EntityStatus	Estado da entidade.
Error	O objeto de erro.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorResponse	A resposta de erro de gerenciamento de recursos.
MessageCountDetails	Detalhes da contagem de mensagens.
SBQueue	Descrição do recurso de fila.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EntityStatus

Enumeração

Estado da entidade.

Valor	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

O objeto de erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorResponse[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorResponse

Object

A resposta de erro de gerenciamento de recursos.

Name	Tipo	Description
error	Error	O objeto de erro.

MessageCountDetails

Object

Detalhes da contagem de mensagens.

Name	Tipo	Description
activeMessageCount	integer (int64)	Número de mensagens ativas na fila, tópico ou assinatura.
deadLetterMessageCount	integer (int64)	Número de mensagens com letras mortas.
scheduledMessageCount	integer (int64)	Número de mensagens agendadas.
transferDeadLetterMessageCount	integer (int64)	Número de mensagens transferidas em letras mortas.
transferMessageCount	integer (int64)	Número de mensagens transferidas para outra fila, tópico ou assinatura.

SBQueue

Object

Descrição do recurso de fila.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A geolocalização onde o recurso vive
name	string	O nome do recurso
properties.accessedAt	string (date-time)	Da última vez que uma mensagem foi enviada, ou da última vez que houve uma solicitação de recebimento para essa fila.
properties.autoDeleteOnIdle	string (duration)	ISO 8061 timeSpan intervalo ocioso após o qual a fila é excluída automaticamente. A duração mínima é de 5 minutos.
properties.countDetails	MessageCountDetails	Detalhes da contagem de mensagens.
properties.createdAt	string (date-time)	A hora exata em que a mensagem foi criada.
properties.deadLetteringOnMessageExpiration	boolean	Um valor que indica se essa fila tem suporte a letra morta quando uma mensagem expira.
properties.defaultMessageTimeToLive	string (duration)	Tempo de tempo de mensagem padrão ISO 8601 para o valor em tempo real. Esta é a duração após a qual a mensagem expira, a partir de quando a mensagem é enviada para o Service Bus. Este é o valor padrão usado quando TimeToLive não está definido em uma mensagem em si.
properties.duplicateDetectionHistoryTimeWindow	string (duration)	Estrutura timeSpan ISO 8601 que define a duração do histórico de deteção de duplicados. 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 gravá-la no armazenamento persistente.
properties.enablePartitioning	boolean	Um valor que indica se a fila deve ser particionada em vários agentes de mensagens.
properties.forwardDeadLetteredMessagesTo	string	Nome da fila/tópico para encaminhar a mensagem de letra morta
properties.forwardTo	string	Nome da fila/tópico para encaminhar as mensagens
properties.lockDuration	string (duration)	ISO 8601 duração de um bloqueio de espreita; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros recetores. O valor máximo para LockDuration é 5 minutos; O valor padrão é 1 minuto.
properties.maxDeliveryCount	integer (int32)	A contagem máxima de entregas. Uma mensagem é automaticamente deadlettered após este número de entregas. O valor padrão é 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Tamanho máximo (em KB) da carga útil da mensagem que pode ser aceite pela fila. Esta propriedade só é usada no Premium hoje e o padrão é 1024.
properties.maxSizeInMegabytes	integer (int32)	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 (int64)	O número de mensagens na fila.
properties.requiresDuplicateDetection	boolean	Um valor que indica se essa fila requer deteção de duplicata.
properties.requiresSession	boolean	Um valor que indica se a fila suporta o conceito de sessões.
properties.sizeInBytes	integer (int64)	O tamanho da fila, em bytes.
properties.status	EntityStatus	Enumera os valores possíveis para o status de uma entidade de mensagens.
properties.updatedAt	string (date-time)	A hora exata em que a mensagem foi atualizada.
systemData	systemData	Os metadados do sistema relacionados a este recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O tipo de identidade que modificou o recurso pela última vez.
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Queues - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

QueueGet

Pedido de amostra

Resposta da amostra

Definições

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Recursos adicionais