Renomear Diretório

A operação Rename Directory 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

Pedir

Você pode construir a solicitação Rename Directory da seguinte maneira. O HTTPS é recomendado.

Método	URI de solicitação	Versão HTTP
PÔR	https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename	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.
mydirectory	O nome do diretório de destino.

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

Parâmetros de URI

Você pode especificar o seguinte parâmetro adicional 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 Arquivos do Azure.

Cabeçalhos de solicitação

A tabela a seguir descreve cabeçalhos de solicitação obrigatórios e opcionais.

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-file-rename-source:name	Necessário. URI completo do diretório a ser renomeado.
x-ms-file-rename-ignore-readonly	Opcional. Se o diretório de destino existir com o atributo readonly, substitua o diretório. Se for verdade, x-ms-file-rename-replace-if-exists também deve ser verdadeiro.
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> }	Opcional se x-ms-file-permission-key não for especificado. Essa permissão é o descritor de segurança para o diretório especificado no SDDL (Linguagem de Definição do Descritor de Segurança) ou (versão 2024-11-04 ou posterior) no formato do descritor de segurança binário 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 especificada, essa permissão deve ter um proprietário, um grupo e lista de controle de acesso discricionário. Você pode passar um valor de preserve se quiser manter um valor existente inalterado. Observe que você pode especificar x-ms-file-permission ou x-ms-file-permission-key, não ambos.
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	Opcional se x-ms-file-permission não for especificado. A chave da permissão a ser definida para o diretório. Você pode criar isso usando a API Create-Permission. Observe que você pode especificar x-ms-file-permission ou x-ms-file-permission-key, não ambos.
x-ms-file-attributes	Opcional. Os atributos do sistema de arquivos a serem definidos no diretório. Consulte 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.
x-ms-file-creation-time	Opcional. A propriedade de tempo 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.
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.
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 o Armazenamento de Blobs do Azure.
x-ms-meta-name:value	Opcional. Define um par nome-valor para o diretório. Cada chamada a essa operação substitui todos os metadados existentes anexados ao diretório. 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.
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.
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 compartilhamento de arquivos do Azure. Esse cabeçalho não tem suporte para nenhum outro tipo de origem de cópia. 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, 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 dos 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 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	A chave da permissão do arquivo.
x-ms-file-attributes	Os atributos do sistema de arquivos no arquivo. Consulte 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 tempo de gravação para o arquivo.
x-ms-file-change-time	A data/hora UTC que representa a propriedade de tempo 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 é igual ao valor do cabeçalho x-ms-client-request-id, se ele estiver presente na solicitação. O valor é no máximo 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 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. Esse atributo é válido somente quando 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 arquivo morto. Normalmente, os aplicativos 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. Os Arquivos do Azure não dão 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.

Observações

Se o destino for um diretório, o diretório não deverá existir.

Rename Directory não tem suporte em um instantâneo de compartilhamento, que é uma cópia somente leitura de um compartilhamento. Se você tentar executar essa operação em um instantâneo de compartilhamento, o serviço retornará o status de erro 400 (Valor do 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, os Arquivos do Azure retornarão o código de status 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, os Arquivos do Azure também retornarão o código de status 412 (Falha na pré-condição).

Consulte também

operações de em diretórios