Obter Propriedades do Serviço de Fila

Artigo
06/27/2023

A Get Queue Service Properties operação obtém as propriedades de uma conta de Armazenamento de Filas do Azure, incluindo propriedades para Análise de Armazenamento e regras de partilha de recursos transversais à origem (CORS).

Para obter mais informações sobre as regras de partilha de recursos de várias origens (CORS) e a lógica de avaliação, veja Suporte do CORS para os serviços de Armazenamento do Azure.

Pedir

O Get Queue Service Properties pedido pode ser especificado da seguinte forma. Recomendamos que utilize HTTPS. Substitua <account-name> pelo nome da sua conta de armazenamento:

Método	URI do pedido	Versão HTTP
GET	`https://<account-name>.queue.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Nota

O URI tem de incluir sempre um caráter de barra (/) para separar o nome do anfitrião das partes do caminho e da consulta do URI. Nesta operação, a parte do caminho do URI está vazia.

Parâmetros do URI

Os seguintes parâmetros adicionais podem ser especificados no URI do pedido:

Parâmetro	Description
`restype=service&comp=properties`	Obrigatório. A combinação de ambas as cadeias de consulta é necessária para obter as propriedades do serviço de armazenamento.
`timeout`	Opcional. O `timeout` parâmetro é expresso em segundos. Para obter mais informações, veja Set time-outs for Azure Queue Storage operations (Definir tempos limite para operações de Armazenamento de Filas do Azure).

Cabeçalhos do pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Cabeçalho do pedido	Description
`Authorization`	Obrigatório. Especifica o esquema de autorização, o nome da conta de armazenamento e a assinatura. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatório. Especifica a Hora Universal Coordenada (UTC) do pedido. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure.
`x-ms-version`	Necessário para todos os pedidos autorizados. Especifica a versão da operação a utilizar para este pedido. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de carateres de 1 kibibyte (KiB) que é registado nos registos quando o registo é configurado. Recomendamos vivamente que utilize este cabeçalho para correlacionar as atividades do lado do cliente com os pedidos que o servidor recebe. Para obter mais informações, veja Monitorizar o Armazenamento de Filas do Azure.

Corpo do pedido

Nenhum.

Resposta

A resposta inclui um código de estado HTTP, um conjunto de cabeçalhos de resposta e um corpo de resposta.

Código de estado

Uma operação bem-sucedida devolve o código de estado 200 (OK).

Cabeçalhos de resposta

A resposta para esta operação inclui os seguintes cabeçalhos. A resposta também pode incluir cabeçalhos HTTP padrão adicionais. Todos os cabeçalhos padrão estão em conformidade com a especificação do protocolo HTTP/1.1.

Cabeçalho de resposta	Descrição
`x-ms-request-id`	Identifica exclusivamente um pedido feito contra o serviço.
`x-ms-version`	Especifica a versão da operação utilizada para a resposta. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Pode ser utilizado para resolver problemas de pedidos e respostas correspondentes. O valor deste cabeçalho é igual ao valor do `x-ms-client-request-id` cabeçalho se estiver presente no pedido e o valor não contiver mais de 1024 carateres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente no pedido, não estará presente na resposta.

Corpo da resposta

Para a versão 2012-02-12 e anterior, o formato do corpo da resposta é o seguinte:

<?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 da versão 2013-08-15, o formato do corpo da resposta é o seguinte:

<?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>

Os elementos do corpo da resposta estão descritos na tabela seguinte:

Nome do Elemento	Description
Registo	Agrupa as definições de Registo de Análise de Armazenamento.
Métricas	Agrupa as definições de Métricas do Análise de Armazenamento. As definições de Métricas fornecem um resumo das estatísticas de pedido agrupadas pela API em agregações por hora para filas.
HourMetrics	Agrupa as definições Análise de Armazenamento HourMetrics. As definições HourMetrics fornecem um resumo das estatísticas de pedido agrupadas pela API em agregações por hora para filas.
MinuteMetrics	Agrupa as definições Análise de Armazenamento MinuteMetrics. As definições MinuteMetrics fornecem estatísticas* de pedidos para cada minuto para filas.
Versão	A versão do Análise de Armazenamento atualmente em utilização.
Eliminar	Aplica-se apenas à configuração de registo. Indica se os pedidos de eliminação estão a ser registados.
Ler	Aplica-se apenas à configuração de registo. Indica se os pedidos de leitura estão a ser registados.
Escrever	Aplica-se apenas à configuração de registo. Indica se os pedidos de escrita estão a ser registados.
Ativado	Indica se as métricas estão ativadas para o Armazenamento de Filas do Azure. Se a replicação georredundante com acesso de leitura estiver ativada, as métricas primária e secundária são recolhidas. Se a replicação georredundante com acesso de leitura não estiver ativada, apenas são recolhidas as métricas principais.
IncludeAPIs	Aplica-se apenas à configuração de métricas. Indica se as métricas geram estatísticas de resumo para as operações de API denominadas.
RetentionPolicy/Enabled	Indica se uma política de retenção está ativada para o serviço de armazenamento.
RetentionPolicy/Days	Indica o número de dias em que as métricas ou os dados de registo são retidos. Todos os dados mais antigos que este valor serão eliminados.
Cors	Agrupa todas as regras CORS.
CorsRule	Agrupa as definições de uma regra CORS.
AllowedOrigins	Uma lista separada por vírgulas de domínios de origem permitidos através de CORS ou um asterisco (*) se todos os domínios forem permitidos.
ExposedHeaders	Uma lista separada por vírgulas de cabeçalhos de resposta para expor aos clientes CORS.
MaxAgeInSeconds	O número de segundos que o cliente ou browser deve colocar em cache uma resposta de verificação prévia.
AllowedHeaders	Uma lista separada por vírgulas de cabeçalhos que podem fazer parte do pedido de várias origens.
AllowedMethods	Uma lista separada por vírgulas de métodos HTTP que podem ser executados pela origem. Para o Armazenamento do Azure, os métodos permitidos são DELETE, GET, HEAD, MERGE, POST, OPTIONS ou PUT.

Autorização

Apenas o proprietário da conta de armazenamento pode chamar esta operação.

Pedido e resposta de exemplo

O URI de exemplo seguinte faz um pedido para obter as propriedades do serviço Fila para a conta de armazenamento fictícia com o nome myaccount:

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

O pedido é enviado com os seguintes cabeçalhos:

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

Depois de o pedido ter sido enviado, é devolvida a seguinte resposta:

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

O corpo da resposta é semelhante ao seguinte:

<?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>

Ver também

Análise de Armazenamento
Suporte do CORS para os serviços de Armazenamento do Azure
Especificação HTTP do CORS

Partilhar via