DirectoryRenameOptions interface
- Extends
Propriétés
| abort |
Implémentation de l’interface |
| copy |
Optional. Spécifie l’option de copie du descripteur de sécurité de fichier à partir du fichier source ou de la définir à l’aide de la valeur d’en-tête définie par la valeur d’en-tête de 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 |
Optional. Si elle est spécifiée, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier. |
| file |
Optional. Disponible pour la version 2023-06-01 et ultérieure. Spécifie le format dans lequel l’autorisation est retournée. Les valeurs acceptables sont SDDL ou binaires. Si le format x-ms-file-permission-format n’est pas spécifié ou défini explicitement sur SDDL, l’autorisation est retournée au format SDDL. Si x-ms-file-permission-format est explicitement défini sur binaire, l’autorisation est retournée en tant que chaîne base64 représentant l’encodage binaire de l’autorisation |
| file |
Optional. Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : une seule des touches filePermission ou filePermissionKey doit être spécifiée. |
| ignore |
Optional. Valeur booléenne qui spécifie si l’attribut ReadOnly sur 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’ensemble d’attributs ReadOnly entraîne l’échec du renommage. |
| metadata | Optional. Paire nom-valeur à associer à un objet de stockage de fichiers. |
| replace |
Optional. Valeur booléenne pour si le fichier de destination existe déjà, que cette requête remplace 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 remplace 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 |
Optional. Le paramètre de délai d’expiration est exprimé en secondes. Pour plus d’informations, consultez Définition des délais d’attente 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 contrôleur @azure/abandon pour créer un AbortSignal.
abortSignal?: AbortSignalLike
Valeur de propriété
copyFileSmbInfo
Optional. Spécifie l’option de copie du descripteur de sécurité de fichier à partir du fichier source ou de la définir à l’aide de la valeur d’en-tête définie par la valeur d’en-tête de 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
Optional. Si elle est spécifiée, l’autorisation (descripteur de sécurité) doit être définie pour le répertoire/fichier.
filePermission?: string
Valeur de propriété
string
filePermissionFormat
Optional. Disponible pour la version 2023-06-01 et ultérieure. Spécifie le format dans lequel l’autorisation est retournée. Les valeurs acceptables sont SDDL ou binaires. Si le format x-ms-file-permission-format n’est pas spécifié ou défini explicitement sur SDDL, l’autorisation est retournée au format SDDL. Si x-ms-file-permission-format est explicitement défini sur binaire, l’autorisation est retournée en tant que chaîne base64 représentant l’encodage binaire de l’autorisation
filePermissionFormat?: FilePermissionFormat
Valeur de propriété
filePermissionKey
Optional. Clé de l’autorisation à définir pour le répertoire/fichier. Remarque : une seule des touches filePermission ou filePermissionKey doit être spécifiée.
filePermissionKey?: string
Valeur de propriété
string
ignoreReadOnly
Optional. Valeur booléenne qui spécifie si l’attribut ReadOnly sur 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’ensemble d’attributs ReadOnly entraîne l’échec du renommage.
ignoreReadOnly?: boolean
Valeur de propriété
boolean
metadata
Optional. Paire nom-valeur à associer à un objet de stockage de fichiers.
metadata?: Metadata
Valeur de propriété
replaceIfExists
Optional. Valeur booléenne pour si le fichier de destination existe déjà, que cette requête remplace 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 remplace 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
Optional. Le paramètre de délai d’expiration est exprimé en secondes. Pour plus d’informations, consultez Définition des délais d’attente pour les opérations de service de fichiers.
timeoutInSeconds?: number
Valeur de propriété
number