Definir propriedades do diretório
A operação Set Directory Properties define as propriedades do sistema para o diretório especificado. Esta API está disponível a partir da versão 2019-02-02.
Disponibilidade do protocolo
| Protocolo de compartilhamento de arquivos habilitado | Disponível |
|---|---|
| PME |
|
| NFS |
|
Solicitar
O pedido Set Directory Properties pode ser construído da seguinte forma. Recomendamos que você use HTTPS.
| Método | Solicitar URI | Versão HTTP |
|---|---|---|
| COLOCAR | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=properties |
HTTP/1.1 |
Substitua os componentes de caminho mostrados no URI de solicitação pelo seu, da seguinte maneira:
| Componente Caminho | Descrição |
|---|---|
myaccount |
O nome da sua conta de armazenamento. |
myshare |
O nome do seu compartilhamento de arquivos. |
mydirectorypath |
Opcional. O caminho para o diretório pai. |
mydirectory |
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 da 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 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. Para obter mais informações, consulte controle de versão para os serviços de Armazenamento do Azure. |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
Nas versões 2019-02-02 a 2021-04-10, esse cabeçalho é 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 diretório especificado no x-ms-file-permission-format. Você pode usar esse cabeçalho se o tamanho das permissões for 8 kibibytes (KiB) ou menos. Caso contrário, você pode usar x-ms-file-permission-key. Se for especificado, ele deve ter um proprietário, grupo e lista de controle de acesso discricionário (DACL). Para manter um valor existente inalterado, você pode passar um valor de preserve.Nota: 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 para o cabeçalho x-ms-file-permission. |
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á em SDDL ou em formato binário. Se x-ms-file-permission-key estiver definido como preserve, este cabeçalho não deve ser definido. Se x-ms-file-permission-key estiver 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 é 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 Create-Permission.Nota: 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 para o cabeçalho x-ms-file-permission. |
x-ms-file-attributes: { preserve ¦ <FileAttributeList> } |
Necessário para as versões 2019-02-02 a 2021-04-10. Opcional para a 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> } |
Necessário para as versões 2019-02-02 a 2021-04-10. Opcional para a versão 2021-06-08 e posterior. A propriedade de tempo de criação UTC (Tempo Universal Coordenado) para um diretório. 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> } |
Necessário para as versões 2019-02-02 a 2021-04-10. Opcional para a versão 2021-06-08 e posterior. A última propriedade de gravação do Tempo Universal Coordenado (UTC) para um diretório. Um valor de preserve pode ser passado para manter um valor existente inalterado. O valor padrão é preserve. |
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 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. |
x-ms-file-change-time: { now ¦ <DateTime> } |
Opcional. Versão 2021-06-08 e posterior. A propriedade de tempo de alteração do Tempo Universal Coordenado (UTC) para o diretório, 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 cabeçalho especificar um token OAuth. O valor aceitável é backup. Este 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 booleano especifica se um ponto à direita presente na url da solicitação deve ser cortado ou não. Para obter mais informações, consulte Nomeando e referenciando compartilhamentos, diretórios, arquivos e metadados. |
Corpo do pedido
Nenhuma.
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 mais 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 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 |
|---|---|
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 diretório 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 a 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 de arquivo que foi 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 é 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 diretório. |
x-ms-file-attributes |
Versão 2019-02-02 e posterior. Os atributos do sistema de arquivos no diretório. 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 tempo de criação para o diretório. |
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 diretório. |
x-ms-file-change-time |
Versão 2019-02-02 e posterior. O valor de data/hora UTC que representa a propriedade change time para o diretório. |
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 de resposta
Nenhuma.
Autorização
Apenas o proprietário da conta pode chamar esta operação.
Atributos do sistema de arquivos
| Atributo | Atributo de arquivo Win32 | Definição |
|---|---|---|
| Somente leitura | FILE_ATTRIBUTE_READONLY | Um diretório que é somente leitura. |
| Escondido | FILE_ATTRIBUTE_HIDDEN | O diretório está oculto. Ele não está incluído em uma listagem de diretório comum. |
| Sistema | FILE_ATTRIBUTE_SYSTEM | Um diretório que o sistema operacional usa uma parte ou usa exclusivamente. |
| Nenhum | FILE_ATTRIBUTE_NORMAL | Um diretório que não tem outros atributos definidos. Este atributo é válido apenas quando é usado sozinho. |
| Diretório | FILE_ATTRIBUTE_DIRECTORY | O identificador que identifica um diretório. |
| Arquivo | FILE_ATTRIBUTE_ARCHIVE | Um diretório que é um diretório de arquivo. Os aplicativos normalmente usam esse atributo para marcar arquivos para backup ou remoção. |
| Offline | FILE_ATTRIBUTE_OFFLINE | Os dados de um diretório não estão disponíveis imediatamente. Este atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows. O Azure Files não oferece suporte a opções de armazenamento offline. |
| NotContentIndexed | FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | O diretório 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 scanner de integridade de dados em segundo plano. Este atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows. |
Comentários
Set Directory Properties não é suportado 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).
As propriedades definidas em um diretório com Set Directory Properties não se propagam para nenhum subdiretório abaixo desse diretório. Você deve chamar Set Directory Properties para cada diretório para o qual deseja atualizar as propriedades.