FileRenameOptions interface

Balíček:

@azure/storage-file-share

Možnosti konfigurace operace přejmenování

Extends

CommonOptions

Vlastnosti

abortSignal	Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.
contentType	Optional. Typobsahuho
copyFileSmbInfo	Optional. Určuje možnost kopírování popisovače zabezpečení souboru ze zdrojového souboru nebo jeho nastavení pomocí hodnoty definované hodnotou hlavičky x-ms-file-permission nebo x-ms-file-permission-key.
destinationLeaseAccessConditions	Podmínka přístupu k zapůjčení cílového souboru Vyžaduje se, pokud má cílový soubor aktivní nekonečné zapůjčení.
filePermission	Optional. Pokud zadáte oprávnění (popisovač zabezpečení), nastaví se pro adresář nebo soubor.
filePermissionFormat	Optional. K dispozici pro verzi 2023-06-01 a novější. Určuje formát, ve kterém se oprávnění vrátí. Přijatelné hodnoty jsou SDDL nebo binární. Pokud není zadaný formát x-ms-file-permission-format nebo explicitně nastaven na SDDL, vrátí se oprávnění ve formátu SDDL. Pokud je formát x-ms-file-permission-format explicitně nastaven na binární, vrátí se oprávnění jako řetězec base64 představující binární kódování oprávnění.
filePermissionKey	Optional. Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Je třeba zadat pouze jeden souborPermission nebo filePermissionKey.
ignoreReadOnly	Optional. Logická hodnota, která určuje, zda atribut ReadOnly v existujícím cílovém souboru by se měl respektovat. Pokud ano, přejmenování bude úspěšné, jinak předchozí soubor v cíli se sadou atributů ReadOnly způsobí selhání přejmenování.
metadata	Pár název-hodnota, který se přidruží k objektu úložiště souborů.
replaceIfExists	Optional. Logická hodnota pro, pokud cílový soubor již existuje, zda tento požadavek přepíše soubor, nebo ne. Pokud je hodnota true, přejmenování bude úspěšné a přepíše cílový soubor. Pokud není zadaný nebo pokud neexistuje hodnota false a cílový soubor neexistuje, požadavek nepřepíše cílový soubor. Pokud je zadaný a cílový soubor neexistuje, přejmenování proběhne úspěšně. Poznámka: Tato hodnota nepřepíše hodnotu hlavičky x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	Podmínka přístupu k zapůjčení zdrojového souboru Vyžaduje se, pokud má zdrojový soubor aktivní nekonečné zapůjčení.
timeoutInSeconds	Optional. Parametr časového limitu se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace souborové služby.

Zděděné vlastnosti

tracingOptions

Podrobnosti vlastnosti

abortSignal

Implementace rozhraní AbortSignalLike, která signalizují požadavek na zrušení operace. Například pomocí kontroleru @azure/abort-controller vytvořte AbortSignal.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

contentType

Optional. Typobsahuho

contentType?: string

Hodnota vlastnosti

string

copyFileSmbInfo

Optional. Určuje možnost kopírování popisovače zabezpečení souboru ze zdrojového souboru nebo jeho nastavení pomocí hodnoty definované hodnotou hlavičky x-ms-file-permission nebo x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

Hodnota vlastnosti

CopyFileSmbInfo

destinationLeaseAccessConditions

Podmínka přístupu k zapůjčení cílového souboru Vyžaduje se, pokud má cílový soubor aktivní nekonečné zapůjčení.

destinationLeaseAccessConditions?: LeaseAccessConditions

Hodnota vlastnosti

LeaseAccessConditions

filePermission

Optional. Pokud zadáte oprávnění (popisovač zabezpečení), nastaví se pro adresář nebo soubor.

filePermission?: string

Hodnota vlastnosti

string

filePermissionFormat

Optional. K dispozici pro verzi 2023-06-01 a novější. Určuje formát, ve kterém se oprávnění vrátí. Přijatelné hodnoty jsou SDDL nebo binární. Pokud není zadaný formát x-ms-file-permission-format nebo explicitně nastaven na SDDL, vrátí se oprávnění ve formátu SDDL. Pokud je formát x-ms-file-permission-format explicitně nastaven na binární, vrátí se oprávnění jako řetězec base64 představující binární kódování oprávnění.

filePermissionFormat?: FilePermissionFormat

Hodnota vlastnosti

FilePermissionFormat

filePermissionKey

Optional. Klíč oprávnění, které se má nastavit pro adresář nebo soubor. Poznámka: Je třeba zadat pouze jeden souborPermission nebo filePermissionKey.

filePermissionKey?: string

Hodnota vlastnosti

string

ignoreReadOnly

Optional. Logická hodnota, která určuje, zda atribut ReadOnly v existujícím cílovém souboru by se měl respektovat. Pokud ano, přejmenování bude úspěšné, jinak předchozí soubor v cíli se sadou atributů ReadOnly způsobí selhání přejmenování.

ignoreReadOnly?: boolean

Hodnota vlastnosti

boolean

metadata

Pár název-hodnota, který se přidruží k objektu úložiště souborů.

metadata?: Metadata

Hodnota vlastnosti

Metadata

replaceIfExists

Optional. Logická hodnota pro, pokud cílový soubor již existuje, zda tento požadavek přepíše soubor, nebo ne. Pokud je hodnota true, přejmenování bude úspěšné a přepíše cílový soubor. Pokud není zadaný nebo pokud neexistuje hodnota false a cílový soubor neexistuje, požadavek nepřepíše cílový soubor. Pokud je zadaný a cílový soubor neexistuje, přejmenování proběhne úspěšně. Poznámka: Tato hodnota nepřepíše hodnotu hlavičky x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

Hodnota vlastnosti

boolean

sourceLeaseAccessConditions

Podmínka přístupu k zapůjčení zdrojového souboru Vyžaduje se, pokud má zdrojový soubor aktivní nekonečné zapůjčení.

sourceLeaseAccessConditions?: LeaseAccessConditions

Hodnota vlastnosti

LeaseAccessConditions

timeoutInSeconds

Optional. Parametr časového limitu se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace souborové služby.

timeoutInSeconds?: number

Hodnota vlastnosti

number

Podrobnosti zděděných vlastností

tracingOptions

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

Zděděno zCommonOptions.tracingOptions