Queues - Get

Referência

Service:: Service Bus

API Version:: 2021-11-01

Devolve 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 do URI

Name	Em	Necessário	Tipo	Description
namespaceName	path	True	string	O nome do espaço de nomes
queueName	path	True	string	O nome da fila.
resourceGroupName	path	True	string	Nome do Grupo de recursos na subscrição do Azure.
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente uma subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	SBQueue	A descrição da fila foi devolvida com êxito.
Other Status Codes	ErrorResponse	Resposta de erro do ServiceBus que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

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


import com.azure.core.util.Context;

/** Samples for Queues Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
     */
    /**
     * Sample code: QueueGet.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void queueGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.serviceBusNamespaces().manager().serviceClient().getQueues().getWithResponse("ArunMonocle",
            "sdk-Namespace-3174", "sdk-Queues-5647", Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.servicebus import ServiceBusManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-servicebus
# USAGE
    python sb_queue_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ServiceBusManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="5f750a97-50d9-4e36-8081-c9ee4c0210d4",
    )

    response = client.queues.get(
        resource_group_name="ArunMonocle",
        namespace_name="sdk-Namespace-3174",
        queue_name="sdk-Queues-5647",
    )
    print(response)


# x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
if __name__ == "__main__":
    main()

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

package armservicebus_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/servicebus/armservicebus"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
func ExampleQueuesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armservicebus.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueuesClient().Get(ctx, "ArunMonocle", "sdk-Namespace-3174", "sdk-Queues-5647", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SBQueue = armservicebus.SBQueue{
	// 	Name: to.Ptr("sdk-Queues-5647"),
	// 	Type: to.Ptr("Microsoft.ServiceBus/Namespaces/Queues"),
	// 	ID: to.Ptr("/subscriptions/5f750a97-50d9-4e36-8081-c9ee4c0210d4/resourceGroups/ArunMonocle/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-3174/queues/sdk-Queues-5647"),
	// 	Properties: &armservicebus.SBQueueProperties{
	// 		AccessedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "1-01-01T00:00:00.000Z"); return t}()),
	// 		AutoDeleteOnIdle: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:32.459Z"); return t}()),
	// 		DefaultMessageTimeToLive: to.Ptr("P10675199DT2H48M5.4775807S"),
	// 		DuplicateDetectionHistoryTimeWindow: to.Ptr("PT10M"),
	// 		EnableExpress: to.Ptr(false),
	// 		EnablePartitioning: to.Ptr(true),
	// 		LockDuration: to.Ptr("PT1M"),
	// 		MaxDeliveryCount: to.Ptr[int32](10),
	// 		MaxMessageSizeInKilobytes: to.Ptr[int64](10240),
	// 		MaxSizeInMegabytes: to.Ptr[int32](163840),
	// 		MessageCount: to.Ptr[int64](0),
	// 		RequiresDuplicateDetection: to.Ptr(false),
	// 		RequiresSession: to.Ptr(false),
	// 		SizeInBytes: to.Ptr[int64](0),
	// 		Status: to.Ptr(armservicebus.EntityStatusActive),
	// 		UpdatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2017-05-26T18:07:34.624Z"); return t}()),
	// 	},
	// }
}

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

const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Returns a description for the specified queue.
 *
 * @summary Returns a description for the specified queue.
 * x-ms-original-file: specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2021-11-01/examples/Queues/SBQueueGet.json
 */
async function queueGet() {
  const subscriptionId = "5f750a97-50d9-4e36-8081-c9ee4c0210d4";
  const resourceGroupName = "ArunMonocle";
  const namespaceName = "sdk-Namespace-3174";
  const queueName = "sdk-Queues-5647";
  const credential = new DefaultAzureCredential();
  const client = new ServiceBusManagementClient(credential, subscriptionId);
  const result = await client.queues.get(resourceGroupName, namespaceName, queueName);
  console.log(result);
}

queueGet().catch(console.error);

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

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"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
EntityStatus	Estado da entidade.
Error	O objeto de erro.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorResponse	A resposta ao erro de gestão de recursos.
MessageCountDetails	Detalhes da Contagem de Mensagens.
SBQueue	Descrição do Recurso de fila.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Estado da entidade.

