Obter propriedades do serviço 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 regras cors (compartilhamento de recursos entre origens) e Análise de Armazenamento.

Para obter mais informações sobre regras de cors (compartilhamento de recursos entre origens) e lógica de avaliação, consulte Suporte do CORS para os serviços de Armazenamento do Azure.

Solicitação

A solicitação Get Queue Service Properties pode ser especificada da seguinte maneira. Recomendamos que você use HTTPS. Substitua <account-name> pelo nome da sua conta de armazenamento:

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

Observação

O URI sempre deve incluir um caractere de barra (/) para separar o nome do host das partes de caminho e 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 de solicitação:

Parâmetro	Descrição
`restype=service&comp=properties`	Obrigatórios. A combinação das duas cadeias de caracteres de consulta é necessária para obter as propriedades do serviço de armazenamento.
`timeout`	Opcional. O parâmetro `timeout` é expresso em segundos. Para obter mais informações, consulte Definir tempos limite para operações de Armazenamento de Filas do Azure.

Cabeçalhos da solicitação

A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.

Cabeçalho da solicitação	Descrição
`Authorization`	Obrigatórios. Especifica o esquema de autorização, o nome da conta de armazenamento e a assinatura. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatórios. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure.
`x-ms-version`	Necessário para todas as solicitações autorizadas. Especifica a versão da operação a ser usada para esta solicitação. Para obter mais informações, consulte Controle de versão para os Serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres KiB (1 kibibyte) que é registrado nos logs quando o registro em log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações recebidas pelo servidor. Para obter mais informações, consulte Monitorar o Armazenamento de Filas do Azure.

Corpo da solicitação

Nenhum.

Resposta

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

Código de status

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

Cabeçalhos de resposta

A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP 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 uma solicitação feita no serviço.
`x-ms-version`	Especifica a versão da operação usada para a resposta. Para obter mais informações, consulte Controle de versão para os Serviços de Armazenamento do Azure.
`x-ms-client-request-id`	Pode ser usado para solucionar problemas de solicitações e respostas correspondentes. O valor desse cabeçalho será igual ao valor do `x-ms-client-request-id` cabeçalho se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o `x-ms-client-request-id` cabeçalho não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta

Para a versão 2012-02-12 e anterior, o formato 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 seguinte tabela:

Nome do elemento	Descrição
Logging	Agrupa as configurações de log de Análise de Armazenamento.
Métricas	Agrupa as configurações de Métricas Análise de Armazenamento. As configurações de Metrics fornecem um resumo das estatísticas de solicitação agrupadas por API em agregações de hora em hora para filas.
HourMetrics	Agrupa as configurações Análise de Armazenamento HourMetrics. As configurações de HourMetrics fornecem um resumo das estatísticas de solicitação agrupadas por API em agregações de hora em hora para filas.
MinuteMetrics	Agrupa as configurações Análise de Armazenamento MinuteMetrics. As configurações de MinuteMetrics* fornecem estatísticas de solicitação para cada minuto para filas.
Versão	A versão do Análise de Armazenamento que está em uso no momento.
Excluir	Aplica-se somente à configuração de log. Indica se as solicitações de exclusão estão sendo registradas em log.
Leitura	Aplica-se somente à configuração de log. Indica se as solicitações de leitura estão sendo registradas em log.
Gravar	Aplica-se somente à configuração de log. Indica se as solicitações de gravação estão sendo registradas em log.
Enabled	Indica se as métricas estão habilitadas para o Armazenamento de Filas do Azure. Se a replicação georredundante de acesso de leitura estiver habilitada, as métricas primárias e secundárias serão coletadas. Se a replicação georredundante de acesso de leitura não estiver habilitada, apenas as métricas primárias serão coletadas.
IncludeAPIs	É aplicável apenas à configuração de métrica. Indica se a métrica gera estatísticas de resumo para operações chamadas de API.
RetentionPolicy/Enabled	Indica se uma política de retenção está habilitada para o serviço de armazenamento.
RetentionPolicy/Days	Indica o número de dias em que a métrica ou os dados de log são mantidos. Todos os dados mais antigos do que esse valor serão excluídos.
Cors	Agrupa todas as regras de CORS.
CorsRule	Agrupa as configurações para uma regra de CORS.
AllowedOrigins	Uma lista separada por vírgulas de domínios de origem que são permitidos via CORS ou um asterisco (*) se todos os domínios forem permitidos.
ExposedHeaders	Uma lista de cabeçalhos de resposta separados por vírgulas para expor para clientes de CORS.
MaxAgeInSeconds	O número de segundos em que o cliente ou navegador deve armazenar em cache uma resposta de simulação.
AllowedHeaders	Uma lista separada por vírgulas de cabeçalhos que têm permissão para fazer parte da solicitação entre origens.
AllowedMethods	Uma lista de métodos de HTTP separados por vírgulas com permissão para serem executados pela origem. Para o Armazenamento do Azure, os métodos permitidos são DELETE, GET, HEAD, MERGE, POST, OPTIONS ou PUT.

Autorização

Somente o proprietário da conta de armazenamento pode chamar essa operação.

Exemplo de solicitação e resposta

O URI de exemplo a seguir faz uma solicitação para obter as propriedades do serviço Fila para a conta fictícia de armazenamento denominada myaccount:

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

A solicitação é enviada 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 que a solicitação tiver sido enviada, a resposta a seguir será retornada:

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 de resposta é parecido com o 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>

Confira também

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

Compartilhar via