Definir propriedades de arquivo

  • Artigo

A operação Set File Properties define as propriedades do sistema no arquivo.

Disponibilidade do protocolo

Protocolo de compartilhamento de arquivos habilitado Disponível
SMB Sim
NFS Sem

Pedir

A solicitação Set File Properties pode ser construída da seguinte maneira. Recomendamos que você use HTTPS.

Método URI de solicitação Versão HTTP
PÔR https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties HTTP/1.1

Substitua os componentes de caminho mostrados no URI da solicitação por seus próprios, da seguinte maneira:

Componente path Descrição
myaccount O nome da sua conta de armazenamento.
myshare O nome do compartilhamento de arquivos.
mydirectorypath Opcional. O caminho para o diretório pai.
myfile O nome do arquivo.

Para obter informações sobre restrições de nomenclatura de caminho, consulte compartilhamentos de nome e referência, diretórios, arquivos e metadados.

Parâmetros de URI

Você pode especificar os seguintes parâmetros adicionais no URI da solicitação:

Parâmetro Descrição
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 de solicitação

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

Cabeçalho de solicitação Descrição
Authorization Necessário. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, consulte Autorizar solicitações para o Armazenamento do Azure.
Date ou x-ms-date Necessário. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para obter mais informações, consulte 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 essa solicitação. Para obter mais informações, consulte Controle de versão para os serviços de Armazenamento do Azure.
x-ms-cache-control Opcional. Modifica a cadeia de caracteres de controle de cache para o arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-type Opcional. Define o tipo de conteúdo do arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-md5 Opcional. Define o hash MD5 do arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-encoding Opcional. Define a codificação de conteúdo do arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-language Opcional. Define o idioma de conteúdo do arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-disposition Opcional. Define o cabeçalho Content-Disposition do arquivo.

Se essa propriedade não for especificada na solicitação, a propriedade será desmarcada para o arquivo. As chamadas subsequentes para Obter Propriedades do Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente.
x-ms-content-length: bytes Opcional. Redimensiona um arquivo para o tamanho especificado. Se o valor de byte especificado for menor que o tamanho atual do arquivo, todos os intervalos acima do valor de byte especificado serão limpos.
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } Nas versões 2019-02-02 a 2021-04-10, esse cabeçalho será necessário se x-ms-file-permission-key não for especificado. A partir da versão 2021-06-08, ambos os cabeçalhos são opcionais. Essa permissão é o descritor de segurança do arquivo especificado no ou (versão 2024-11-04 ou posterior) no formato de descritor de segurança binária codificado em base64. Você pode especificar qual formato usar com o cabeçalho x-ms-file-permission-format. Você poderá usar esse cabeçalho se o tamanho das permissões for de 8 kibibytes (KiB) ou menos. Caso contrário, você pode usar x-ms-file-permission-key. Se especificado, ele deve ter um proprietário, um grupo e da DACL (lista de controle de acesso discricionário). Um valor de preserve pode ser passado para manter um valor existente inalterado.

Observação: você pode especificar x-ms-file-permission ou x-ms-file-permission-key. Se nenhum dos cabeçalhos for especificado, o valor padrão de preserve será usado.
x-ms-file-permission-format: { sddl ¦ binary } Opcional. Versão 2024-11-04 ou posterior. Especifica se o valor passado em x-ms-file-permission está no SDDL ou no formato binário. Se x-ms-file-permission-key estiver definido como preserve, esse cabeçalho não deverá ser definido. Se x-ms-file-permission-key for definido como qualquer outro valor que não preserve, e se esse cabeçalho não estiver definido, o valor padrão de sddl será usado.
x-ms-file-permission-key: <PermissionKey> Nas versões 2019-02-02 a 2021-04-10, esse cabeçalho será necessário se x-ms-file-permission não for especificado. A partir da versão 2021-06-08, ambos os cabeçalhos são opcionais. A chave da permissão a ser definida para o arquivo. Isso pode ser criado usando a API de Create-Permission.

Observação: você pode especificar x-ms-file-permission ou x-ms-file-permission-key. Se nenhum cabeçalho for especificado, o valor padrão de preserve será usado para o cabeçalho x-ms-file-permission.
x-ms-file-attributes: { preserve ¦ <FileAttributeList> } Obrigatório, versão 2019-02-02 a 2021-04-10. Opcional, versão 2021-06-08 e posterior. Os atributos do sistema de arquivos a serem definidos no arquivo. Consulte a lista de atributos disponíveis. Um valor de preserve pode ser passado para manter um valor existente inalterado. O valor padrão é preserve.
x-ms-file-creation-time: { preserve ¦ <DateTime> } Obrigatório, versão 2019-02-02 a 2021-04-10. Opcional, versão 2021-06-08 e posterior. A propriedade de tempo de criação UTC (Tempo Universal Coordenado) para um arquivo. Um valor de preserve pode ser passado para manter um valor existente inalterado. O valor padrão é preserve.
x-ms-file-last-write-time: { preserve ¦ <DateTime> } Obrigatório, versão 2019-02-02 a 2021-04-10. Opcional, versão 2021-06-08 e posterior. A última propriedade de gravação UTC (Tempo Universal Coordenado) para um arquivo. Um valor de preserve pode ser passado para manter um valor existente inalterado. Se preserve for especificado e o tamanho do arquivo for alterado, a hora da última gravação será atualizada para a hora atual. Se o tamanho do arquivo for alterado, mas um carimbo de data/hora explícito for fornecido, o carimbo de data/hora explícito será usado. O valor padrão é preserve.
x-ms-lease-id: <ID> Necessário se o arquivo 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 caracteres kib (1 kibibyte) que é registrado nos logs 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.
x-ms-file-change-time: { now ¦ <DateTime> } Opcional. Versão 2021-06-08 e posterior. A propriedade utc (tempo universal coordenado) altera a propriedade de tempo para o arquivo, formatada no formato ISO 8601. Você pode usar um valor de now para indicar a hora da solicitação. O valor padrão é now.
x-ms-file-request-intent Necessário se Authorization cabeçalho especificar um token OAuth. O valor aceitável é backup. Esse cabeçalho especifica que os Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action devem ser concedidos se forem incluídos na política RBAC atribuída à identidade autorizada usando o cabeçalho Authorization. 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 booliano especifica se um ponto à direita presente na URL da solicitação deve ser cortado ou não. Para obter mais informações, consulte Nomenclatura e referência a compartilhamentos, diretórios, arquivos e metadados.

