Obter propriedades do serviço de arquivo

A Get File Service Properties operação obtém propriedades para o FileService recurso usando a API FileREST. Embora essa API seja totalmente suportada, ela é uma API de gerenciamento herdada. Recomendamos que, em vez disso, você use Serviços de Arquivo - Obter Propriedades de Serviço, que é fornecido 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

O Get File Service Properties pedido pode ser especificado do seguinte modo: Recomendamos que você use HTTPS. Substitua <account-name> pelo nome da sua conta de armazenamento:

Método	Solicitar URI	Versão HTTP
Obtém	`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 de URI

Parâmetro URI	Descrição
`restype=service&comp=properties`	Obrigatório A combinação de ambas as 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 requisiçã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ório Especifica o esquema de autorização, o nome da conta de armazenamento e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
`Date` ou `x-ms-date`	Obrigatório Especifica o Tempo Universal Coordenado (UTC) para a solicitação. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
`x-ms-version`	Obrigatório para todos os pedidos autorizados. Especifica a versão da operação a ser usada para essa solicitação. Esta operação está disponível apenas na versão 2015-02-21 e posterior. Para recuperar propriedades de métricas para o serviço de 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 de 1 kibibyte (KiB) que é registrado nos logs do Azure Storage Analytics quando o log é configurado. É altamente recomendável que você use esse cabeçalho para correlacionar atividades do lado do cliente com solicitações que o servidor recebe. Para obter mais informações, consulte Monitorar arquivos do Azure.

Corpo de 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 estado

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 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 da resposta	Descrição
`x-ms-request-id`	Identifica exclusivamente uma solicitação feita contra o 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 é igual ao valor do cabeçalho `x-ms-client-request-id` se ele estiver presente na solicitação e o valor não contiver mais de 1.024 caracteres ASCII visíveis. Se o cabeçalho `x-ms-client-request-id` 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 2026-02-06 é 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-separated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-separated-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>semicolon-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>semicolon-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>semicolon-separated-list-of-kerberos-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>semicolon-separated-list-of-smb-channel-encryption-algorithms</ChannelEncryption>
            <EncryptionInTransit>
                <Required>true|false</Required>
            </EncryptionInTransit>
        </SMB>
        <NFS>
            <EncryptionInTransit>
                <Required>true|false</Required>
            </EncryptionInTransit>
        </NFS>
    </ProtocolSettings>
</StorageServiceProperties>

Os elementos do corpo da resposta são descritos na tabela a seguir:

Nome	Descrição
`HourMetrics`	Agrupa as configurações do Storage Analytics `HourMetrics` . As `HourMetrics` configurações fornecem um resumo das estatísticas de solicitação, agrupadas por API em agregações horárias.
`MinuteMetrics`	Agrupa as configurações do Storage Analytics `MinuteMetrics` . As `MinuteMetrics` configurações fornecem estatísticas de solicitação para cada minuto.
`Version`	A versão do Storage Analytics que está atualmente em uso.
`Enabled`	Indica se as métricas estão habilitadas para o serviço de arquivo.
`IncludeAPIs`	Indica se as métricas geram estatísticas de resumo para operações de API chamadas.
`RetentionPolicy/Enabled`	Indica se uma política de retenção está habilitada para o serviço de 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 do que esse valor são excluídos com base no melhor esforço.
`Cors`	Agrupa todas as regras de compartilhamento de recursos entre origens (CORS).
`CorsRule`	Configurações de grupos para uma regra CORS.
`AllowedOrigins`	Uma lista separada por vírgulas de domínios de origem que são permitidos via 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 navegador deve armazenar em cache uma resposta de comprovação.
`AllowedHeaders`	Uma lista separada por vírgulas de cabeçalhos que podem fazer parte da solicitação de origem cruzada.
`AllowedMethods`	Uma lista separada por vírgulas de métodos HTTP que podem ser 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 suave 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 mantido (excluído suavemente). 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 suave habilitada para Arquivos do Azure.
`ProtocolSettings`	Agrupa as configurações para protocolos do sistema de arquivos.
`SMB`	Agrupa as configurações para o Server Message Block (SMB).
`Multichannel`	Contém as configurações para SMB Multichannel. Essa configuração tem uma propriedade: enabled/disabled.
`Versions`	Disponível a partir da versão 2020-04-08. Uma lista separada por ponto-e-vírgula 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 desativada, porque o SMB 2.1 não suporta criptografia.
`AuthenticationMethods`	Disponível a partir da versão 2020-04-08. Uma lista separada por ponto-e-vírgula 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 ponto-e-vírgula 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 sejam suportados.
`ChannelEncryption`	Disponível a partir da versão 2020-04-08. Uma lista separada por ponto-e-vírgula de algoritmos 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 sejam suportados. Se a propriedade da conta de `require secure transit` armazenamento estiver desativada, o acesso SMB não criptografado também será permitido.
`NFS`	Disponível a partir da versão 2026-02-06. Agrupa as definições do NFS.
`EncryptionInTransit`	Disponível a partir da versão 2026-02-06. A encriptação SMB & NFS em trânsito contém a `Required` propriedade booleana, que indica a necessidade de encriptação SMB & NFS em trânsito. A encriptação NFS em trânsito está disponível apenas para contas de armazenamento premium.

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
Obtém	`https://myaccount.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

O pedido é enviado com os seguintes cabeçalhos:

x-ms-version: 2026-02-06  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net

Após o envio do pedido, é 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: 2026-02-06

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>
            <EncryptionInTransit>
                <Required>true</Required>
            </EncryptionInTransit>
        </SMB>
        <NFS>
            <EncryptionInTransit>
                <Required>true</Required>
            </EncryptionInTransit>
        </NFS>
    </ProtocolSettings>
</StorageServiceProperties>

Observações

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

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

Last updated on 2025-05-08

Partilhar via