Queues - Get

Servicio:

Service Bus

Versión de la API:

2021-11-01

Devuelve una descripción de la cola 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 identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string	Nombre del espacio de nombres
queueName	path	True	string	Nombre de cola.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única una suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI para cada llamada al servicio.
api-version	query	True	string	Versión de API del cliente.

Respuestas

Nombre	Tipo	Description
200 OK	SBQueue	La descripción de la cola se devolvió correctamente.
Other Status Codes	ErrorResponse	Respuesta de error de ServiceBus que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

QueueGet

Solicitud de ejemplo

HTTP

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

Java

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

Python

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

Go

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

JavaScript

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

Respuesta de muestra

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

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
EntityStatus	Estado de la entidad.
Error	Objeto de error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error de administración de recursos.
MessageCountDetails	Detalles del recuento de mensajes.
SBQueue	Descripción del recurso de cola.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EntityStatus

Estado de la entidad.

Nombre	Tipo	Description
Active	string
Creating	string
Deleting	string
Disabled	string
ReceiveDisabled	string
Renaming	string
Restoring	string
SendDisabled	string
Unknown	string

Error

Objeto de error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

MessageCountDetails

Detalles del recuento de mensajes.

Nombre	Tipo	Description
activeMessageCount	integer	Número de mensajes activos en la cola, el tema o la suscripción.
deadLetterMessageCount	integer	Número de mensajes fallidos.
scheduledMessageCount	integer	Número de mensajes programados.
transferDeadLetterMessageCount	integer	Número de mensajes transferidos a mensajes fallidos.
transferMessageCount	integer	Número de mensajes transferidos a otra cola, tema o suscripción.

SBQueue

Descripción del recurso de cola.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Ubicación geográfica donde reside el recurso
name	string	Nombre del recurso.
properties.accessedAt	string	Última vez que se envió un mensaje o la última vez que hubo una solicitud de recepción a esta cola.
properties.autoDeleteOnIdle	string	Intervalo de inactividad de timeSpan iso 8061 después del cual se elimina automáticamente la cola. La duración mínima es de 5 minutos.
properties.countDetails	MessageCountDetails	Detalles del recuento de mensajes.
properties.createdAt	string	Hora exacta en que se creó el mensaje.
properties.deadLetteringOnMessageExpiration	boolean	Valor que indica si esta cola tiene compatibilidad con mensajes fallidos cuando expira un mensaje.
properties.defaultMessageTimeToLive	string	Intervalo de tiempo del mensaje predeterminado ISO 8601 para el valor activo. Esta es la duración después de la cual expira el mensaje, a partir de cuando se envía el mensaje a Service Bus. Este es el valor predeterminado que se usa cuando TimeToLive no está establecido en un mensaje en sí.
properties.duplicateDetectionHistoryTimeWindow	string	Estructura timeSpan iso 8601 que define la duración del historial de detección de duplicados. El valor predeterminado es 10 minutos.
properties.enableBatchedOperations	boolean	Valor que indica si las operaciones por lotes del lado servidor están habilitadas.
properties.enableExpress	boolean	Valor que indica si las entidades rápidas están habilitadas. Una cola rápida contiene un mensaje en la memoria temporalmente antes de escribirlo en el almacenamiento persistente.
properties.enablePartitioning	boolean	Valor que indica si la cola se va a particionar entre varios agentes de mensajes.
properties.forwardDeadLetteredMessagesTo	string	Nombre de cola o tema para reenviar el mensaje de mensajes fallidos
properties.forwardTo	string	Nombre de cola o tema para reenviar los mensajes
properties.lockDuration	string	Duración del intervalo de tiempo ISO 8601 de un bloqueo de inspección; es decir, la cantidad de tiempo que el mensaje está bloqueado para otros receptores. El valor máximo de LockDuration es de 5 minutos; el valor predeterminado es 1 minuto.
properties.maxDeliveryCount	integer	Recuento máximo de entregas. Un mensaje se pone automáticamente en la cola de mensajes fallidos cuando se alcanza este número de entregas. el valor predeterminado es 10.
properties.maxMessageSizeInKilobytes	integer	Tamaño máximo (en KB) de la carga del mensaje que puede aceptar la cola. Esta propiedad solo se usa actualmente en Premium y el valor predeterminado es 1024.
properties.maxSizeInMegabytes	integer	Tamaño máximo de la cola en megabytes, que es el tamaño de la memoria asignada para la cola. El valor predeterminado es 1024.
properties.messageCount	integer	Número de mensajes en la cola.
properties.requiresDuplicateDetection	boolean	Valor que indica si esta cola requiere detección de duplicados.
properties.requiresSession	boolean	Valor que indica si la cola admite el concepto de sesiones.
properties.sizeInBytes	integer	Tamaño de la cola, en bytes.
properties.status	EntityStatus	Enumera los valores posibles para el estado de una entidad de mensajería.
properties.updatedAt	string	Hora exacta en que se actualizó el mensaje.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Tipo de identidad que modificó por última vez el recurso.
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.