Get Queue Service Properties

Artículo
06/27/2023

La Get Queue Service Properties operación obtiene las propiedades de una cuenta de Azure Queue Storage, incluidas las propiedades de Storage Analytics y reglas de uso compartido de recursos entre orígenes (CORS).

Para más información sobre las reglas de uso compartido de recursos entre orígenes (CORS) y la lógica de evaluación, consulte Compatibilidad de CORS con los servicios de Azure Storage.

Request

La solicitud Get Queue Service Properties se puede especificar como sigue. Se recomienda usar HTTPS. Reemplace <account-name> por el nombre de la cuenta de almacenamiento:

Método	URI de solicitud	Versión de HTTP
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Nota:

El URI siempre debe incluir un carácter de barra diagonal (/) para separar el nombre de host de la ruta de acceso y las partes de consulta del URI. En esta operación, la parte de ruta de acceso del URI está vacía.

Parámetros del identificador URI

Se pueden especificar los siguientes parámetros adicionales en el URI de solicitud:

Parámetro	Descripción
`restype=service&comp=properties`	Necesario. Es necesaria la combinación de ambas cadenas de consulta para obtener las propiedades del servicio de almacenamiento.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para más información, consulte Establecimiento de tiempos de espera para las operaciones de Azure Queue Storage.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.

Encabezado de solicitud	Descripción
`Authorization`	Necesario. Especifica el esquema de autorización, el nombre de la cuenta de almacenamiento y la firma. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`Date` o `x-ms-date`	Necesario. Especifica la hora universal coordinada (UTC) de la solicitud. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`x-ms-version`	Obligatorio para todas las solicitudes autorizadas. Especifica la versión de la operación que se utiliza para esta solicitud. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 kibibyte (KiB) que se registra en los registros cuando se configura el registro. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes que recibe el servidor. Para más información, consulte Supervisión de Azure Queue Storage.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

status code

Una operación correcta devuelve el código de estado 200 Correcto.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir otros encabezados HTTP estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta	Descripción
`x-ms-request-id`	Identifica de forma única una solicitud realizada en el servicio.
`x-ms-version`	Especifica la versión de la operación utilizada para la respuesta. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Se puede usar para solucionar problemas de solicitudes y respuestas correspondientes. El valor de este encabezado es igual al valor del `x-ms-client-request-id` encabezado si está presente en la solicitud y el valor no contiene más de 1024 caracteres ASCII visibles. Si el `x-ms-client-request-id` encabezado no está presente en la solicitud, no estará presente en la respuesta.

Response body

Para la versión 2012-02-12 y otras anteriores, el formato del cuerpo de la respuesta es el siguiente:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <Metrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Metrics>  
</StorageServiceProperties>

A partir de la versión 2013-08-15, el formato del cuerpo de la respuesta es el siguiente:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>version-number</Version>  
        <Delete>true|false</Delete>  
        <Read>true|false</Read>  
        <Write>true|false</Write>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders> comma-separated-list-of-request-headers </AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Los elementos del cuerpo de respuesta se describen en la tabla siguiente:

Nombre del elemento	Descripción
Logging	Agrupa la configuración de registro de Storage Analytics.
Métricas	Agrupa la configuración de métricas de Storage Analytics. Los valores de Metrics proporcionan un resumen de las estadísticas de solicitudes agrupadas por API en agregados a intervalos de una hora para las colas.
HourMetrics	Agrupa la configuración de Storage Analytics HourMetrics. Los valores de HourMetrics proporcionan un resumen de las estadísticas de solicitudes agrupadas por API en agregados a intervalos de una hora para las colas.
MinuteMetrics	Agrupa la configuración de Storage Analytics MinuteMetrics. Los valores de MinuteMetrics* proporcionan estadísticas de solicitudes para cada minuto para las colas.
Versión	La versión de Storage Analytics que se está usando actualmente.
Eliminar	Solo se aplica a la configuración de registro. Indica si se están registrando las solicitudes de eliminación.
Lectura	Solo se aplica a la configuración de registro. Indica si se están registrando las solicitudes de lectura.
Escritura	Solo se aplica a la configuración de registro. Indica si se están registrando las solicitudes de escritura.
Enabled	Indica si las métricas están habilitadas para Azure Queue Storage. Si está habilitada la replicación con redundancia geográfica con acceso de lectura, se recopilan las métricas principales y secundarias. Si no está habilitada la replicación con redundancia geográfica con acceso de lectura, solo se recopilan las métricas principales.
IncludeAPIs	Se aplica solamente a la configuración de métricas. Indica si las métricas generan estadísticas de resumen para las operaciones de API a las que se ha llamado.
RetentionPolicy/Enabled	Indica si se ha habilitado una directiva de retención para el servicio de almacenamiento.
RetentionPolicy/Days	Indica el número de días que se conservan los datos de métricas o de registro. Todos los datos anteriores a este valor se eliminarán.
Cors	Agrupa todas las reglas de CORS.
CorsRule	Agrupa los valores de una regla de CORS.
AllowedOrigins	Una lista separada por comas de dominios de origen que se permiten a través de CORS o un asterisco (*) si se permiten todos los dominios.
ExposedHeaders	Lista delimitada por comas de encabezados de respuesta para exponer a los clientes de CORS.
MaxAgeInSeconds	Número de segundos que el cliente o explorador debe almacenar en caché una respuesta preparatoria.
AllowedHeaders	Lista separada por comas de encabezados que pueden formar parte de la solicitud entre orígenes.
AllowedMethods	Lista delimitada por comas de los métodos HTTP que puede ejecutar el origen. Para Azure Storage, los métodos permitidos son DELETE, GET, HEAD, MERGE, POST, OPTIONS o PUT.

Authorization

Solo el propietario de la cuenta de almacenamiento puede llamar a esta operación.

Solicitud y respuesta de ejemplo

El URI de ejemplo siguiente realiza una solicitud para obtener las propiedades del servicio Cola para la cuenta de almacenamiento ficticia denominada myaccount:

GET https://myaccount.queue.core.windows.net/?restype=service&comp=properties HTTP/1.1

La solicitud se envía con los encabezados siguientes:

x-ms-version: 2013-08-15  
x-ms-date: Wed, 23 Oct 2013 04:49:03 GMT  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.queue.core.windows.net

Una vez enviada la solicitud, se devuelve la respuesta siguiente:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: Wed, 23 Oct 2013 04:49:04 GMT  
Server: Windows-Azure-Queue/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2013-08-15

El cuerpo de respuesta es similar al siguiente:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <Logging>  
        <Version>1.0</Version>  
        <Delete>true</Delete>  
        <Read>false</Read>  
        <Write>true</Write>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </Logging>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
        <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins> http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>  
</StorageServiceProperties>

Consulte también

Storage Analytics
Compatibilidad de CORS con los servicios de Azure Storage
Especificación HTTP de CORS