ShareClient class
Un ShareClient représente une URL vers le partage stockage Azure, ce qui vous permet de manipuler ses répertoires et fichiers.
- Extends
-
StorageClient
Constructeurs
| Share |
Crée une instance de ShareClient. |
| Share |
Crée une instance de ShareClient. |
| Share |
Propriétés
| name | Nom du partage |
| root |
Obtient le client d’annuaire pour le répertoire racine de ce partage. Notez que le répertoire racine existe toujours et ne peut pas être supprimé. Nouvel objet ShareDirectoryClient pour le répertoire racine. |
Propriétés héritées
| account |
|
| url | Valeur de chaîne d’URL. |
Méthodes
| create(Share |
Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, l’opération échoue. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-share |
| create |
Crée un sous-répertoire sous ce partage. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory |
| create |
Crée un fichier ou remplace un fichier sous le répertoire racine de ce partage. Notez qu’il initialise uniquement le fichier sans contenu. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-file |
| create |
Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, il n’est pas modifié. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-share |
| create |
Crée une autorisation de fichier (descripteur de sécurité) au niveau du partage. Le descripteur de sécurité créé peut être utilisé pour les fichiers/répertoires dans le partage. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission |
| create |
Crée un instantané en lecture seule d’un partage. |
| delete(Share |
Marque le partage spécifié pour suppression. Le partage et tous les répertoires ou fichiers contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share |
| delete |
Supprime le sous-répertoire vide spécifié sous ce partage. Notez que le répertoire doit être vide avant de pouvoir être supprimé. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory |
| delete |
Supprime un fichier sous le répertoire racine de ce partage du compte de stockage. Lorsqu’un fichier est supprimé avec succès, il est immédiatement supprimé de l’index du compte de stockage et n’est plus accessible aux clients. Les données du fichier sont supprimées ultérieurement du service pendant le garbage collection. La suppression du fichier échoue avec le code d’état 409 (conflit) et le code d’erreur Supprimer le fichier n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un instantané de partage échoue avec 400 ( Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2 |
| delete |
Marque le partage spécifié pour suppression s’il existe. Le partage et tous les répertoires ou fichiers contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share |
| exists(Share |
Retourne true si la ressource de partage Azrue représentée par ce client existe ; false sinon. REMARQUE : utilisez cette fonction avec soin, car un partage existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux partages peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée. |
| generate |
Disponible uniquement pour ShareClient construit avec des informations d’identification de clé partagée. Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
| generate |
Disponible uniquement pour ShareClient construit avec des informations d’identification de clé partagée. Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
| get |
Obtient les autorisations pour le partage spécifié. Les autorisations indiquent si les données de partage sont accessibles publiquement. AVERTISSEMENT : La date JavaScript risque de perdre la précision lors de l’analyse de la chaîne de début et d’expiration. Par exemple, nouvelle Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ». Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl |
| get |
Crée un objet ShareDirectoryClient. |
| get |
Obtient le langage de définition du descripteur de sécurité (SDDL) pour une clé d’autorisation de fichier donnée qui indique un descripteur de sécurité. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission |
| get |
Retourne toutes les métadonnées définies par l’utilisateur et les propriétés système du partage spécifié. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties AVERTISSEMENT : l’objet |
| get |
Obtenez un ShareLeaseClient qui gère les baux sur le fichier. |
| get |
Récupère les statistiques relatives au partage. |
| set |
Définit les autorisations pour le partage spécifié. Les autorisations indiquent si les répertoires ou les fichiers d’un partage sont accessibles publiquement. Lorsque vous définissez des autorisations pour un partage, les autorisations existantes sont remplacées. Si aucun shareAcl n’est fourni, la liste de contrôle d’accès de partage existante est supprimée. Lorsque vous établissez une stratégie d’accès stockée sur un partage, cela peut prendre jusqu’à 30 secondes. Pendant cet intervalle, une signature d’accès partagé associée à la stratégie d’accès stockée échoue avec le code d’état 403 (Interdit), jusqu’à ce que la stratégie d’accès devienne active. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl |
| set |
Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le partage spécifié. Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre d’option, les métadonnées de partage sont supprimées. Voir https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata |
| set |
Définit les propriétés du partage. |
| set |
Définit le quota pour le partage spécifié. |
| with |
Crée un objet ShareClient identique à la source, mais avec l’horodatage d’instantané spécifié. Indiquez « » supprime l’instantané et retourne une URL au partage de base. |
Détails du constructeur
ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)
Crée une instance de ShareClient.
new ShareClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)Paramètres
- url
-
string
Chaîne d’URL pointant vers le partage de fichiers Stockage Azure, par exemple «https://myaccount.file.core.windows.net/share". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.file.core.windows.net/share?sasString".
- credential
Tel que AnonymousCredential ou StorageSharedKeyCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.
- options
- ShareClientOptions
Optionnel. Options de configuration du pipeline HTTP.
ShareClient(string, Pipeline, ShareClientConfig)
Crée une instance de ShareClient.
new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)Paramètres
- url
-
string
Chaîne d’URL pointant vers le partage de fichiers Stockage Azure, par exemple «https://myaccount.file.core.windows.net/share". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.file.core.windows.net/share?sasString".
- pipeline
- Pipeline
Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.
- options
- ShareClientConfig
ShareClient(string, string, ShareClientOptions)
new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)Paramètres
- connectionString
-
string
Chaîne de connexion de compte ou chaîne de connexion SAP d’un compte de stockage Azure.
[ Remarque : la chaîne de connexion de compte ne peut être utilisée que dans NODE.JS runtime. ] Exemple de chaîne de connexion de compte - exemple de chaîne de connexion SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- name
-
string
Nom du partage.
- options
- ShareClientOptions
Optionnel. Options de configuration du pipeline HTTP.
Détails de la propriété
name
Nom du partage
string nameValeur de propriété
string
rootDirectoryClient
Obtient le client d’annuaire pour le répertoire racine de ce partage. Notez que le répertoire racine existe toujours et ne peut pas être supprimé.
Nouvel objet ShareDirectoryClient pour le répertoire racine.
ShareDirectoryClient rootDirectoryClientValeur de propriété
Détails de la propriété héritée
accountName
accountName: stringValeur de propriété
string
héritée de StorageClient.accountName
url
Valeur de chaîne d’URL.
url: stringValeur de propriété
string
héritée de StorageClient.url
Détails de la méthode
create(ShareCreateOptions)
Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, l’opération échoue.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>Paramètres
- options
- ShareCreateOptions
Options permettant de partager l’opération De création.
Retours
Promise<ShareCreateResponse>
Données de réponse pour l’opération De création de partage.
createDirectory(string, DirectoryCreateOptions)
Crée un sous-répertoire sous ce partage.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>Paramètres
- directoryName
-
string
- options
- DirectoryCreateOptions
Options de création d’annuaire.
Retours
Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>
Données de réponse de création d’annuaire et client d’annuaire correspondants.
createFile(string, number, FileCreateOptions)
Crée un fichier ou remplace un fichier sous le répertoire racine de ce partage. Notez qu’il initialise uniquement le fichier sans contenu.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-file
function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>Paramètres
- fileName
-
string
- size
-
number
Spécifie la taille maximale en octets du fichier, jusqu’à 4 To.
- options
- FileCreateOptions
Options d’opération de création de fichier.
Retours
Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>
Données de réponse de création de fichiers et client de fichiers correspondants.
createIfNotExists(ShareCreateOptions)
Crée un partage sous le compte spécifié. Si le partage portant le même nom existe déjà, il n’est pas modifié.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-share
function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>Paramètres
- options
- ShareCreateOptions
Retours
Promise<ShareCreateIfNotExistsResponse>
createPermission(string | SharePermission, ShareCreatePermissionOptions)
Crée une autorisation de fichier (descripteur de sécurité) au niveau du partage. Le descripteur de sécurité créé peut être utilisé pour les fichiers/répertoires dans le partage.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/create-permission
function createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>Paramètres
- filePermission
-
string | SharePermission
Autorisation de fichier décrite dans le SDDL
- options
- ShareCreatePermissionOptions
Options permettant de partager une opération d’autorisation de création.
Retours
Promise<ShareCreatePermissionResponse>
createSnapshot(ShareCreateSnapshotOptions)
Crée un instantané en lecture seule d’un partage.
function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>Paramètres
- options
- ShareCreateSnapshotOptions
Options permettant de partager l’opération de création d’instantané.
Retours
Promise<ShareCreateSnapshotResponse>
Données de réponse pour l’opération De création d’instantané de partage.
delete(ShareDeleteMethodOptions)
Marque le partage spécifié pour suppression. Le partage et tous les répertoires ou fichiers contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>Paramètres
- options
- ShareDeleteMethodOptions
Options d’opération de suppression de partage.
Retours
Promise<ShareDeleteResponse>
Données de réponse pour l’opération De suppression de partage.
deleteDirectory(string, DirectoryDeleteOptions)
Supprime le sous-répertoire vide spécifié sous ce partage. Notez que le répertoire doit être vide avant de pouvoir être supprimé.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>Paramètres
- directoryName
-
string
- options
- DirectoryDeleteOptions
Options d’opération de suppression d’annuaire.
Retours
Promise<DirectoryDeleteResponse>
Données de réponse de suppression d’annuaire.
deleteFile(string, FileDeleteOptions)
Supprime un fichier sous le répertoire racine de ce partage du compte de stockage. Lorsqu’un fichier est supprimé avec succès, il est immédiatement supprimé de l’index du compte de stockage et n’est plus accessible aux clients. Les données du fichier sont supprimées ultérieurement du service pendant le garbage collection.
La suppression du fichier échoue avec le code d’état 409 (conflit) et le code d’erreur SharingViolation si le fichier est ouvert sur un client SMB.
Supprimer le fichier n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un instantané de partage échoue avec 400 (InvalidQueryParameterValue)
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-file2
function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>Paramètres
- fileName
-
string
- options
- FileDeleteOptions
Options d’opération de suppression de fichier.
Retours
Promise<FileDeleteResponse>
Données de réponse de suppression de fichier de promesse.
deleteIfExists(ShareDeleteMethodOptions)
Marque le partage spécifié pour suppression s’il existe. Le partage et tous les répertoires ou fichiers contenus dans celui-ci sont supprimés ultérieurement pendant le garbage collection.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/delete-share
function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>Paramètres
- options
- ShareDeleteMethodOptions
Retours
Promise<ShareDeleteIfExistsResponse>
exists(ShareExistsOptions)
Retourne true si la ressource de partage Azrue représentée par ce client existe ; false sinon.
REMARQUE : utilisez cette fonction avec soin, car un partage existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux partages peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.
function exists(options?: ShareExistsOptions): Promise<boolean>Paramètres
- options
- ShareExistsOptions
options pour l’opération Exists.
Retours
Promise<boolean>
generateSasStringToSign(ShareGenerateSasUrlOptions)
Disponible uniquement pour ShareClient construit avec des informations d’identification de clé partagée.
Génère une chaîne à signer pour un URI de signature d’accès partagé de service (SAP) en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasStringToSign(options: ShareGenerateSasUrlOptions): stringParamètres
- options
- ShareGenerateSasUrlOptions
Paramètres facultatifs.
Retours
string
URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.
generateSasUrl(ShareGenerateSasUrlOptions)
Disponible uniquement pour ShareClient construit avec des informations d’identification de clé partagée.
Génère un URI de signature d’accès partagé (SAP) de service en fonction des propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: ShareGenerateSasUrlOptions): stringParamètres
- options
- ShareGenerateSasUrlOptions
Paramètres facultatifs.
Retours
string
URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.
getAccessPolicy(ShareGetAccessPolicyOptions)
Obtient les autorisations pour le partage spécifié. Les autorisations indiquent si les données de partage sont accessibles publiquement.
AVERTISSEMENT : La date JavaScript risque de perdre la précision lors de l’analyse de la chaîne de début et d’expiration. Par exemple, nouvelle Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-acl
function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>Paramètres
- options
- ShareGetAccessPolicyOptions
Retours
Promise<ShareGetAccessPolicyResponse>
Données de réponse pour l’opération de stratégie d’accès au partage.
getDirectoryClient(string)
Crée un objet ShareDirectoryClient.
function getDirectoryClient(directoryName: string): ShareDirectoryClientParamètres
- directoryName
-
string
Nom d’un répertoire
Retours
Objet ShareDirectoryClient pour le nom de répertoire donné.
getPermission(string, ShareGetPermissionOptions)
Obtient le langage de définition du descripteur de sécurité (SDDL) pour une clé d’autorisation de fichier donnée qui indique un descripteur de sécurité.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-permission
function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>Paramètres
- filePermissionKey
-
string
Clé d’autorisation de fichier qui indique le descripteur de sécurité de l’autorisation.
- options
- ShareGetPermissionOptions
Options permettant de partager une opération d’autorisation de création.
Retours
Promise<ShareGetPermissionResponse>
getProperties(ShareGetPropertiesOptions)
Retourne toutes les métadonnées définies par l’utilisateur et les propriétés système du partage spécifié.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/get-share-properties
AVERTISSEMENT : l’objet metadata retourné dans la réponse aura ses clés en minuscules, même s’ils contenaient initialement des caractères majuscules. Cela diffère des clés de métadonnées retournées par la méthode listShares de ShareServiceClient à l’aide de l’option de includeMetadata, qui conserve sa casse d’origine.
function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>Paramètres
- options
- ShareGetPropertiesOptions
Retours
Promise<ShareGetPropertiesResponse>
Données de réponse pour l’opération Share Get Properties.
getShareLeaseClient(string)
Obtenez un ShareLeaseClient qui gère les baux sur le fichier.
function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClientParamètres
- proposeLeaseId
-
string
ID de bail initial proposé.
Retours
Nouvel objet ShareLeaseClient pour la gestion des baux sur le fichier.
getStatistics(ShareGetStatisticsOptions)
Récupère les statistiques relatives au partage.
function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>Paramètres
- options
- ShareGetStatisticsOptions
Retours
Promise<ShareGetStatisticsResponse>
Données de réponse pour l’opération Share Get Statistics.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)
Définit les autorisations pour le partage spécifié. Les autorisations indiquent si les répertoires ou les fichiers d’un partage sont accessibles publiquement.
Lorsque vous définissez des autorisations pour un partage, les autorisations existantes sont remplacées. Si aucun shareAcl n’est fourni, la liste de contrôle d’accès de partage existante est supprimée.
Lorsque vous établissez une stratégie d’accès stockée sur un partage, cela peut prendre jusqu’à 30 secondes. Pendant cet intervalle, une signature d’accès partagé associée à la stratégie d’accès stockée échoue avec le code d’état 403 (Interdit), jusqu’à ce que la stratégie d’accès devienne active.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-acl
function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>Paramètres
- shareAcl
Tableau d’identificateurs signés, chacun ayant un ID unique et des détails de la stratégie d’accès.
- options
- ShareSetAccessPolicyOptions
Retours
Promise<ShareSetAccessPolicyResponse>
Données de réponse pour l’opération de stratégie d’accès de jeu de partage.
setMetadata(Metadata, ShareSetMetadataOptions)
Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le partage spécifié.
Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre d’option, les métadonnées de partage sont supprimées.
Voir https://learn.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>Paramètres
- metadata
- Metadata
Si aucune métadonnées n’est fournie, toutes les métadonnées de répertoire existantes sont supprimées.
- options
- ShareSetMetadataOptions
Retours
Promise<ShareSetMetadataResponse>
Données de réponse pour l’opération de métadonnées du jeu de partage.
setProperties(ShareSetPropertiesOptions)
Définit les propriétés du partage.
function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>Paramètres
- options
- ShareSetPropertiesOptions
Retours
Promise<ShareSetPropertiesResponse>
Données de réponse pour l’opération Propriétés du jeu de partages.
setQuota(number, ShareSetQuotaOptions)
Définit le quota pour le partage spécifié.
function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>Paramètres
- quotaInGB
-
number
Spécifie la taille maximale du partage en gigaoctets
- options
- ShareSetQuotaOptions
Retours
Promise<ShareSetQuotaResponse>
Données de réponse pour l’opération Share Get Quota.
withSnapshot(string)
Crée un objet ShareClient identique à la source, mais avec l’horodatage d’instantané spécifié. Indiquez « » supprime l’instantané et retourne une URL au partage de base.
function withSnapshot(snapshot: string): ShareClientParamètres
- snapshot
-
string
Horodatage d’instantané.
Retours
Nouvel objet ShareClient identique à la source, mais avec l’horodatage d’instantané spécifié