Corpo da solicitação

Nenhum.

Resposta

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

Código de status

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

Para obter informações sobre códigos de status, consulte Status e códigos de erro.

Cabeçalhos de resposta

A resposta dessa operação inclui os cabeçalhos a seguir. 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 de protocolo HTTP/1.1 .

Cabeçalho de resposta Descrição
ETag Contém um valor que representa a versão do arquivo. O valor está entre aspas.
Last-Modified Retorna a data e a hora em que o arquivo foi modificado pela última vez. O formato de data segue o RFC 1123. Para obter mais informações, consulte Representar valores de data/hora em cabeçalhos. Qualquer operação que modifique o diretório ou suas propriedades atualiza a hora da última modificação. As operações em arquivos não afetam a hora da última modificação do diretório.
x-ms-request-id Identifica exclusivamente a solicitação que foi feita e pode ser usada para solucionar problemas da solicitação. Para obter mais informações, consulte Solucionar problemas de operações de API.
x-ms-version Indica a versão do serviço Arquivo usada para executar a solicitação.
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 desse cabeçalho será definido como true se o conteúdo da solicitação for criptografado com êxito usando o algoritmo especificado. Caso contrário, o valor será definido como false.
x-ms-file-permission-key Versão 2019-02-02 e posterior. A chave da permissão do arquivo.
x-ms-file-attributes Versão 2019-02-02 e posterior. Os atributos do sistema de arquivos no arquivo. Para obter mais informações, consulte a lista de atributos disponíveis.
x-ms-file-creation-time Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a propriedade de hora de criação do arquivo.
x-ms-file-last-write-time Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a última propriedade de tempo de gravação para o arquivo.
x-ms-file-change-time Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a propriedade de tempo de alteração para o arquivo.
x-ms-client-request-id Pode ser usado para solucionar problemas de solicitações e 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

Nenhum.

Autorização

Somente o proprietário da conta pode chamar essa operação.

Atributos do sistema de arquivos

Atributo Atributo de arquivo Win32 Definição
ReadOnly FILE_ATTRIBUTE_READONLY Um arquivo que é somente leitura. Os aplicativos podem ler o arquivo, mas não podem gravá-lo ou excluí-lo.
Escondido FILE_ATTRIBUTE_HIDDEN O arquivo está oculto. Ele não está incluído em uma listagem de diretório comum.
Sistema FILE_ATTRIBUTE_SYSTEM Um arquivo do qual o sistema operacional usa uma parte ou usa exclusivamente.
Nenhum FILE_ATTRIBUTE_NORMAL Um arquivo que não tem outros atributos definidos. Esse atributo só é válido quando é usado sozinho.
Arquivo FILE_ATTRIBUTE_ARCHIVE Um arquivo que é um arquivo morto. Normalmente, os aplicativos usam esse atributo para marcar arquivos para backup ou remoção.
Temporário FILE_ATTRIBUTE_TEMPORARY Um arquivo que está sendo usado para armazenamento temporário.
Offline FILE_ATTRIBUTE_OFFLINE Os dados de um arquivo não estão disponíveis imediatamente. Esse atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows. Os Arquivos do Azure não dão suporte a opções de armazenamento offline.
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED O arquivo não deve ser indexado pelo serviço de indexação de conteúdo.
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA O fluxo de dados do usuário não deve ser lido pelo verificador de integridade de dados em segundo plano. Esse atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows.

Observações

A semântica para atualizar as propriedades de um arquivo é a seguinte:

  • O tamanho de um arquivo será modificado somente se a solicitação especificar um valor para o cabeçalho x-ms-content-length.

  • Se uma solicitação definir apenas x-ms-content-length e nenhuma outra propriedade, nenhuma outra propriedade do arquivo será modificada.

  • Se uma ou mais das propriedades a seguir estiverem definidas na solicitação, todas essas propriedades serão definidas juntas. Se um valor não for fornecido para uma propriedade especificada quando pelo menos uma das propriedades a seguir estiver definida, essa propriedade será desmarcada para o arquivo.

    • x-ms-cache-control
    • x-ms-content-type
    • x-ms-content-md5
    • x-ms-content-encoding
    • x-ms-content-language

Nota

As propriedades de arquivo anteriores são separadas das propriedades do sistema de arquivos que estão disponíveis para clientes SMB. Os clientes SMB não podem ler, gravar ou modificar esses valores de propriedade.

Set File properties não tem suporte em um instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Uma tentativa de executar essa operação em um instantâneo de compartilhamento falha com 400 (InvalidQueryParameterValue).

Se o arquivo tiver uma concessão ativa, o cliente deverá especificar uma ID de concessão válida na solicitação para gravar propriedades no arquivo. Se o cliente não especificar uma ID de concessão ou especificar uma ID de concessão inválida, o serviço arquivo retornará o código de status 412 (Falha na pré-condição). Se o cliente especificar uma ID de concessão, mas o arquivo não tiver uma concessão ativa, o serviço arquivo também retornará o código de status 412 (Falha na pré-condição).

Consulte também

operações de em arquivos do Azure