Obter Propriedades do Serviço de Ficheiros

  • Artigo

A Get File Service Properties operação obtém propriedades para o FileService recurso com a API FileREST. Embora esta API seja totalmente suportada, é uma API de gestão legada. Recomendamos que, em vez disso, utilize Serviços de Ficheiros – Obter Propriedades do Serviço, que é fornecido pelo fornecedor de recursos de armazenamento (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com o FileService recurso com o fornecedor de recursos de armazenamento, veja Operações no recurso FileService.

Disponibilidade do protocolo

Protocolo de partilha de ficheiros ativado Disponível
SMB Yes
NFS Yes

Pedir

O Get File 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>.file.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

Parâmetro URI Description
restype=service&comp=properties Obrigatório. A combinação de ambas as cadeias de consulta é necessária para definir as propriedades do serviço de armazenamento.
timeout Opcional. O timeout parâmetro é expresso em segundos. Para obter mais informações, veja Definir tempos limite para operações do Serviço de ficheiros.

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. Esta operação só está disponível na versão 2015-02-21 e posterior. Para obter as propriedades das métricas do serviço Ficheiro, tem de especificar a versão 2015-04-05 ou posterior.

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 de Análise de Armazenamento do Azure quando o registo está 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 Ficheiros 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 relativamente ao 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 está presente na resposta.

Corpo da resposta

O formato do corpo da resposta para a versão 2020-02-10 é o seguinte:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <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-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

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

Nome Descrição
HourMetrics Agrupa as definições de Análise de ArmazenamentoHourMetrics. As HourMetrics definições fornecem um resumo das estatísticas dos pedidos, agrupadas por API em agregações por hora.
MinuteMetrics Agrupa as definições de Análise de ArmazenamentoMinuteMetrics. As MinuteMetrics definições fornecem estatísticas de pedidos para cada minuto.
Version A versão do Análise de Armazenamento atualmente em utilização.
Enabled Indica se as métricas estão ativadas para o serviço Ficheiro.
IncludeAPIs 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 Ficheiro.
RetentionPolicy/Days Indica o número de dias durante os quais os dados de métricas são retidos. Todos os dados mais antigos que este valor são eliminados numa base de melhor esforço.
Cors Agrupa todas as regras de partilha de recursos de várias origens (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 "*" 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 Ficheiros do Azure, os métodos permitidos são DELETE, GET, HEAD, MERGE, POST, OPTIONS e PUT.
ShareDeleteRetentionPolicy As propriedades de eliminação recuperável das partilhas de ficheiros do Azure nesta conta de armazenamento.
Days Indica o número de dias em que a partilha de ficheiros do Azure deve ser mantida (eliminação recuperável). O valor mínimo especificado pode ser 1 e o valor máximo é 365.
Enabled Indica se a conta de armazenamento tem a eliminação recuperável ativada para Ficheiros do Azure.
ProtocolSettings Agrupa as definições dos protocolos do sistema de ficheiros.
SMB Agrupa as definições do Bloco de Mensagens do Servidor (SMB).
Multichannel Contém as definições do SMB Multicanal. Esta definição tem uma propriedade: ativada/desativada.
Version Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de versões SMB permitidas. Valores possíveis: SMB2.1, SMB3.0e SMB3.1.1. Se Version não for especificado, a predefinição é que todas as versões estão ativadas. No entanto, o SMB 2.1 só está disponível se a propriedade da conta de armazenamento estiver desativada require secure transit , porque o SMB 2.1 não suporta encriptação.
AuthenticationMethods Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de métodos de autenticação permitidos. Valores possíveis: NTLMv2, Kerberos. Se AuthenticationMethods não for especificado, a predefinição é que todos os métodos de autenticação são permitidos.
KerberosTicketEncryption Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de algoritmos de encriptação de pedidos Kerberos permitidos. Valores possíveis: RC4-HMAC e AES-256. Se KerberosTicketEncryption não for especificado, a predefinição é que todos os algoritmos de encriptação de pedidos Kerberos são suportados.
ChannelEncryption Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de protocolos de encriptação de canais SMB permitidos. Valores possíveis: AES-128-CCM, AES-128-GCMe AES-256-GCM. Se ChannelEncryption não for especificado, a predefinição é que todos os valores de encriptação de canal são suportados. Se a propriedade da conta de armazenamento estiver desativada require secure transit , o acesso SMB não encriptado também é permitido.

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 Ficheiro para uma conta de armazenamento com o nome myaccount:

Método URL Protocolo
GET https://myaccount.file.core.windows.net/?restype=service&comp=properties HTTP/1.1

O pedido é enviado com os seguintes cabeçalhos:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.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: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

A resposta inclui o seguinte corpo XML:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <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>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Observações

Para obter informações detalhadas sobre as regras CORS e a lógica de avaliação, veja Suporte cors para os serviços de Armazenamento do Azure.

Para obter mais informações, veja Análise de Armazenamento.