Partilhar via


Definir propriedades do serviço de arquivo

A Set File Service Properties operação define propriedades para o recurso de serviço de arquivo 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 - Definir Propriedades do Serviço, que é fornecido pelo provedor de recursos de Armazenamento do Azure (Microsoft.Storage). Para saber mais sobre como interagir programaticamente com o recurso de serviço de Arquivo usando o provedor de recursos de Armazenamento do Azure, consulte Operações no serviço de Arquivo.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado Disponível
PME Sim
Sistema de Arquivos de Rede (NFS) Sim

Solicitação

Você pode especificar a Set File Service Properties solicitação da seguinte maneira. Recomendamos que você use HTTPS. Substitua o nome da conta pelo nome da sua conta de armazenamento:

Método Solicitar URI Versão HTTP
INSERIR 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

Os cabeçalhos de solicitação obrigatórios e opcionais são descritos na tabela a seguir:

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 or 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 habilitar 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 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

O formato do corpo da solicitação 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-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>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>  
  

Não é necessário especificar todos os elementos raiz na solicitação. Se você omitir um elemento raiz, as configurações existentes para o serviço para essa funcionalidade serão preservadas. No entanto, se você especificar um determinado elemento raiz, deverá especificar cada elemento filho para esse elemento. Os elementos raiz incluem:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

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

Nome Descrição
HourMetrics Opcional para a versão 2015-04-05 e posterior. Não aplicável a versões anteriores. Agrupa as configurações do Storage Analytics HourMetrics , que fornecem um resumo das estatísticas de solicitação agrupadas por API em agregações horárias.
MinuteMetrics Opcional para a versão 2015-04-05 e posterior. Não aplicável a versões anteriores. Agrupa as configurações do Storage Analytics MinuteMetrics , que fornecem estatísticas de solicitação para cada minuto.
Version Obrigatório se as métricas estiverem habilitadas. A versão do Storage Analytics a ser configurada. Use 1.0 para este valor.
Enabled Obrigatório Indica se as métricas estão habilitadas para o serviço de arquivo.
IncludeAPIs Necessário apenas se as métricas estiverem habilitadas. Indica se as métricas devem gerar estatísticas resumidas para operações de API chamadas.
RetentionPolicy/Enabled Obrigatório Indica se uma política de retenção está habilitada para o serviço de arquivo. Se falso, os dados de métricas são retidos e o usuário é responsável por excluí-los.
RetentionPolicy/Days Necessário somente se uma política de retenção estiver habilitada. Indica o número de dias em que os dados de métricas devem ser retidos. Todos os dados mais antigos que esse valor são excluídos. O mínimo que você pode especificar é 1, e o valor máximo é 365 (um ano). Os dados de métricas são excluídos com base no melhor esforço após o período de retenção expirar.
Cors Opcional. O Cors elemento é suportado para a versão 2015-02-21 e posterior. Agrupa todas as regras de compartilhamento de recursos entre origens (CORS). Omitir esse grupo de elementos não substitui as configurações CORS existentes.
CorsRule Opcional. Especifica uma regra CORS para o serviço de arquivo. Você pode incluir até cinco CorsRule elementos na solicitação. Se nenhum CorsRule elemento for incluído no corpo da solicitação, todas as regras do CORS serão excluídas e o CORS será desabilitado para o serviço de arquivo.
AllowedOrigins Obrigatório se o CorsRule elemento estiver presente. Uma lista separada por vírgulas de domínios de origem que são permitidos via CORS, ou "*" para permitir todos os domínios. Um domínio de origem também pode incluir um caractere curinga no subdomínio para permitir solicitações via CORS para todos os subdomínios de um domínio. Limitado a 64 domínios de origem. Cada origem permitida pode ter até 256 caracteres.
ExposedHeaders Obrigatório se o CorsRule elemento estiver presente. Uma lista separada por vírgulas de cabeçalhos de resposta para expor aos clientes CORS. Limitado a 64 cabeçalhos definidos e dois cabeçalhos prefixados. Cada cabeçalho pode conter até 256 caracteres.
MaxAgeInSeconds Obrigatório se o CorsRule elemento estiver presente. O número de segundos que o cliente/navegador deve armazenar em cache uma resposta de comprovação.
AllowedHeaders Obrigatório se o CorsRule elemento existir. Uma lista separada por vírgulas de cabeçalhos que podem fazer parte da solicitação de origem cruzada. Limitado a 64 cabeçalhos definidos e 2 cabeçalhos prefixados. Cada cabeçalho pode conter até 256 caracteres.
AllowedMethods Obrigatório se CorsRule o elemento existir. 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 , , , , POSTMERGE, OPTIONSe PUT. HEADGETDELETE
ShareDeleteRetentionPolicy Opcional. As propriedades de exclusão suave para os compartilhamentos de arquivos do Azure nesta conta de armazenamento.
Days Opcional. Indica o número de dias em que o compartilhamento de arquivos do Azure deve ser mantido (excluído suavemente). O mínimo que você pode especificar é 1, e o valor máximo é 365 (um ano).
Enabled Opcional. Indica se a conta de armazenamento tem a exclusão suave habilitada para Arquivos do Azure.
ProtocolSettings Opcional. Agrupa as configurações para protocolos do sistema de arquivos.
SMB Opcional. Agrupa as configurações para SMB.
Multichannel Opcional. Contém as configurações para SMB multicanal. SMB multichannel contém a Enabled propriedade Boolean, que alterna o estado de SMB multichannel.
Versions Opcional a partir da versão 2020-04-08. Lista separada por ponto-e-vírgula de versões SMB permitidas. Os valores permitidos são SMB2.1, SMB3.0e SMB3.1.1.
AuthenticationMethods Opcional a partir da versão 2020-04-08. Lista separada por ponto-e-vírgula de métodos de autenticação permitidos. Os valores permitidos são NTLMv2 e Kerberos.
KerberosTicketEncryption Opcional a partir da versão 2020-04-08. Lista separada por ponto-e-vírgula de algoritmos de criptografia de tíquete Kerberos permitidos. Os valores permitidos são RC4-HMAC e AES-256.
ChannelEncryption Opcional a partir da versão 2020-04-08. Lista separada por ponto-e-vírgula de algoritmos de criptografia de canal SMB permitidos. Os valores permitidos são AES-128-CCM, AES-128-GCMe AES-256-GCM.

