Definir propriedades de arquivo
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 |  |
| NFS |  |
Solicitação
A solicitação Set File Properties pode ser criada da seguinte maneira. Recomendamos que você use HTTPS.
| Método | URI da solicitação | Versão HTTP |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=properties |
HTTP/1.1 |
Substitua os componentes do caminho mostrados no URI da solicitação pelos seus próprios, como segue:
| Componente path | Descrição |
|---|---|
myaccount |
O nome da sua conta de armazenamento. |
myshare |
O nome do seu compartilhamento de arquivo. |
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 do URI
Você pode especificar os seguintes parâmetros adicionais no URI de 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 da solicitaçã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órios. Especifica o esquema de autorização, o nome da conta e a assinatura. Para saber mais, confira Autorizar solicitações para o Armazenamento do Azure. |
Date ou x-ms-date |
Obrigatórios. Especifica o UTC (Tempo Universal Coordenado) para a solicitação. Para saber mais, confira 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 esta 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 controle do cache para o arquivo. Se essa propriedade não for especificada na solicitação, a propriedade será limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de 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á limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de 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á limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente. |
x-ms-content-encoding |
Opcional. Defina a codificação do conteúdo do arquivo. Se essa propriedade não for especificada na solicitação, a propriedade será limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de Arquivo não retornarão essa propriedade, a menos que ela seja definida explicitamente no arquivo novamente. |
x-ms-content-language |
Opcional. Defina a linguagem do conteúdo do arquivo. Se essa propriedade não for especificada na solicitação, a propriedade será limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de 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 do Content-Disposition arquivo.Se essa propriedade não for especificada na solicitação, a propriedade será limpa para o arquivo. As chamadas subsequentes para Obter Propriedades de 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 com 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> } |
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 para o arquivo especificado no SDDL (Security Descriptor Definition Language) . Você poderá usar esse cabeçalho se o tamanho das permissões for de 8 kibibytes (KiB) ou menos. Caso contrário, você poderá usar x-ms-file-permission-key. Se especificado, ele deverá ter uma DACL (lista de controle de acesso discricionário, grupo e proprietário). Um valor de preserve pode ser passado para manter um valor existente inalterado.Observação: você pode especificar ou x-ms-file-permissionx-ms-file-permission-key. Se nenhum cabeçalho for especificado, o valor padrão de preserve 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 Create-Permission API.Observação: você pode especificar ou x-ms-file-permissionx-ms-file-permission-key. Se nenhum cabeçalho for especificado, o valor padrão de preserve será usado para o x-ms-file-permission cabeçalho. |
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 última hora de 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> |
Obrigató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) alterou 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 |
Obrigatório se Authorization o cabeçalho especificar um token OAuth. O valor aceitável é backup. Esse cabeçalho especifica que o Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action deve ser concedido se eles estiverem incluídos na política RBAC atribuída à identidade autorizada usando 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 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 de 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 Códigos de status e de erro.
Cabeçalhos de resposta
A resposta para esta operação inclui os cabeçalhos a seguir. A resposta também pode incluir cabeçalhos padrão HTTP 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 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 da data segue 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 usado 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 true como 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 será 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 x-ms-client-request-id cabeçalho 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. |
| Hidden | 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. Os aplicativos normalmente 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. Arquivos do Azure não dá 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. |
Comentários
A semântica para atualizar as propriedades do arquivo estão a seguir:
Um tamanho de arquivo é modificado apenas se a solicitação especifica um valor para o cabeçalho
x-ms-content-length.Se uma solicitação definir apenas
x-ms-content-lengthe 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á limpa para o arquivo.
x-ms-cache-controlx-ms-content-typex-ms-content-md5x-ms-content-encodingx-ms-content-language
Observação
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 propertiesnão há suporte em uma instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Uma tentativa de executar essa operação em um compartilhamento instantâneo 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á status código 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á status código 412 (Falha na pré-condição).