FileRenameOptions interface
Options permettant de configurer l’opération rename(string, FileRenameOptions) .
- Extends
Propriétés
abort |
Implémentation de l’interface |
content |
facultatif. Type de contenu à définir sur le fichier. |
copy |
facultatif. Spécifie l’option permettant de copier le descripteur de sécurité de fichier à partir d’un fichier source ou de le définir à l’aide de la valeur d’en-tête x-ms-file-permission ou x-ms-file-permission-key. |
destination |
Condition d’accès au bail pour le fichier de destination. Obligatoire si le fichier de destination a un bail infini actif. |
file |
facultatif. Si spécifié, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier. |
file |
facultatif. Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : un seul des fichiers FilePermission ou filePermissionKey doit être spécifié. |
ignore |
facultatif. Valeur booléenne qui spécifie si l’attribut ReadOnly d’un fichier de destination préexistant doit être respecté. Si la valeur est true, le renommage réussit. Sinon, un fichier précédent à la destination avec l’attribut ReadOnly défini entraîne l’échec du renommage. |
metadata | Paire nom-valeur à associer à un objet de stockage de fichiers. |
replace |
facultatif. Valeur booléenne indiquant si le fichier de destination existe déjà, si cette requête remplacera le fichier ou non. Si la valeur est true, le renommage réussit et remplace le fichier de destination. Si elle n’est pas fournie ou si la valeur est false et que le fichier de destination existe, la demande ne remplacera pas le fichier de destination. S’il est fourni et que le fichier de destination n’existe pas, le renommage réussit. Remarque : Cette valeur ne remplace pas la valeur d’en-tête x-ms-file-copy-ignore-read-only. |
source |
Condition d’accès au bail pour le fichier source. Obligatoire si le fichier source a un bail infini actif. |
timeout |
facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définition de délais d’expiration pour les opérations de service de fichiers. |
Propriétés héritées
tracing |
Détails de la propriété
abortSignal
Implémentation de l’interface AbortSignalLike
pour signaler la demande d’annulation de l’opération.
Par exemple, utilisez le @azure/abort-controller pour créer un AbortSignal
.
abortSignal?: AbortSignalLike
Valeur de propriété
AbortSignalLike
contentType
facultatif. Type de contenu à définir sur le fichier.
contentType?: string
Valeur de propriété
string
copyFileSmbInfo
facultatif. Spécifie l’option permettant de copier le descripteur de sécurité de fichier à partir d’un fichier source ou de le définir à l’aide de la valeur d’en-tête x-ms-file-permission ou x-ms-file-permission-key.
copyFileSmbInfo?: CopyFileSmbInfo
Valeur de propriété
destinationLeaseAccessConditions
Condition d’accès au bail pour le fichier de destination. Obligatoire si le fichier de destination a un bail infini actif.
destinationLeaseAccessConditions?: LeaseAccessConditions
Valeur de propriété
filePermission
facultatif. Si spécifié, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier.
filePermission?: string
Valeur de propriété
string
filePermissionKey
facultatif. Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : un seul des fichiers FilePermission ou filePermissionKey doit être spécifié.
filePermissionKey?: string
Valeur de propriété
string
ignoreReadOnly
facultatif. Valeur booléenne qui spécifie si l’attribut ReadOnly d’un fichier de destination préexistant doit être respecté. Si la valeur est true, le renommage réussit. Sinon, un fichier précédent à la destination avec l’attribut ReadOnly défini entraîne l’échec du renommage.
ignoreReadOnly?: boolean
Valeur de propriété
boolean
metadata
Paire nom-valeur à associer à un objet de stockage de fichiers.
metadata?: Metadata
Valeur de propriété
replaceIfExists
facultatif. Valeur booléenne indiquant si le fichier de destination existe déjà, si cette requête remplacera le fichier ou non. Si la valeur est true, le renommage réussit et remplace le fichier de destination. Si elle n’est pas fournie ou si la valeur est false et que le fichier de destination existe, la demande ne remplacera pas le fichier de destination. S’il est fourni et que le fichier de destination n’existe pas, le renommage réussit. Remarque : Cette valeur ne remplace pas la valeur d’en-tête x-ms-file-copy-ignore-read-only.
replaceIfExists?: boolean
Valeur de propriété
boolean
sourceLeaseAccessConditions
Condition d’accès au bail pour le fichier source. Obligatoire si le fichier source a un bail infini actif.
sourceLeaseAccessConditions?: LeaseAccessConditions
Valeur de propriété
timeoutInSeconds
facultatif. Le paramètre timeout est exprimé en secondes. Pour plus d’informations, consultez Définition de délais d’expiration pour les opérations de service de fichiers.
timeoutInSeconds?: number
Valeur de propriété
number
Détails de la propriété héritée
tracingOptions
tracingOptions?: OperationTracingOptions
Valeur de propriété
OperationTracingOptions
Hérité deCommonOptions.tracingOptions