Definir Propriedades do Serviço de Ficheiros

  • Artigo

A Set File Service Properties operação define as propriedades do recurso do Serviço de ficheiros 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 – Definir Propriedades do Serviço, que é fornecido pelo fornecedor de recursos de Armazenamento do Azure (Microsoft.Storage). Para saber mais sobre a interação programática com o recurso do Serviço de ficheiros com o fornecedor de recursos do Armazenamento do Azure, veja Operações no serviço Ficheiro.

Disponibilidade do protocolo

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

Pedir

Pode especificar o pedido da Set File Service Properties seguinte forma. Recomendamos que utilize HTTPS. Substitua account-name pelo nome da sua conta de armazenamento:

Método URI do pedido Versão HTTP
PUT 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 de caminho e consulta do URI. Nesta operação, a parte do caminho do URI está vazia.

Parâmetros 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

Os cabeçalhos de pedido obrigatórios e opcionais estão descritos na seguinte tabela:

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 or 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 ativar as 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 Análise de Armazenamento 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

O formato do corpo do pedido 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>

Não é necessário especificar todos os elementos raiz no pedido. Se omitir um elemento raiz, as definições existentes do serviço para essa funcionalidade serão preservadas. No entanto, se especificar um determinado elemento raiz, tem de especificar todos os elementos subordinados para esse elemento. Os elementos de raiz incluem:

  • HourMetrics
  • MinuteMetrics
  • Cors
  • ProtocolSettings

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

Nome Descrição
HourMetrics Opcional para a versão 2015-04-05 e posterior. Não aplicável a versões anteriores. Agrupa as definições de Análise de ArmazenamentoHourMetrics, que fornecem um resumo das estatísticas de pedido agrupadas pela API em agregados por hora.
MinuteMetrics Opcional para a versão 2015-04-05 e posterior. Não aplicável a versões anteriores. Agrupa as definições de Análise de ArmazenamentoMinuteMetrics, que fornecem estatísticas de pedidos para cada minuto.
Version Necessário se as métricas estiverem ativadas. A versão do Análise de Armazenamento a configurar. Utilize 1.0 para este valor.
Enabled Obrigatório. Indica se as métricas estão ativadas para o serviço Ficheiro.
IncludeAPIs Necessário apenas se as métricas estiverem ativadas. Indica se as métricas devem gerar estatísticas de resumo para as operações de API denominadas.
RetentionPolicy/Enabled Obrigatório. Indica se uma política de retenção está ativada para o serviço Ficheiro. Se forem falsos, os dados das métricas são retidos e o utilizador é responsável por eliminá-lo.
RetentionPolicy/Days Necessário apenas se uma política de retenção estiver ativada. Indica o número de dias em que os dados das métricas devem ser retidos. Todos os dados mais antigos que este valor são eliminados. O mínimo que pode especificar é 1, e o valor máximo é 365 (um ano). Os dados de métricas são eliminados com base no melhor esforço após a expiração do período de retenção.
Cors Opcional. O Cors elemento é suportado para a versão 2015-02-21 e posterior. Agrupa todas as regras de partilha de recursos entre origens (CORS). Omitindo este grupo de elementos não substitui as definições CORS existentes.
CorsRule Opcional. Especifica uma regra CORS para o serviço Ficheiro. Pode incluir até cinco elementos CorsRule no pedido. Se não CorsRule forem incluídos elementos no corpo do pedido, todas as regras CORS são eliminadas e o CORS será desativado para o serviço Ficheiro.
AllowedOrigins Necessário se o CorsRule elemento estiver presente. Uma lista separada por vírgulas de domínios de origem que são permitidos através de CORS ou "*" para permitir todos os domínios. Um domínio de origem também pode incluir um caráter universal no subdomínio para permitir pedidos através de CORS para todos os subdomínios de um domínio. Limitado a 64 domínios de origem. Cada origem permitida pode ter até 256 carateres.
ExposedHeaders Necessá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 com prefixo. Cada cabeçalho pode conter até 256 carateres.
MaxAgeInSeconds Necessário se o CorsRule elemento estiver presente. O número de segundos que o cliente/browser deve colocar em cache uma resposta de pré-voo.
AllowedHeaders Necessário se o CorsRule elemento existir. Uma lista separada por vírgulas de cabeçalhos que podem fazer parte do pedido entre origens. Limitado a 64 cabeçalhos definidos e 2 cabeçalhos prefixados. Cada cabeçalho pode conter até 256 carateres.
AllowedMethods Necessário se CorsRule o elemento existir. 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, , , MERGEHEAD, POST, e OPTIONSPUT. GET
ShareDeleteRetentionPolicy Opcional. As propriedades de eliminação recuperável das partilhas de ficheiros do Azure nesta conta de armazenamento.
Days Opcional. Indica o número de dias em que a partilha de ficheiros do Azure deve ser mantida (eliminada de forma recuperável). O mínimo que pode especificar é 1, e o valor máximo é 365 (um ano).
Enabled Opcional. Indica se a conta de armazenamento tem a eliminação recuperável ativada para Ficheiros do Azure.
ProtocolSettings Opcional. Agrupa as definições dos protocolos do sistema de ficheiros.
SMB Opcional. Agrupa as definições do SMB.
Multichannel Opcional. Contém as definições para smb multicanal. O SMB multicanal contém a Enabled propriedade Booleana, que alterna o estado do multicanal SMB.
Version Opcional a partir da versão 2020-04-08. Lista separada por vírgulas 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 vírgulas 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 vírgulas de algoritmos de encriptação de pedidos 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 vírgulas de protocolos de encriptação de canais SMB permitidos. Os valores permitidos são AES-128-CCM, AES-128-GCMe AES-256-GCM.