Name	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.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
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

Informações adicionais sobre o erro de gestão de recursos.

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

ErrorResponse

A resposta ao erro de gestão de recursos.

Name	Tipo	Description
error	Error	O objeto de erro.

MessageCountDetails

Detalhes da Contagem de Mensagens.

Name	Tipo	Description
activeMessageCount	integer	Número de mensagens ativas na fila, tópico ou subscrição.
deadLetterMessageCount	integer	Número de mensagens que não são enviadas.
scheduledMessageCount	integer	Número de mensagens agendadas.
transferDeadLetterMessageCount	integer	Número de mensagens transferidas para cartas não entregues.
transferMessageCount	integer	Número de mensagens transferidas para outra fila, tópico ou subscrição.

SBQueue

Descrição do Recurso de fila.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	A localização geográfica onde o recurso se encontra
name	string	O nome do recurso
properties.accessedAt	string	A última vez que uma mensagem foi enviada ou a última vez que houve um pedido de receção para esta fila.
properties.autoDeleteOnIdle	string	Intervalo de inatividade iso 8061 timeSpan após o qual a fila é eliminada automaticamente. A duração mínima é 5 minutos.
properties.countDetails	MessageCountDetails	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 esta fila tem suporte de letra inativa quando uma mensagem expira.
properties.defaultMessageTimeToLive	string	IsO 8601 período de tempo de mensagem predefinido para valor dinâmico. Esta é a duração após a qual a mensagem expira, a partir do momento em que a mensagem é enviada para o Service Bus. Este é o valor predefinido utilizado quando TimeToLive não está definido numa mensagem propriamente dita.
properties.duplicateDetectionHistoryTimeWindow	string	ISO 8601 timeSpan structure that define a duração do histórico de deteção duplicado. O valor predefinido é 10 minutos.
properties.enableBatchedOperations	boolean	Valor que indica se as operações em lote do lado do servidor estão ativadas.
properties.enableExpress	boolean	Um valor que indica se as Entidades Express estão ativadas. Uma fila rápida contém temporariamente uma mensagem na memória antes de a escrever no armazenamento persistente.
properties.enablePartitioning	boolean	Um valor que indica se a fila deve ser particionada em vários mediadores de mensagens.
properties.forwardDeadLetteredMessagesTo	string	Nome da fila/tópico para reencaminhar a mensagem Carta Morta
properties.forwardTo	string	Nome da fila/tópico para reencaminhar as mensagens
properties.lockDuration	string	ISO 8601 duração do intervalo de tempo de um bloqueio de pré-visualização; ou seja, a quantidade de tempo que a mensagem está bloqueada para outros recetores. O valor máximo para LockDuration é de 5 minutos; o valor predefinido é 1 minuto.
properties.maxDeliveryCount	integer	A contagem máxima de entrega. Uma mensagem é automaticamente inativa após este número de entregas. o valor predefinido é 10.
properties.maxMessageSizeInKilobytes	integer	Tamanho máximo (em KB) do payload da mensagem que pode ser aceite pela fila. Esta propriedade só é utilizada hoje em dia no Premium e a predefinição é 1024.
properties.maxSizeInMegabytes	integer	O tamanho máximo da fila em megabytes, que é o tamanho da memória alocada para a fila. A predefinição é 1024.
properties.messageCount	integer	O número de mensagens na fila.
properties.requiresDuplicateDetection	boolean	Um valor que indica se esta fila requer deteção duplicada.
properties.requiresSession	boolean	Um valor que indica se a fila suporta o conceito de sessões.
properties.sizeInBytes	integer	O tamanho da fila, em bytes.
properties.status	EntityStatus	Enumera os valores possíveis para o estado de uma entidade de mensagens.
properties.updatedAt	string	A hora exata em que a mensagem foi atualizada.
systemData	systemData	Os metadados do sistema relacionados com este recurso.
type	string	O tipo de recurso. Por exemplo, "Microsoft.EventHub/Namespaces" ou "Microsoft.EventHub/Namespaces/EventHubs"

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

Queues - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Scopes

Exemplos

QueueGet

Sample Request

Sample Response

Definições

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Recursos adicionais