Renomear Diretório
A Rename Directory operação renomeia um diretório e, opcionalmente, pode definir propriedades do sistema para o diretório. Essa API está disponível na versão 2021-04-10 e posterior.
Disponibilidade do protocolo
| Protocolo de compartilhamento de arquivos habilitado | Disponível |
|---|---|
| SMB |  |
| NFS |  |
Solicitação
Você pode construir a solicitação da Rename Directory seguinte maneira. HTTPS é recomendado.
| Método | URI da solicitação | Versão HTTP |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
Substitua os componentes do caminho mostrados no URI da solicitação pelos seus próprios, como segue:
| Componente Demarcador | 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. |
mydirectory |
O nome do diretório de destino. |
Para obter detalhes sobre restrições de nomenclatura de caminho, consulte Nomenclatura e referência de compartilhamentos, diretórios, arquivos e metadados.
Parâmetros do URI
Você pode especificar o parâmetro adicional a seguir no URI da solicitação.
| Parâmetro | Descrição |
|---|---|
timeout |
Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Configurando tempos limite para operações de Arquivos do Azure. |
Cabeçalhos da solicitação
A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.
| 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-file-rename-source:name |
Obrigatórios. Nome do diretório a ser renomeado. |
x-ms-file-rename-replace-if-exists |
Opcional. Se o arquivo de destino já existir, substitua o arquivo. |
x-ms-file-rename-ignore-readonly |
Opcional. Se o arquivo de destino existir com o readonly atributo , substitua o arquivo.Se for true, x-ms-file-rename-replace-if-exists também deverá ser true. |
x-ms-file-permission |
Opcional se x-ms-file-permission-key não for especificado. Essa permissão é o descritor de segurança para o diretório especificado na SDDL (Linguagem de Definição do Descritor de Segurança). 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 especificada, essa permissão deve ter uma lista de controle de acesso discricionário, grupo e proprietário. Você pode passar um valor de preserve se quiser manter um valor existente inalterado.Observe que você pode especificar ou x-ms-file-permissionx-ms-file-permission-key, não ambos. |
x-ms-file-permission-key |
Opcional se x-ms-file-permission não for especificado. A chave da permissão a ser definida para o arquivo. Você pode criar isso usando a Create-Permission API .Observe que você pode especificar ou x-ms-file-permissionx-ms-file-permission-key, não ambos. |
x-ms-file-attributes |
Opcional. Os atributos do sistema de arquivos a serem definidos no diretório. Confira a lista de atributos disponíveis. Você pode passar um valor de preserve se quiser manter um valor existente inalterado. Se essa propriedade não for especificada na solicitação, a propriedade será preservada para o arquivo. |
x-ms-file-creation-time |
Opcional. A propriedade de hora de criação UTC para um diretório. Você pode passar um valor de preserve se quiser manter um valor existente inalterado. Se essa propriedade não for especificada na solicitação, a propriedade será preservada para o arquivo. |
x-ms-file-last-write-time |
Opcional. A última propriedade de gravação UTC para um diretório. Você pode passar um valor de preserve se quiser manter um valor existente inalterado. Se essa propriedade não for especificada na solicitação, a propriedade será preservada para o arquivo. |
x-ms-destination-lease-id:<ID> |
Obrigatório se o arquivo de destino tiver uma concessão ativa. |
x-ms-client-request-id |
Opcional. Fornece um valor opaco gerado pelo cliente com um limite de caracteres de 1 KiB 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 Armazenamento de Blobs do Azure. |
x-ms-meta-name:value |
Opcional. Define um par de valor-nome para o arquivo. Cada chamada para essa operação substitui todos os metadados existentes anexados ao arquivo. Os nomes de metadados devem seguir as regras de nomenclatura para identificadores C#. Se essa propriedade não for especificada na solicitação, a propriedade será preservada para o arquivo. |
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 forem 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 de 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. |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Opcional. Versão 2022-11-02 e posterior. O valor booliano especifica se um ponto à direita presente na URL de origem deve ser cortado ou não. Esse cabeçalho só deverá ser especificado se a origem da cópia for um Arquivo do Azure. Não há suporte para esse cabeçalho para nenhum outro tipo de origem de cópia. 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 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 arquivo, entre aspas. |
Last-Modified |
Retorna a data e a hora em que o arquivo foi modificado pela última vez. Para obter mais informações, consulte Representação de valores de data e 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 Solução de problemas de operações de API. |
x-ms-version |
Indica a versão do Arquivos do Azure usada para executar a solicitação. |
Date ou x-ms-date |
Um valor de data/hora UTC que indica a hora em que a resposta foi iniciada. O serviço gera esse valor. |
x-ms-request-server-encrypted: true/false |
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 |
A chave da permissão do arquivo. |
x-ms-file-attributes |
Os atributos do sistema de arquivos no arquivo. Confira a lista de atributos disponíveis. |
x-ms-file-creation-time |
O valor de data/hora UTC que representa a propriedade de hora de criação do arquivo. |
x-ms-file-last-write-time |
O valor de data/hora UTC que representa a última propriedade de hora de gravação para o arquivo. |
x-ms-file-change-time |
A data/hora UTC que representa a propriedade de hora de alteração para o arquivo. |
x-ms-file-file-id |
A ID do arquivo. |
x-ms-file-parent-id |
A ID do arquivo pai do 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. O valor é no máximo 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 diretório que é somente leitura. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | O diretório está oculto. Ele não está incluído em uma listagem de diretório comum. |
System |
FILE_ATTRIBUTE_SYSTEM | Um diretório do qual o sistema operacional usa uma parte ou usa exclusivamente. |
None |
FILE_ATTRIBUTE_NORMAL | Um diretório que não tem outros atributos definidos. Este atributo é válido somente quando for usado sozinho. |
Directory |
FILE_ATTRIBUTE_DIRECTORY | O identificador que identifica um diretório. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Um diretório que é um diretório de arquivos. 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. 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 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 verificador de integridade de dados em segundo plano. Esse atributo do sistema de arquivos é apresentado principalmente para fornecer compatibilidade com o Windows. |
Comentários
Se o destino for um diretório, o diretório não deverá existir.
Rename Directorynão há suporte em uma instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Se você tentar executar essa operação em uma instantâneo de compartilhamento, o serviço retornará o erro status 400 (valor de parâmetro de consulta inválido).
Se você não especificar propriedades, o comportamento padrão de preserve ou now será definido.
Se o diretório tiver uma concessão ativa, o cliente deverá especificar uma ID de concessão válida na solicitação para renomear o diretório. Se o cliente não especificar uma ID de concessão ou especificar uma ID de concessão inválida, Arquivos do Azure retornará status código 412 (Falha na pré-condição). Se o cliente especificar uma ID de concessão, mas o diretório não tiver uma concessão ativa, Arquivos do Azure também retornará status código 412 (Falha na pré-condição).