Resposta

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

Código de estado

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

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 Um valor que identifica exclusivamente uma solicitação feita em relação ao serviço.
x-ms-version Especifica a versão da operação que foi 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 do cabeçalho é 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 cabeçalho x-ms-client-request-id não estiver presente na solicitação, ele não estará presente na resposta.

Corpo da resposta

Nenhum.

Autorização

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

Observações

As seguintes restrições e limitações aplicam-se às regras CORS nos Arquivos do Azure:

  • Um máximo de cinco regras podem ser armazenadas.

  • O tamanho máximo de todas as configurações de regras CORS na solicitação, excluindo marcas XML, não deve exceder 2 KiB.

  • O comprimento de um cabeçalho permitido, cabeçalho exposto ou origem permitida não deve exceder 256 caracteres.

  • Os cabeçalhos permitidos e os cabeçalhos expostos podem ser um dos seguintes:

    • Cabeçalhos literais, onde o nome exato do cabeçalho é fornecido, como x-ms-meta-processed. Um máximo de 64 cabeçalhos literais podem ser especificados na solicitação.

    • Cabeçalhos prefixados, onde um prefixo do cabeçalho é fornecido, como x-ms-meta-data*. Especificar um prefixo dessa maneira permite ou expõe qualquer cabeçalho que comece com esse prefixo. Um máximo de dois cabeçalhos prefixados pode ser especificado na solicitação.

  • Os métodos (ou verbos AllowedMethods HTTP) especificados no elemento devem estar em conformidade com os métodos suportados pelas APIs do serviço de armazenamento do Azure. Os métodos suportados são DELETE, GET, HEAD, MERGE, POST, OPTIONSe PUT.

A especificação das regras CORS no pedido é opcional. Se você chamar Set File Service Properties sem especificar o elemento CORS no corpo da solicitação, todas as regras CORS existentes serão mantidas.

Para desativar o CORS, ligue Set File Service Properties com uma configuração de regras CORS vazia (ou seja, </Cors>) e sem regras internas do CORS. Essa chamada exclui todas as regras existentes e desabilita o CORS para o serviço de arquivo.

Todos os elementos da regra CORS são necessários se o CorsRule elemento for especificado. A solicitação falhará com o código de erro 400 (Solicitação incorreta) se algum elemento estiver faltando.

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

Exemplo de solicitação e resposta

O URI de exemplo a seguir faz uma solicitação para alterar as propriedades do serviço de arquivo para uma conta de armazenamento chamada myaccount:

PUT 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  

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

Após o envio do pedido, é devolvida a seguinte resposta:

HTTP/1.1 202 Accepted  
Connection: Keep-Alive  
Transfer-Encoding: chunked  
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  

Ver também

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

Para obter mais informações sobre análise de armazenamento, consulte Análise de armazenamento.