Queues - Get

Referencia

Servicio:: Service Bus

Versión de la API:: 2024-01-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=2024-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
namespaceName	path	True	string minLength: 6 maxLength: 50	Nombre del espacio de nombres
queueName	path	True	string minLength: 1	Nombre de la cola.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
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 de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

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 de 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	suplantar la cuenta de usuario

Ejemplos

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

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 relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

EntityStatus

Enumeración

Estado de la entidad.

Valor	Description
Active
Creating
Deleting
Disabled
ReceiveDisabled
Renaming
Restoring
SendDisabled
Unknown

Error

Object

Objeto de error.

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

ErrorAdditionalInfo

Object

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

Object

Respuesta de error de administración de recursos.

Nombre	Tipo	Description
error	Error	Objeto de error.

MessageCountDetails

Object

Detalles del recuento de mensajes.

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

SBQueue

Object

Descripción del recurso de cola.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el 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 (date-time)	Última vez que se envió un mensaje o la última vez que se produjo una solicitud de recepción a esta cola.
properties.autoDeleteOnIdle	string (duration)	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 (date-time)	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 (duration)	El intervalo de tiempo predeterminado del mensaje ISO 8601 es activo. Esta es la duración después de la cual expira el mensaje, a partir de cuándo 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 (duration)	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 express 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 la 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 (duration)	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 (int32)	Número máximo de entregas. Un mensaje se activa automáticamente después de este número de entregas. el valor predeterminado es 10.
properties.maxMessageSizeInKilobytes	integer (int64)	Tamaño máximo (en KB) de la carga del mensaje que la cola puede aceptar. Esta propiedad solo se usa actualmente en Premium y el valor predeterminado es 1024.
properties.maxSizeInMegabytes	integer (int32)	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 (int64)	Número de mensajes de 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 (int64)	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 (date-time)	Hora exacta en que se actualizó el mensaje.
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.EventHub/Namespaces" o "Microsoft.EventHub/Namespaces/EventHubs"

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	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 (date-time)	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.

Compartir a través de

Queues - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

QueueGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

EntityStatus

Error

ErrorAdditionalInfo

ErrorResponse

MessageCountDetails

SBQueue

systemData

Recursos adicionales