Partilhar via


FileRenameOptions interface

Opções para configurar o renomear operação.

Extends

Propriedades

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.

contentType

Opcional. Tipo de conteúdo a ser definido no arquivo.

copyFileSmbInfo

Opcional. Especifica a opção para copiar o descritor de segurança de arquivo do arquivo de origem ou para defini-lo usando o valor definido pelo valor de cabeçalho de x-ms-file-permission ou x-ms-file-permission-key.

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.

filePermission

Opcional. Se especificado, a permissão (descritor de segurança) deve ser definida para o diretório/arquivo.

filePermissionKey

Opcional. Chave da permissão a ser definida para o diretório/arquivo. Nota: Apenas um dos filePermission ou filePermissionKey deve ser especificado.

ignoreReadOnly

Opcional. Um valor booleano que especifica se o atributo ReadOnly em um arquivo de destino preexistente deve ser respeitado. Se true, a renomeação terá êxito, caso contrário, um arquivo anterior no destino com o atributo ReadOnly definido fará com que a renomeação falhe.

metadata

Um par nome-valor para associar a um objeto de armazenamento de arquivos.

replaceIfExists

Opcional. Um valor booleano para se o arquivo de destino já existe, se essa solicitação substituirá o arquivo ou não. Se verdadeiro, a renomeação terá êxito e substituirá o arquivo de destino. Se não for fornecido ou se for falso 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. Nota: Este valor não substitui o valor do cabeçalho x-ms-file-copy-ignore-read-only.

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.

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.

Propriedades Herdadas

tracingOptions

Detalhes de Propriedade

abortSignal

Uma implementação da interface AbortSignalLike para sinalizar o pedido de cancelamento da operação. Por exemplo, use o controlador @azure/abort para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor de Propriedade

contentType

Opcional. Tipo de conteúdo a ser definido no arquivo.

contentType?: string

Valor de Propriedade

string

copyFileSmbInfo

Opcional. Especifica a opção para copiar o descritor de segurança de arquivo do arquivo de origem ou para defini-lo usando o valor definido pelo valor de cabeçalho de x-ms-file-permission ou x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Valor de 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?: LeaseAccessConditions

Valor de Propriedade

filePermission

Opcional. Se especificado, a permissão (descritor de segurança) deve ser definida para o diretório/arquivo.

filePermission?: string

Valor de Propriedade

string

filePermissionKey

Opcional. Chave da permissão a ser definida para o diretório/arquivo. Nota: Apenas um dos filePermission ou filePermissionKey deve ser especificado.

filePermissionKey?: string

Valor de Propriedade

string

ignoreReadOnly

Opcional. Um valor booleano que especifica se o atributo ReadOnly em um arquivo de destino preexistente deve ser respeitado. Se true, a renomeação terá êxito, caso contrário, um arquivo anterior no destino com o atributo ReadOnly definido fará com que a renomeação falhe.

ignoreReadOnly?: boolean

Valor de Propriedade

boolean

metadata

Um par nome-valor para associar a um objeto de armazenamento de arquivos.

metadata?: Metadata

Valor de Propriedade

replaceIfExists

Opcional. Um valor booleano para se o arquivo de destino já existe, se essa solicitação substituirá o arquivo ou não. Se verdadeiro, a renomeação terá êxito e substituirá o arquivo de destino. Se não for fornecido ou se for falso 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. Nota: Este valor não substitui o valor do cabeçalho x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Valor de 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?: LeaseAccessConditions

Valor de 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?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

tracingOptions

tracingOptions?: OperationTracingOptions

Valor de Propriedade

herdado deCommonOptions.tracingOptions