FileRenameOptions interface
Opções para configurar o renomear operação.
- Extends
Propriedades
| abort |
Uma implementação da interface |
| content |
Opcional. Tipo de conteúdo a ser definido no Arquivo. |
| copy |
Opcional. Especifica a opção de copiar o descritor de segurança de arquivo do arquivo de origem ou defini-lo usando o valor definido pelo valor de cabeçalho de x-ms-file-permission ou x-ms-file-permission-key. |
| destination |
Condição de acesso de concessão para o arquivo de destino. Necessário se o arquivo de destino tiver uma concessão infinita ativa. |
| file |
Opcional. Se especificado, a permissão (descritor de segurança) será definida para o diretório/arquivo. |
| file |
Opcional. Disponível para a versão 2023-06-01 e posterior. Especifica o formato no qual a permissão é retornada. Os valores aceitáveis são SDDL ou binários. Se x-ms-file-permission-format não for especificado ou definido explicitamente como SDDL, a permissão será retornada no formato SDDL. Se x-ms-file-permission-format for explicitamente definido como binário, a permissão será retornada como uma cadeia de caracteres base64 que representa a codificação binária da permissão |
| file |
Opcional. Chave da permissão a ser definida para o diretório/arquivo. Observação: apenas um dos filePermission ou filePermissionKey deve ser especificado. |
| ignore |
Opcional. Um valor booliano que especifica se o atributo ReadOnly em um arquivo de destino preexistência deve ser respeitado. Se for true, a renomeação terá êxito, caso contrário, um arquivo anterior no destino com o conjunto de atributos ReadOnly fará com que a renomeação falhe. |
| metadata | Um par nome-valor a ser associado a um objeto de armazenamento de arquivos. |
| replace |
Opcional. Um valor booliano para se o arquivo de destino já existir, se essa solicitação substituirá o arquivo ou não. Se for true, a renomeação será bem-sucedida e substituirá o arquivo de destino. Se não for fornecido ou se houver false e o arquivo de destino existir, a solicitação não substituirá o arquivo de destino. Se fornecido e o arquivo de destino não existir, a renomeação será bem-sucedida. Observação: esse valor não substitui o valor do cabeçalho x-ms-file-copy-ignore-read-only. |
| source |
Condição de acesso de concessão para o arquivo de origem. Necessário se o arquivo de origem tiver uma concessão infinita ativa. |
| timeout |
Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de arquivo. |
Propriedades herdadas
| tracing |
Detalhes da propriedade
abortSignal
Uma implementação da interface AbortSignalLike para sinalizar a solicitação para cancelar a operação.
Por exemplo, use o controlador de @azure/anulação para criar um AbortSignal.
abortSignal?: AbortSignalLikeValor da propriedade
contentType
Opcional. Tipo de conteúdo a ser definido no Arquivo.
contentType?: stringValor da propriedade
string
copyFileSmbInfo
Opcional. Especifica a opção de copiar o descritor de segurança de arquivo do arquivo de origem ou defini-lo usando o valor definido pelo valor de cabeçalho de x-ms-file-permission ou x-ms-file-permission-key.
copyFileSmbInfo?: CopyFileSmbInfoValor da propriedade
destinationLeaseAccessConditions
Condição de acesso de concessão para o arquivo de destino. Necessário se o arquivo de destino tiver uma concessão infinita ativa.
destinationLeaseAccessConditions?: LeaseAccessConditionsValor da propriedade
filePermission
Opcional. Se especificado, a permissão (descritor de segurança) será definida para o diretório/arquivo.
filePermission?: stringValor da propriedade
string
filePermissionFormat
Opcional. Disponível para a versão 2023-06-01 e posterior. Especifica o formato no qual a permissão é retornada. Os valores aceitáveis são SDDL ou binários. Se x-ms-file-permission-format não for especificado ou definido explicitamente como SDDL, a permissão será retornada no formato SDDL. Se x-ms-file-permission-format for explicitamente definido como binário, a permissão será retornada como uma cadeia de caracteres base64 que representa a codificação binária da permissão
filePermissionFormat?: FilePermissionFormatValor da propriedade
filePermissionKey
Opcional. Chave da permissão a ser definida para o diretório/arquivo. Observação: apenas um dos filePermission ou filePermissionKey deve ser especificado.
filePermissionKey?: stringValor da propriedade
string
ignoreReadOnly
Opcional. Um valor booliano que especifica se o atributo ReadOnly em um arquivo de destino preexistência deve ser respeitado. Se for true, a renomeação terá êxito, caso contrário, um arquivo anterior no destino com o conjunto de atributos ReadOnly fará com que a renomeação falhe.
ignoreReadOnly?: booleanValor da propriedade
boolean
metadata
Um par nome-valor a ser associado a um objeto de armazenamento de arquivos.
metadata?: MetadataValor da propriedade
replaceIfExists
Opcional. Um valor booliano para se o arquivo de destino já existir, se essa solicitação substituirá o arquivo ou não. Se for true, a renomeação será bem-sucedida e substituirá o arquivo de destino. Se não for fornecido ou se houver false e o arquivo de destino existir, a solicitação não substituirá o arquivo de destino. Se fornecido e o arquivo de destino não existir, a renomeação será bem-sucedida. Observação: esse valor não substitui o valor do cabeçalho x-ms-file-copy-ignore-read-only.
replaceIfExists?: booleanValor da propriedade
boolean
sourceLeaseAccessConditions
Condição de acesso de concessão para o arquivo de origem. Necessário se o arquivo de origem tiver uma concessão infinita ativa.
sourceLeaseAccessConditions?: LeaseAccessConditionsValor da propriedade
timeoutInSeconds
Opcional. O parâmetro de tempo limite é expresso em segundos. Para obter mais informações, consulte Definindo tempos limite para operações de serviço de arquivo.
timeoutInSeconds?: numberValor da propriedade
number
Detalhes das propriedades herdadas
tracingOptions
tracingOptions?: OperationTracingOptionsValor da propriedade
Herdado deCommonOptions.tracingOptions