Definir Metadados de Ficheiro

A Set File Metadata operação define metadados definidos pelo utilizador para o ficheiro especificado.

Disponibilidade do protocolo

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

Pedir

Pode construir o pedido da Set File Metadata seguinte forma. Recomendamos que utilize HTTPS.

Método URI do pedido Versão HTTP
PUT https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata HTTP/1.1

Substitua os componentes de caminho que são apresentados no URI do pedido pelo seu, da seguinte forma:

Componente caminho Description
myaccount O nome da sua conta de armazenamento.
myshare O nome da partilha de ficheiros.
mydirectorypath Opcional. O caminho para o diretório principal.
myfile O nome do ficheiro.

Para obter informações sobre restrições de nomenclatura de caminhos, veja Partilhas de nomes e referências, diretórios, ficheiros e metadados.

Parâmetros URI

Pode especificar os seguintes parâmetros adicionais no URI do pedido:

Parâmetro Description
timeout Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, veja Definir tempos limite para operações do Serviço de ficheiros.

Cabeçalhos do pedido

Cabeçalho do pedido Description
Authorization Obrigatório. Especifica o esquema de autorização, o nome da conta 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. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure.
x-ms-meta-name:value Opcional. Define um par name-value para o ficheiro.

Cada chamada para esta operação substitui todos os metadados existentes anexados ao ficheiro. Para remover todos os metadados do ficheiro, chame esta operação sem cabeçalhos de metadados.

Os nomes de metadados têm de cumprir as regras de nomenclatura dos identificadores C#.
x-ms-lease-id:<ID> Necessário se o ficheiro tiver uma concessão ativa. Disponível para a versão 2019-02-02 e posterior.
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 quando o registo é 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.
x-ms-file-request-intent Necessário se o Authorization cabeçalho especificar um token OAuth. O valor aceitável é backup. Este cabeçalho especifica que o Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action deve ser concedido se estiverem incluídos na política RBAC atribuída à identidade autorizada com o Authorization cabeçalho. Disponível para a versão 2022-11-02 e posterior.
x-ms-allow-trailing-dot: { <Boolean> } Opcional. Versão 2022-11-02 e posterior. O valor booleano especifica se um ponto à direita presente no URL do pedido deve ser cortado ou não. Para obter mais informações, veja Nomenclatura e referência de partilhas, diretórios, ficheiros e metadados.

Corpo do pedido

Nenhum.

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 200 (OK).

Para obter informações sobre códigos de estado, veja Códigos de estado e de erro.

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
ETag Contém um valor que representa a versão do ficheiro. O valor está entre aspas.
x-ms-request-id Identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido. Para obter mais informações, veja Resolver problemas de operações da API.
x-ms-version Indica a versão do serviço Ficheiro que foi utilizada para executar o pedido.
Date ou x-ms-date Um valor de data/hora UTC gerado pelo serviço, que indica a hora em que a resposta foi iniciada.
x-ms-request-server-encrypted: true/false Versão 2017-04-17 e posterior. O valor deste cabeçalho está definido como true se os conteúdos do pedido forem encriptados com êxito com o algoritmo especificado. Caso contrário, o valor está definido como false.
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 estará presente na resposta.

Corpo da resposta

Nenhum.

Autorização

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

Observações

Set File Metadata não é suportado num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Uma tentativa de executar esta operação num instantâneo de partilha falha com 400 (InvalidQueryParameterValue)

Se o ficheiro tiver uma concessão ativa, o cliente tem de especificar um ID de concessão válido no pedido para escrever metadados no ficheiro. Se o cliente não especificar um ID de concessão ou especificar um ID de concessão inválido, o Serviço de ficheiros devolve o código de estado 412 (Falha na Pré-condição). Se o cliente especificar um ID de concessão, mas o ficheiro não tiver uma concessão ativa, o Serviço de ficheiros também devolve o código de estado 412 (Falha na Pré-condição).

Ver também

Operações no Ficheiros do Azure