Mudar o Nome de Ficheiro
A Rename File operação muda o nome de um ficheiro e, opcionalmente, pode definir as propriedades do sistema para o ficheiro. Esta API está disponível na versão 2021-04-10 e posterior.
Disponibilidade do protocolo
| Protocolo de partilha de ficheiros ativado | Disponível |
|---|---|
| SMB |  |
| NFS |  |
Pedir
Pode construir o pedido da Rename File seguinte forma. É recomendado HTTPS.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| PUT | https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename |
HTTP/1.1 |
Substitua os componentes de caminho apresentados no URI do pedido pelo seu, da seguinte forma:
| Componente caminho | Description |
|---|---|
myaccount |
O nome da sua conta de armazenamento. |
myshare |
O nome da partilha de ficheiros. |
mydirectorypath |
Opcional. O caminho para o diretório de destino principal. |
myfile |
O nome do ficheiro de destino. |
Para obter detalhes sobre as restrições de nomenclatura de caminhos, veja Nomenclatura e referência de partilhas, diretórios, ficheiros e metadados.
Parâmetros URI
Pode especificar o seguinte parâmetro adicional no URI do pedido.
| Parâmetro | Description |
|---|---|
timeout |
Opcional. O timeout parâmetro é expresso em segundos. Para obter mais informações, veja Setting timeouts for Ficheiros do Azure operations (Definir tempos limite para operações de Ficheiros do Azure). |
Cabeçalhos do pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
| Cabeçalho do pedido | Description |
|---|---|
Authorization |
Obrigatório. Especifica o esquema de autorização, o nome da conta e a assinatura. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure. |
Date ou x-ms-date |
Obrigatório. Especifica a Hora Universal Coordenada (UTC) do pedido. Para obter mais informações, veja Autorizar pedidos para o Armazenamento do Azure. |
x-ms-version |
Necessário para todos os pedidos autorizados. Especifica a versão da operação a utilizar para este pedido. Para obter mais informações, veja Controlo de versões dos serviços de Armazenamento do Azure. |
x-ms-file-rename-source:name |
Obrigatório. Nome do ficheiro a mudar. |
x-ms-file-rename-replace-if-exists |
Opcional. Se o ficheiro de destino já existir, substitua o ficheiro. |
x-ms-file-rename-ignore-readonly |
Opcional. Se o ficheiro de destino existir com o readonly atributo, substitua o ficheiro.Se for verdade, x-ms-file-rename-replace-if-exists também tem de ser verdade. |
x-ms-content-Type |
Opcional. Define o tipo de conteúdo do ficheiro. Se esta propriedade não for especificada no pedido, a propriedade será preservada para o ficheiro. |
x-ms-file-permission |
Opcional se x-ms-file-permission-key não for especificado. Esta permissão é o descritor de segurança do ficheiro especificado na Linguagem de Definição do Descritor de Segurança (SDDL). Pode utilizar este cabeçalho se o tamanho das permissões for 8 kibibytes (KiB) ou menos. Caso contrário, pode utilizar x-ms-file-permission-key. Se for especificada, esta permissão tem de ter uma lista de controlo de acesso discricionário, grupo e proprietário. Pode transmitir um valor de preserve se quiser manter um valor existente inalterado.Tenha em atenção que 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 definir para o ficheiro. Pode criar isto com a Create-Permission API.Tenha em atenção que pode especificar ou x-ms-file-permissionx-ms-file-permission-key, não ambos. |
x-ms-file-attributes |
Opcional. Os atributos do sistema de ficheiros a definir no ficheiro. Veja a lista de atributos disponíveis. Pode transmitir um valor de preserve se quiser manter um valor existente inalterado. Se não especificar esta propriedade no pedido, a propriedade será preservada para o ficheiro. |
x-ms-file-creation-time |
Opcional. A propriedade hora de criação UTC para um ficheiro. Pode transmitir um valor de preserve se quiser manter um valor existente inalterado. Se não especificar esta propriedade no pedido, a propriedade será preservada para o ficheiro. |
x-ms-file-last-write-time |
Opcional. A última propriedade de escrita utc de um ficheiro. Pode transmitir um valor de preserve se quiser manter um valor existente inalterado. Se não especificar esta propriedade no pedido, a propriedade será preservada para o ficheiro. |
x-ms-source-lease-id:<ID> |
Necessário se o ficheiro de origem tiver uma concessão ativa. |
x-ms-destination-lease-id:<ID> |
Necessário se o ficheiro de destino tiver uma concessão ativa. |
x-ms-client-request-id |
Opcional. Fornece um valor opaco gerado pelo cliente com um limite de carateres de 1 kibibyte (KiB) que é registado nos registos quando o registo é configurado. Recomendamos vivamente que utilize este cabeçalho para correlacionar as atividades do lado do cliente com os pedidos que o servidor recebe. Para obter mais informações, veja Monitorizar Armazenamento de Blobs do Azure. |
x-ms-meta-name:value |
Opcional. Define um par name-value para o ficheiro. Cada chamada para esta operação substitui todos os metadados existentes anexados ao ficheiro. Os nomes de metadados têm de cumprir as regras de nomenclatura dos identificadores C#. |
x-ms-file-request-intent |
Necessário se o Authorization cabeçalho especificar um token OAuth. O valor aceitável é backup. Este cabeçalho especifica que o Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action ou Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action deve ser concedido se estiverem incluídos na política RBAC atribuída à identidade autorizada com 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 Booleano especifica se um ponto à direita presente no URL do pedido deve ser cortado ou não. Para obter mais informações, veja Naming and referencing shares, directories, files, and metadata (Atribuir nomes e referenciar partilhas, diretórios, ficheiros e metadados). |
x-ms-source-allow-trailing-dot: { <Boolean> } |
Opcional. Versão 2022-11-02 e posterior. O valor Booleano especifica se um ponto à direita presente no URL de origem deve ser cortado ou não. Este cabeçalho só deve ser especificado se a origem de cópia for um Ficheiro do Azure. Este cabeçalho não é suportado para qualquer outro tipo de origem de cópia. Para obter mais informações, veja Naming and referencing shares, directories, files, and metadata (Atribuir nomes e referenciar partilhas, diretórios, ficheiros e metadados). |
Corpo do pedido
Nenhum.
Resposta
A resposta inclui um código de estado HTTP e um conjunto de cabeçalhos de resposta.
Código de estado
Uma operação bem-sucedida devolve o código de estado 200 (OK). Para obter informações sobre códigos de estado, veja Códigos de estado 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 de resposta | Descrição |
|---|---|
ETag |
Contém um valor que representa a versão do ficheiro, entre aspas. |
Last-Modified |
Devolve a data e hora em que o ficheiro foi modificado pela última vez. Para obter mais informações, veja Representação de valores de data/hora em cabeçalhos. Qualquer operação que modifica o diretório ou as respetivas propriedades atualiza a hora da última modificação. As operações nos ficheiros não afetam a hora da última modificação do diretório. |
x-ms-request-id |
Identifica exclusivamente o pedido que foi feito e pode ser utilizado para resolver o pedido. Para obter mais informações, veja Resolver problemas de operações da API. |
x-ms-version |
Indica a versão do Ficheiros do Azure utilizado para executar o pedido. |
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 este valor. |
x-ms-request-server-encrypted: true/false |
O valor deste cabeçalho é definido como true se os conteúdos do pedido forem encriptados com êxito através do algoritmo especificado. Caso contrário, o valor está definido como false. |
x-ms-file-permission-key |
A chave da permissão do ficheiro. |
x-ms-file-attributes |
Os atributos do sistema de ficheiros no ficheiro. Veja 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 ficheiro. |
x-ms-file-last-write-time |
O valor de data/hora UTC que representa a última propriedade de hora de escrita do ficheiro. |
x-ms-file-change-time |
A data/hora UTC que representa a propriedade de hora de alteração do ficheiro. |
x-ms-file-file-id |
O ID do ficheiro. |
x-ms-file-parent-id |
O ID de ficheiro principal do ficheiro. |
x-ms-client-request-id |
Pode ser utilizado para resolver problemas de pedidos e respostas correspondentes. O valor deste cabeçalho é igual ao valor do x-ms-client-request-id cabeçalho, se estiver presente no pedido. O valor é, no máximo, 1024 carateres ASCII visíveis. Se o x-ms-client-request-id cabeçalho não estiver presente no pedido, não estará presente na resposta. |
Corpo da resposta
Nenhum.
Autorização
Apenas o proprietário da conta pode chamar esta operação.
Atributos do sistema de ficheiros
| Atributo | Atributo de ficheiro Win32 | Definição |
|---|---|---|
ReadOnly |
FILE_ATTRIBUTE_READONLY | Um ficheiro que é só de leitura. As aplicações podem ler o ficheiro, mas não podem escrevê-lo ou eliminá-lo. |
Hidden |
FILE_ATTRIBUTE_HIDDEN | O ficheiro está oculto. Não está incluído numa listagem de diretórios comum. |
System |
FILE_ATTRIBUTE_SYSTEM | Um ficheiro do qual o sistema operativo utiliza uma parte ou utiliza exclusivamente. |
None |
FILE_ATTRIBUTE_NORMAL | Um ficheiro que não tem outros atributos definidos. Este atributo só é válido quando utilizado individualmente. |
Archive |
FILE_ATTRIBUTE_ARCHIVE | Um ficheiro que é um ficheiro de arquivo. Normalmente, as aplicações utilizam este atributo para marcar ficheiros para cópia de segurança ou remoção. |
Temporary |
FILE_ATTRIBUTE_TEMPORARY | Um ficheiro que está a ser utilizado para armazenamento temporário. |
Offline |
FILE_ATTRIBUTE_OFFLINE | Os dados de um ficheiro não estão disponíveis imediatamente. Este atributo do sistema de ficheiros é apresentado principalmente para fornecer compatibilidade com o Windows. Ficheiros do Azure não suporta opções de armazenamento offline. |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | O ficheiro não deve ser indexado pelo serviço de indexação de conteúdos. |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | O fluxo de dados do utilizador não deve ser lido pelo detetor de integridade de dados em segundo plano. Este atributo do sistema de ficheiros é apresentado principalmente para fornecer compatibilidade com o Windows. |
Observações
O destino não pode ser um diretório existente.
Se não especificar propriedades, o comportamento predefinido de preserve ou now será definido.
Nota
As propriedades de ficheiro anteriores são discretas das propriedades do sistema de ficheiros disponíveis para clientes SMB. Os clientes SMB não conseguem ler, escrever ou modificar estes valores de propriedade.
Rename File não é suportado num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Se tentar efetuar esta operação num instantâneo de partilha, o serviço devolve o estado de erro 400 (Valor do Parâmetro de Consulta Inválido).
Se o ficheiro tiver uma concessão ativa, o cliente tem de especificar um ID de concessão válido no pedido para mudar o nome do ficheiro. Se o cliente não especificar um ID de concessão ou especificar um ID de concessão inválido, Ficheiros do Azure devolve o código de estado 412 (Falha na Pré-condição). Se o cliente especificar um ID de concessão, mas o ficheiro não tiver uma concessão ativa, Ficheiros do Azure também devolve o código de estado 412 (Falha na Pré-condição).