Resposta

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

Código de estado

Uma operação bem-sucedida devolve o código de estado 202 (Aceite).

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 Um valor que identifica exclusivamente um pedido feito em relação ao serviço.
x-ms-version Especifica a versão da operação que foi 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 do 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 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 no Ficheiros do Azure:

  • Pode armazenar um máximo de cinco regras.

  • O tamanho máximo de todas as definições de regras CORS no pedido, excluindo etiquetas XML, não deve exceder 2 KiB.

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

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

    • Cabeçalhos literais, onde é fornecido o nome exato do cabeçalho, como x-ms-meta-processed. Pode especificar um máximo de 64 cabeçalhos literais no pedido.

    • Cabeçalhos com prefixo, em que é fornecido um prefixo do cabeçalho, como x-ms-meta-data*. Especificar um prefixo desta forma permite ou expõe qualquer cabeçalho que comece com esse prefixo. Pode especificar um máximo de dois cabeçalhos prefixos no pedido.

  • Os métodos (ou verbos HTTP) especificados no elemento têm de estar em AllowedMethods 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.

Especificar regras CORS no pedido é opcional. Se ligar Set File Service Properties sem especificar o elemento CORS no corpo do pedido, serão mantidas quaisquer regras CORS existentes.

Para desativar o CORS, chame Set File Service Properties com uma definição de regras CORS vazia (ou seja, </Cors>) e sem regras CORS internas. Esta chamada elimina quaisquer regras existentes e desativa o CORS para o serviço Ficheiro.

Todos os elementos da regra CORS são necessários se o CorsRule elemento for especificado. O pedido falha com o código de erro 400 (Pedido Incorreto) se algum elemento estiver em falta.

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

Pedido de exemplo e resposta

O seguinte URI de exemplo faz um pedido para alterar as propriedades do serviço Ficheiro de uma conta de armazenamento com o nome 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

O pedido é enviado 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 pedido ser enviado, é 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 as regras CORS e a lógica de avaliação, veja Suporte de partilha 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.