ShareClient class

Crée une instance de ShareClient.

new ShareClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

Paramètres

Crée une instance de ShareClient.

new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Paramètres

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

Paramètres

Nom du partage

string name

Valeur de propriété

Obtient le client de répertoire 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 rootDirectoryClient

Valeur de propriété

accountName: string

Valeur de propriété

Hérité de StorageClient.accountName

Valeur de chaîne d’URL.

url: string

Valeur de propriété

Hérité de StorageClient.url

Crée un partage sous le compte spécifié. Si un partage portant le même nom existe déjà, l'opération échoue.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-share

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

Paramètres

Retours

Données de réponse pour l’opération Partager la création.

Crée un sous-répertoire sous ce partage.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Paramètres

Retours

Données de réponse de création d’annuaire et client d’annuaire correspondant.

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://docs.microsoft.com/en-us/rest/api/storageservices/create-file

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Paramètres

Retours

Données de réponse de création de fichier et le client de fichier correspondant.

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://docs.microsoft.com/en-us/rest/api/storageservices/create-share

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

Paramètres

Retours

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://docs.microsoft.com/en-us/rest/api/storageservices/create-permission

function createPermission(filePermission: string, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

Paramètres

Retours

Crée un instantané en lecture seule d’un partage.

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

Paramètres

Retours

Données de réponse pour l’opération Partager la création d’instantané.

Marque le partage spécifié pour suppression. Le partage et tous les répertoires ou fichiers qu’il contient sont supprimés ultérieurement pendant le garbage collection.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Paramètres

Retours

Données de réponse pour l’opération De suppression de partage.

Supprime le sous-répertoire vide spécifié sous ce partage. Le répertoire doit être vide pour que vous puissiez le supprimer.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Paramètres

Retours

Données de réponse à la suppression d’annuaire.

Supprime un fichier situé sous le répertoire racine de ce partage du compte de stockage. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire.

La suppression du fichier échoue avec le code d’état 409 (Conflit) et le code SharingViolation d’erreur si le fichier est ouvert sur un client SMB.

Supprimer un 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://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Paramètres

Retours

Fichier de promesse Supprimer les données de réponse.

Marque le partage spécifié pour suppression s’il existe. Le partage et tous les répertoires ou fichiers qu’il contient sont supprimés ultérieurement pendant le garbage collection.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

Paramètres

Retours

Retourne true si la ressource de partage Azrue représentée par ce client existe ; false dans le cas contraire.

REMARQUE : utilisez cette fonction avec précaution, 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

Retours

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é (SAS) de service en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Obtient les autorisations pour le partage spécifié. Les autorisations indiquent si les données de partage sont accessibles publiquement.

AVERTISSEMENT : JavaScript Date risque de perdre la précision lors de l’analyse des chaînes de début et d’expiration. Par exemple, new Date(« 2018-12-31T03:44:23.8827891Z »). toISOString() obtient « 2018-12-31T03:44:23.882Z ».

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

Paramètres

Retours

Données de réponse pour l’opération Partager la stratégie d’accès.

Crée un objet ShareDirectoryClient .

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Paramètres

Retours

Objet ShareDirectoryClient pour le nom de répertoire donné.

Obtient le langage SDDL (Security Descriptor Definition Language) pour une clé d’autorisation de fichier donnée qui indique un descripteur de sécurité.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

Paramètres

Retours

Retourne toutes les métadonnées et propriétés système définies par l’utilisateur pour le partage spécifié.

Voir https://docs.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 si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par la listShares méthode de ShareServiceClient à l’aide de l’option includeMetadata , qui conserve leur casse d’origine.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

Paramètres

Retours

Données de réponse pour l’opération Share Get Properties.

Récupère les statistiques liées au partage.

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

Paramètres

Retours

Données de réponse pour l’opération Partager obtenir des statistiques.

Définit les autorisations pour le partage spécifié. Les autorisations indiquent si les répertoires ou les fichiers d’un partage peuvent être accessibles publiquement.

Lorsque vous définissez des autorisations pour un partage, les autorisations existantes sont remplacées. Si aucun shareAcl n’est fourni, l’ACL de partage existante est supprimée.

Lorsque vous établissez une stratégie d’accès stocké sur un partage, l’application peut prendre jusqu’à 30 secondes. Au cours de 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://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

Paramètres

Retours

Données de réponse pour l’opération Share Set Access Policy.

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 si aucune métadonnées n’est définie dans le paramètre d’option, les métadonnées de partage sont supprimées.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

Paramètres

Retours

Données de réponse pour l’opération Partager les métadonnées.

Définit les propriétés du partage.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

Paramètres

Retours

Données de réponse pour l’opération Propriétés du jeu de partage.

Définit le quota pour le partage spécifié.

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

Paramètres

Retours

Données de réponse pour l’opération Share Get Quota.

Crée un objet ShareClient identique à la source, mais avec l’horodatage d’instantané spécifié. L’option « » supprime l’instantané et retourne une URL au partage de base.

function withSnapshot(snapshot: string): ShareClient

Paramètres

Retours

Nouvel objet ShareClient identique à la source, mais avec l’horodatage d’instantané spécifié