FileRenameOptions interface

Pacote:

@azure/storage-file-share

Opções para configurar a operação de renomeação .

Extends

CommonOptions

Propriedades

abortSignal	Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.
contentType	Opcional. Tipo de conteúdo a ser definido no Arquivo.
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.
destinationLeaseAccessConditions	Condição de acesso de concessão para o arquivo de destino. Obrigatório se o arquivo de destino tiver uma concessão infinita ativa.
filePermission	Opcional. Se especificado, a permissão (descritor de segurança) deverá ser definida para o diretório/arquivo.
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.
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 atributo ReadOnly definido fará com que a renomeação falhe.
metadata	Um par nome-valor a ser associado a um objeto de armazenamento de arquivos.
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 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 terá êxito. Observação: esse valor não substitui o valor de cabeçalho x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Condição de acesso de concessão para o arquivo de origem. Obrigatório se o arquivo de origem tiver uma concessão infinita ativa.
timeoutInSeconds	Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Configurando tempos limite para operações de serviço de arquivo.

Propriedades herdadas

tracingOptions

Detalhes da propriedade

abortSignal

Uma implementação da AbortSignalLike interface para sinalizar a solicitação para cancelar a operação. Por exemplo, use o @azure/abort-controller para criar um AbortSignal.

abortSignal?: AbortSignalLike

Valor da propriedade

AbortSignalLike

contentType

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

contentType?: string

Valor 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?: CopyFileSmbInfo

Valor da propriedade

CopyFileSmbInfo

destinationLeaseAccessConditions

Condição de acesso de concessão para o arquivo de destino. Obrigatório se o arquivo de destino tiver uma concessão infinita ativa.

destinationLeaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

LeaseAccessConditions

filePermission

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

filePermission?: string

Valor da propriedade

string

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?: string

Valor 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 atributo ReadOnly definido fará com que a renomeação falhe.

ignoreReadOnly?: boolean

Valor da propriedade

boolean

metadata

Um par nome-valor a ser associado a um objeto de armazenamento de arquivos.

metadata?: Metadata

Valor da propriedade

Metadata

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 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 terá êxito. Observação: esse valor não substitui o valor de cabeçalho x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Valor da propriedade

boolean

sourceLeaseAccessConditions

Condição de acesso de concessão para o arquivo de origem. Obrigatório se o arquivo de origem tiver uma concessão infinita ativa.

sourceLeaseAccessConditions?: LeaseAccessConditions

Valor da propriedade

LeaseAccessConditions

timeoutInSeconds

Opcional. O parâmetro timeout é expresso em segundos. Para obter mais informações, consulte Configurando tempos limite para operações de serviço de arquivo.

timeoutInSeconds?: number

Valor da propriedade

number

Detalhes das propriedades herdadas

tracingOptions

tracingOptions?: OperationTracingOptions

Valor da propriedade

OperationTracingOptions

Herdado deCommonOptions.tracingOptions