Obter propriedades de serviço do arquivo

Artigo
07/19/2023

A Get File Service Properties operação obtém propriedades para o FileService recurso usando a API FileREST. Embora essa API tenha suporte total, é uma API de gerenciamento herdada. Recomendamos que você use os Serviços de Arquivos – Obter Propriedades de Serviço, que são fornecidos pelo provedor de recursos de armazenamento (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com o FileService recurso usando o provedor de recursos de armazenamento, consulte Operações no recurso FileService.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado	Disponível
SMB
NFS

Solicitação

A solicitação Get File 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>.file.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

Parâmetro do URI	Descrição
`restype=service&comp=properties`	Obrigatórios. A combinação das duas cadeias de caracteres de consulta é necessária para definir 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 serviço de arquivo.

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. Essa operação está disponível apenas na versão 2015-02-21 e posterior. Para recuperar propriedades de métricas para o serviço Arquivo, você deve especificar a versão 2015-04-05 ou posterior. 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) registrado nos logs de Análise de Armazenamento do Azure 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 Arquivos 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 suas 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

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 seguinte tabela:

Nome	Descrição
`HourMetrics`	Agrupa as configurações de Análise de Armazenamento`HourMetrics`. As `HourMetrics` configurações fornecem um resumo das estatísticas de solicitação, agrupadas pela API em agregações por hora.
`MinuteMetrics`	Agrupa as configurações de Análise de Armazenamento`MinuteMetrics`. As `MinuteMetrics` configurações fornecem estatísticas de solicitação para cada minuto.
`Version`	A versão do Análise de Armazenamento que está em uso no momento.
`Enabled`	Indica se as métricas estão habilitadas para o serviço Arquivo.
`IncludeAPIs`	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 Arquivo.
`RetentionPolicy/Days`	Indica o número de dias para os quais os dados de métricas são retidos. Todos os dados mais antigos que esse valor são excluídos com base no melhor esforço.
`Cors`	Agrupa todas as regras de CORS (compartilhamento de recursos entre origens).
`CorsRule`	Agrupa as configurações para uma regra de CORS.
`AllowedOrigins`	Uma lista de domínios de origem separados por vírgulas que são permitidos nos CORS ou “*” 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 que o cliente ou navegador deve armazenar em cache uma resposta de pré-voo.
`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 Arquivos do Azure, os métodos permitidos são DELETE, GET, HEAD, MERGE, POST, OPTIONS e PUT.
`ShareDeleteRetentionPolicy`	As propriedades de exclusão reversível para os compartilhamentos de arquivos do Azure nesta conta de armazenamento.
`Days`	Indica o número de dias em que o compartilhamento de arquivos do Azure deve ser retido (excluído temporariamente). O valor mínimo especificado pode ser 1 e o valor máximo é 365.
`Enabled`	Indica se a conta de armazenamento tem a exclusão temporária habilitada para Arquivos do Azure.
`ProtocolSettings`	Agrupa as configurações para protocolos do sistema de arquivos.
`SMB`	Agrupa as configurações do SMB (Bloco de Mensagens do Servidor).
`Multichannel`	Contém as configurações do SMB Multichannel. Essa configuração tem uma propriedade: habilitada/desabilitada.
`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.0` e `SMB3.1.1`. Se `Version` não for especificado, o padrão é que todas as versões estejam habilitadas. No entanto, o SMB 2.1 só estará disponível se a propriedade da conta de `require secure transit` armazenamento estiver desabilitada, pois o SMB 2.1 não dá suporte à criptografia.
`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, o padrão é que todos os métodos de autenticação sejam permitidos.
`KerberosTicketEncryption`	Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de algoritmos de criptografia de tíquete Kerberos permitidos. Valores possíveis: `RC4-HMAC` e `AES-256`. Se `KerberosTicketEncryption` não for especificado, o padrão é que todos os algoritmos de criptografia de tíquete Kerberos têm suporte.
`ChannelEncryption`	Disponível a partir da versão 2020-04-08. Uma lista separada por vírgulas de protocolos de criptografia de canal SMB permitidos. Valores possíveis: `AES-128-CCM`, `AES-128-GCM` e `AES-256-GCM`. Se `ChannelEncryption` não for especificado, o padrão é que todos os valores de criptografia de canal têm suporte. Se a propriedade da conta de `require secure transit` armazenamento estiver desabilitada, o acesso SMB não criptografado também será permitido.

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 de arquivo para uma conta de armazenamento chamada myaccount:

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

A solicitação é enviada 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 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: <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>

Comentários

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

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