@azure/storage-file-share package

Référence

Classes

AccountSASPermissions	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
AccountSASResourceTypes	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les ressources accessibles par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera l’accès à ce type de ressource. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ de ressources sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne de ressources sans cette classe, mais l’ordre des ressources est particulier et cette classe garantit l’exactitude.
AccountSASServices	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les services accessibles par un AccountSAS. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera l’accès à ce service. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ services sur un objet AccountSASSignatureValues . Il est possible de construire la chaîne de services sans cette classe, mais l’ordre des services est particulier et cette classe garantit l’exactitude.
AnonymousCredential	AnonymousCredential fournit un membre credentialPolicyCreator utilisé pour créer des objets AnonymousCredentialPolicy. AnonymousCredentialPolicy est utilisé avec les requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
AnonymousCredentialPolicy	AnonymousCredentialPolicy est utilisé avec les requêtes HTTP(S) qui lisent des ressources publiques ou pour une utilisation avec des signatures d’accès partagé (SAP).
BaseRequestPolicy	Classe de base d’où dérivent toutes les stratégies de requête.
Credential	Les informations d’identification sont une classe abstraite pour la signature de requêtes HTTP de Stockage Azure. Cette classe hébergera une fabrique credentialPolicyCreator qui génère CredentialPolicy.
CredentialPolicy	Stratégie d’informations d’identification utilisée pour signer les requêtes HTTP(S) avant l’envoi. Il s’agit d’une classe abstraite.
FileSASPermissions	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un ServiceSAS à un fichier. Définir une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet FileSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
FileSystemAttributes	Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les attributs NTFS dans un fichier ou un répertoire. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/create-file#file-system-attributes
Pipeline	Classe Pipeline contenant des stratégies de requête HTTP. Vous pouvez créer un pipeline par défaut en appelant newPipeline. Vous pouvez également créer un pipeline avec vos propres stratégies par le constructeur de Pipeline. Reportez-vous à newPipeline et aux stratégies fournies avant d’implémenter votre pipeline personnalisé.
RestError	Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
SASQueryParameters	Représente les composants qui composent les paramètres de requête d’une sape de stockage Azure. Ce type n’est pas construit directement par l’utilisateur ; elle est générée uniquement par les types AccountSASSignatureValues et FileSASSignatureValues . Une fois généré, il peut être encodé dans un toString() et ajouté à une URL directement (même si la prudence doit être prise ici dans le cas où il existe des paramètres de requête existants, ce qui peut affecter les moyens appropriés d’ajouter ces paramètres de requête). REMARQUE : Les instances de cette classe sont immuables.
ShareClient	Un ShareClient représente une URL du partage Stockage Azure qui vous permet de manipuler ses répertoires et fichiers.
ShareDirectoryClient	Un ShareDirectoryClient représente une URL vers le répertoire Stockage Azure qui vous permet de manipuler ses fichiers et ses répertoires.
ShareFileClient	Un ShareFileClient représente une URL vers un fichier stockage Azure.
ShareLeaseClient	Client qui gère les baux d’un ShareFileClient ou d’un ShareClient. Voir https://docs.microsoft.com/rest/api/storageservices/lease-file et voir https://docs.microsoft.com/rest/api/storageservices/lease-share
ShareSASPermissions	Il s’agit d’une classe d’assistance permettant de construire une chaîne représentant les autorisations accordées par un ServiceSAS à un partage. La définition d’une valeur sur true signifie que toute SAP qui utilise ces autorisations accordera des autorisations pour cette opération. Une fois toutes les valeurs définies, celle-ci doit être sérialisée avec toString et définie comme champ d’autorisations sur un objet FileSASSignatureValues . Il est possible de construire la chaîne d’autorisations sans cette classe, mais l’ordre des autorisations est particulier et cette classe garantit l’exactitude.
ShareServiceClient	Un ShareServiceClient représente une URL vers le service de fichiers de stockage Azure qui vous permet de manipuler des partages de fichiers.
StorageBrowserPolicy	StorageBrowserPolicy gère les différences entre les Node.js et le runtime du navigateur, notamment : Les navigateurs mettez en cache les requêtes GET/HEAD en ajoutant des en-têtes conditionnels tels que « IF_MODIFIED_SINCE ». StorageBrowserPolicy est une stratégie utilisée pour ajouter une requête d’horodatage à l’URL de requête GET/HEAD afin d’éviter le cache du navigateur. Supprimer l’en-tête de cookie pour la sécurité Supprimer l’en-tête de longueur de contenu pour éviter l’avertissement des navigateurs
StorageBrowserPolicyFactory	StorageBrowserPolicyFactory est une classe d’usine qui permet de générer des objets StorageBrowserPolicy.
StorageRetryPolicy	Stratégie de nouvelle tentative avec nouvelle tentative exponentielle et nouvelle tentative linéaire implémentée.
StorageRetryPolicyFactory	StorageRetryPolicyFactory est une classe d’usine qui permet de générer des objets StorageRetryPolicy .
StorageSharedKeyCredential	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. StorageSharedKeyCredential pour l’autorisation de clé de compte du service Stockage Azure.
StorageSharedKeyCredentialPolicy	StorageSharedKeyCredentialPolicy est une stratégie utilisée pour signer une requête HTTP avec une clé partagée.

Interfaces

AccessPolicy	Une stratégie d’accès.
AccountSASSignatureValues	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. AccountSASSignatureValues est utilisé pour générer une signature d’accès partagé (SAP) pour un compte stockage Azure. Une fois que toutes les valeurs ici sont correctement définies, appelez generateAccountSASQueryParameters pour obtenir une représentation de la SAP qui peut en fait être appliquée aux URL de fichier. Remarque : cette classe et SASQueryParameters existent, car le premier est mutable et une représentation logique, tandis que le second est immuable et utilisé pour générer des requêtes REST réelles. Pour https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 plus d’informations conceptuelles sur saS, consultez pour https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas obtenir des descriptions des paramètres, notamment ceux qui sont requis.
ClearRange
CloseHandlesInfo	Close gère les informations de résultat.
CommonGenerateSasUrlOptions	Options courantes des options ShareGenerateSasUrlOptions et FileGenerateSasUrlOptions.
CommonOptions	Interface pour les options communes à chaque opération distante.
CopyFileSmbInfo	Groupe de paramètres
CorsRule	CORS est une fonctionnalité HTTP qui permet à une application web exécutée dans un domaine d'accéder aux ressources d'un autre domaine. Les navigateurs Web implémentent une restriction de sécurité appelée stratégie de même origine qui empêche une page Web d'appeler des API d'un autre domaine ; CORS constitue un moyen sûr pour autoriser un domaine (le domaine d'origine) à appeler des API d'un autre domaine.
DirectoryCloseHandlesHeaders	Valeurs d’en-tête de réponse supplémentaires pour la demande de handles de fermeture.
DirectoryCreateHeaders	Définit les en-têtes pour Directory_create opération.
DirectoryCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists(DirectoryCreateOptions) .
DirectoryCreateOptions	Options de configuration de l’opération de création .
DirectoryDeleteHeaders	Définit des en-têtes pour Directory_delete opération.
DirectoryDeleteIfExistsResponse	Contient des données de réponse pour l’opération deleteIfExists(DirectoryDeleteOptions) .
DirectoryDeleteOptions	Options permettant de configurer l’opération de suppression .
DirectoryExistsOptions	Options permettant de configurer l’opération exists .
DirectoryForceCloseHandlesHeaders	Définit des en-têtes pour Directory_forceCloseHandles opération.
DirectoryForceCloseHandlesOptions	Options pour configurer forceCloseHandle.
DirectoryForceCloseHandlesSegmentOptions	Options de configuration du répertoire - Forcer la fermeture des opérations de segment de handles. Consultez l'article : <xref:ShareDirectoryClient.forceCloseHandlesSegment> forceCloseAllHandles
DirectoryGetPropertiesHeaders	Définit des en-têtes pour Directory_getProperties opération.
DirectoryGetPropertiesOptions	Options permettant de configurer l’opération getProperties .
DirectoryItem	Élément de répertoire répertorié.
DirectoryListFilesAndDirectoriesOptions	Options permettant de configurer l’opération listFilesAndDirectories .
DirectoryListFilesAndDirectoriesSegmentHeaders	Définit des en-têtes pour Directory_listFilesAndDirectoriesSegment opération.
DirectoryListHandlesHeaders	Définit des en-têtes pour Directory_listHandles opération.
DirectoryListHandlesOptions	Options permettant de configurer l’opération listHandles .
DirectoryListHandlesSegmentOptions	Options de configuration des opérations de segment Répertoire - Handles de liste. Consultez l'article : <xref:ShareDirectoryClient.listHandlesSegment> <xref:ShareDirectoryClient.iterateHandleSegments> <xref:ShareDirectoryClient.listHandleItems>
DirectoryProperties	Interface pour les options communes à chaque opération distante.
DirectoryRenameHeaders	Définit des en-têtes pour Directory_rename opération.
DirectoryRenameOptions	Options permettant de configurer l’opération de renommage .
DirectorySetMetadataHeaders	Définit les en-têtes pour Directory_setMetadata opération.
DirectorySetMetadataOptions	Options permettant de configurer l’opération setMetadata .
DirectorySetPropertiesHeaders	Définit des en-têtes pour Directory_setProperties opération.
FileAbortCopyFromURLOptions	Options permettant de configurer l’opération abortCopyFromURL .
FileAbortCopyHeaders	Définit des en-têtes pour File_abortCopy opération.
FileAndDirectoryCreateCommonOptions
FileAndDirectorySetPropertiesCommonOptions
FileClearRangeOptions	Options permettant de configurer l’opération clearRange .
FileCloseHandlesHeaders	Valeurs d’en-tête de réponse supplémentaires pour la demande de handles de fermeture.
FileCreateHeaders	Définit des en-têtes pour File_create opération.
FileCreateOptions	Options permettant de configurer l’opération de création .
FileDeleteHeaders	Définit des en-têtes pour File_delete opération.
FileDeleteIfExistsResponse	Contient des données de réponse pour l’opération deleteIfExists .
FileDeleteOptions	Options permettant de configurer l’opération de suppression .
FileDownloadHeaders	Définit des en-têtes pour File_download opération.
FileDownloadOptionalParams	Paramètres facultatifs.
FileDownloadOptions	Options de configuration du fichier - Opérations de téléchargement. Consultez l'article : téléchargement downloadToFile
FileDownloadToBufferOptions	Interface d’option pour l’opération downloadToBuffer .
FileExistsOptions	Options pour configurer l’opération exists .
FileForceCloseHandlesHeaders	Définit des en-têtes pour File_forceCloseHandles opération.
FileForceCloseHandlesOptions	Options de configuration du fichier - Forcer les opérations de fermeture des handles. Consultez l'article : <xref:ShareFileClient.forceCloseHandlesSegment> forceCloseAllHandles forceCloseHandle
FileGenerateSasUrlOptions	Options pour configurer l’opération generateSasUrl .
FileGetPropertiesHeaders	Définit des en-têtes pour File_getProperties opération.
FileGetPropertiesOptions	Options pour configurer l’opération getProperties .
FileGetRangeListHeaders	Définit des en-têtes pour File_getRangeList opération.
FileGetRangeListOptions	Options pour configurer l’opération getRangeList .
FileHttpHeaders
FileItem	Élément de fichier répertorié.
FileListHandlesHeaders	Définit des en-têtes pour File_listHandles opération.
FileListHandlesOptions	Interface pour les options communes à chaque opération à distance.
FileListHandlesSegmentOptions	Options de configuration des opérations de segment de fichier - Gestions de liste. Consultez l'article : <xref:ShareFileClient.listHandlesSegment> <xref:ShareFileClient.iterateHandleSegments> <xref:ShareFileClient.listHandleItems>
FileParallelUploadOptions	Interface d’option pour fichier - Opérations de chargement Consultez l'article : uploadFile <xref:ShareFileClient.uploadSeekableStream>
FileProperties	Interface pour les options communes à chaque opération à distance.
FileProperty	Propriétés du fichier.
FileRenameHeaders	Définit des en-têtes pour File_rename opération.
FileRenameOptions	Options pour configurer l’opération de renommage .
FileResizeOptions	Options pour configurer l’opération de redimensionnement .
FileSASSignatureValues	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. FileSASSignatureValues est utilisé pour aider à générer des jetons SAP du service de fichiers pour les partages ou les fichiers.
FileServiceProperties	Propriétés du service de stockage.
FileSetHTTPHeadersHeaders	Définit des en-têtes pour File_setHttpHeaders opération.
FileSetHttpHeadersOptions	Options pour configurer l’opération setHttpHeaders .
FileSetMetadataHeaders	Définit des en-têtes pour File_setMetadata opération.
FileSetMetadataOptions	Options pour configurer l’opération setMetadata .
FileStartCopyHeaders	Définit des en-têtes pour File_startCopy opération.
FileStartCopyOptions	Options permettant de configurer l’opération startCopyFromURL .
FileUploadRangeFromURLHeaders	Définit des en-têtes pour File_uploadRangeFromURL opération.
FileUploadRangeFromURLOptionalParams	Paramètres facultatifs.
FileUploadRangeFromURLOptions	Options permettant de configurer l’opération uploadRangeFromURL .
FileUploadRangeHeaders	Définit des en-têtes pour File_uploadRange opération.
FileUploadRangeOptions	Options permettant de configurer l’opération uploadRange .
FileUploadStreamOptions	Interface d’option pour ShareFileClient.uploadStream().
FilesAndDirectoriesListSegment	Résumé pour les entrées qui peuvent être répertoriées à partir du répertoire.
HandleItem	Élément de handle stockage Azure répertorié.
HttpAuthorization	Représente les informations d’authentification dans les valeurs d’en-tête Authorization, ProxyAuthorization, WWW-Authenticate et Proxy-Authenticate.
HttpHeaders	Collection de paires clé/valeur d’en-tête HTTP.
HttpOperationResponse	Réponse HTTP compatible avec core-v1(core-http).
HttpResponse	Représentation d’une réponse HTTP qui inclut une référence à la requête à l’origine de celle-ci.
IHttpClient	Interface compatible pour les stratégies de requête core-http
LeaseAccessConditions	Groupe de paramètres
LeaseOperationOptions	options d’opérations de bail.
LeaseOperationResponseHeaders	Détails de la réponse pour une opération de bail spécifique.
ListFilesAndDirectoriesSegmentResponse	Énumération de répertoires et de fichiers.
ListHandlesResponse	Énumération de handles.
ListSharesResponse	Énumération de partages.
ListSharesResponseModel	Énumération de partages.
Metadata
Metrics	Métriques Storage Analytics pour le service de fichiers.
PipelineLike	Interface pour la classe Pipeline contenant des stratégies de requête HTTP. Vous pouvez créer un pipeline par défaut en appelant newPipeline. Vous pouvez également créer un pipeline avec vos propres stratégies par le constructeur de Pipeline. Reportez-vous à newPipeline et aux stratégies fournies avant d’implémenter votre pipeline personnalisé.
PipelineOptions	Interface d’option pour le constructeur pipeline.
Range	Plage pour les opérations de service. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-file-service-operations
RangeModel	Une plage de fichiers stockage Azure.
RequestPolicyFactory	Interface de compatibilité avec RequestPolicyFactory de core-http
RequestPolicyOptions	Interface de compatibilité avec RequestPolicy
ResponseLike	Objet avec une propriété _response simple.
ResponseWithBody	Objet avec une propriété _response dont le corps et les en-têtes sont déjà analysés en types connus.
ResponseWithHeaders	Objet avec une propriété _response dont les en-têtes sont déjà analysés dans un objet typé.
RetentionPolicy	Stratégie de rétention.
SasIPRange	Plage d’adresses IP autorisée pour une SAP.
ServiceClientOptions	Sous-ensemble de `@azure/core-http` ServiceClientOptions
ServiceGenerateAccountSasUrlOptions	Options permettant de configurer l’opération generateAccountSasUrl .
ServiceGetPropertiesHeaders	Définit des en-têtes pour Service_getProperties opération.
ServiceGetPropertiesOptions	Options permettant de configurer l’opération getProperties .
ServiceListSharesOptions	Options permettant de configurer l’opération listShares .
ServiceListSharesSegmentHeaders	Définit des en-têtes pour Service_listSharesSegment opération.
ServiceSetPropertiesHeaders	Définit des en-têtes pour Service_setProperties opération.
ServiceSetPropertiesOptions	Options permettant de configurer l’opération setProperties .
ServiceUndeleteShareOptions	Options pour configurer l’opération <xref:ShareServiceClient.undelete> .
SetPropertiesResponse	Contient des données de réponse pour l’opération setHttpHeaders.
ShareClientConfig
ShareCreateHeaders	Définit des en-têtes pour Share_create opération.
ShareCreateIfNotExistsResponse	Contient des données de réponse pour l’opération createIfNotExists .
ShareCreateOptions	Options permettant de configurer l’opération de création .
ShareCreatePermissionHeaders	Définit des en-têtes pour Share_createPermission opération.
ShareCreatePermissionOptions	Options permettant de configurer l’opération createPermission .
ShareCreateSnapshotHeaders	Définit des en-têtes pour Share_createSnapshot opération.
ShareCreateSnapshotOptions	Options permettant de configurer l’opération createSnapshot .
ShareDeleteHeaders	Définit des en-têtes pour Share_delete opération.
ShareDeleteIfExistsResponse	Contient des données de réponse pour l’opération deleteIfExists .
ShareDeleteMethodOptions	Options permettant de configurer l’opération de suppression .
ShareExistsOptions	Options permettant de configurer l’opération exists .
ShareFileRangeList	Liste des plages de fichiers
ShareGenerateSasUrlOptions	Options pour configurer l’opération generateSasUrl .
ShareGetAccessPolicyHeaders	Définit les en-têtes pour Share_getAccessPolicy opération.
ShareGetAccessPolicyOptions	Options permettant de configurer l’opération getAccessPolicy .
ShareGetPermissionHeaders	Définit des en-têtes pour Share_getPermission opération.
ShareGetPermissionOptions	Options permettant de configurer l’opération getPermission .
ShareGetPropertiesHeaders	Définit des en-têtes pour Share_getProperties opération.
ShareGetPropertiesOptions	Options permettant de configurer l’opération getProperties .
ShareGetStatisticsHeaders	Définit des en-têtes pour Share_getStatistics opération.
ShareGetStatisticsOptions	Options permettant de configurer l’opération getStatistics .
ShareItem	Élément de partage Stockage Azure répertorié.
ShareItemInternal	Élément de partage Stockage Azure répertorié.
SharePermission	Autorisation (descripteur de sécurité) au niveau du partage.
SharePropertiesInternal	Propriétés d’un partage.
ShareProtocolSettings	paramètres de protocole
ShareProtocols	Protocoles à activer sur le partage. Pour l’instant, prend uniquement en charge SMB ou NFS.
ShareSetAccessPolicyHeaders	Définit des en-têtes pour Share_setAccessPolicy opération.
ShareSetAccessPolicyOptions	Options permettant de configurer l’opération setAccessPolicy .
ShareSetMetadataHeaders	Définit des en-têtes pour Share_setMetadata opération.
ShareSetMetadataOptions	Options permettant de configurer l’opération setMetadata .
ShareSetPropertiesHeaders	Définit des en-têtes pour Share_setProperties opération.
ShareSetPropertiesOptions	Options permettant de configurer l’opération setProperties .
ShareSetQuotaOptions	Options permettant de configurer l’opération setQuota .
ShareSmbSettings	Paramètres du protocole SMB.
ShareStats	Statistiques pour le partage.
SignedIdentifier	Identificateur signé
SignedIdentifierModel	Identificateur signé.
SmbMultichannel	Paramètres pour SMB multicanal
SourceModifiedAccessConditions	Groupe de paramètres
StoragePipelineOptions	Interface d’options pour la fonction newPipeline .
StorageRetryOptions	Interface des options de nouvelle tentative d’objet blob de stockage.
WebResource	Description d’une requête HTTP à envoyer à un serveur distant.

Alias de type

CopyStatusType	Définit des valeurs pour CopyStatusType.
CredentialPolicyCreator	Fonction de fabrique qui crée une nouvelle CredentialPolicy qui utilise la nextPolicy fournie.
DeleteSnapshotsOptionType	Définit des valeurs pour DeleteSnapshotsOptionType.
DirectoryCreateResponse	Contient des données de réponse pour l’opération de création.
DirectoryDeleteResponse	Contient des données de réponse pour l’opération de suppression.
DirectoryForceCloseHandlesResponse	Type de réponse pour forceCloseHandle.
DirectoryGetPropertiesResponse	Contient des données de réponse pour l’opération getProperties.
DirectoryListFilesAndDirectoriesSegmentResponse	Contient des données de réponse pour l’opération listFilesAndDirectoriesSegment.
DirectoryListHandlesResponse	Contient des données de réponse pour l’opération listHandles.
DirectoryRenameResponse	Contient des données de réponse pour l’opération de renommage.
DirectorySetMetadataResponse	Contient des données de réponse pour l’opération setMetadata.
DirectorySetPropertiesResponse	Contient des données de réponse pour l’opération setProperties.
FileAbortCopyResponse	Contient des données de réponse pour l’opération abortCopy.
FileAttributesPreserveType	Indique que les attributs de fichier existants restent inchangés.
FileCreateResponse	Contient des données de réponse pour l’opération de création.
FileDeleteResponse	Contient des données de réponse pour l’opération de suppression.
FileDownloadResponseModel	Contient des données de réponse pour l’opération de téléchargement.
FileForceCloseHandlesResponse	Type de réponse pour forceCloseHandle.
FileGetPropertiesResponse	Contient des données de réponse pour l’opération getProperties.
FileGetRangeListDiffResponse	Contient des données de réponse pour l’opération getRangeList.
FileGetRangeListResponse	Contient des données de réponse pour l’opération getRangeList .
FileLastWrittenMode	Définit les valeurs de FileLastWrittenMode.
FileListHandlesResponse	Contient des données de réponse pour l’opération listHandles.
FilePermissionInheritType	Indique d’hériter de l’autorisation de fichier du répertoire parent.
FilePermissionPreserveType	Indique que la valeur d’autorisation de fichier existante reste inchangée.
FileRenameResponse	Contient des données de réponse pour l’opération de renommage.
FileSetHTTPHeadersResponse	Contient des données de réponse pour l’opération setHttpHeaders.
FileSetMetadataResponse	Contient des données de réponse pour l’opération setMetadata.
FileStartCopyResponse	Contient des données de réponse pour l’opération startCopy.
FileUploadRangeFromURLResponse	Contient des données de réponse pour l’opération uploadRangeFromURL.
FileUploadRangeResponse	Contient des données de réponse pour l’opération uploadRange.
HttpRequestBody	Types de corps pris en charge sur la demande. NodeJS.ReadableStream et () => NodeJS.ReadableStream est Node uniquement. Blob, ReadableStream et () => ReadableStream sont des navigateurs uniquement.
LeaseDurationType	Définit les valeurs de LeaseDurationType.
LeaseOperationResponse	Contient les données de réponse pour les opérations qui acquièrent, modifient, interrompent ou libèrent un bail. Consultez ShareLeaseClient.
LeaseStateType	Définit les valeurs de LeaseStateType.
LeaseStatusType	Définit les valeurs de LeaseStatusType.
ListSharesIncludeType	Définit des valeurs pour ListSharesIncludeType.
PermissionCopyModeType	Définit des valeurs pour PermissionCopyModeType.
RawFileDownloadResponse	Contient des données de réponse pour l’opération de téléchargement.
ServiceGetPropertiesResponse	Contient des données de réponse pour l’opération getProperties.
ServiceListSharesSegmentResponse	Contient des données de réponse pour l’opération listShares .
ServiceSetPropertiesResponse	Contient des données de réponse pour l’opération setProperties.
ShareAccessTier	Définit des valeurs pour ShareAccessTier.
ShareClientOptions
ShareCreatePermissionResponse	Contient des données de réponse pour l’opération createPermission.
ShareCreateResponse	Contient des données de réponse pour l’opération de création.
ShareCreateSnapshotResponse	Contient des données de réponse pour l’opération createSnapshot.
ShareDeleteResponse	Contient des données de réponse pour l’opération de suppression.
ShareFileHandleAccessRights	Définit des valeurs pour AccessRight.
ShareGetAccessPolicyResponse
ShareGetPermissionResponse	Contient des données de réponse pour l’opération getPermission.
ShareGetPropertiesResponse	Contient des données de réponse pour l’opération getProperties .
ShareGetPropertiesResponseModel	Contient des données de réponse pour l’opération getProperties.
ShareGetStatisticsResponse	Données de réponse pour l’opération getStatistics .
ShareGetStatisticsResponseModel	Contient des données de réponse pour l’opération getStatistics.
ShareProperties	Propriétés d’un partage.
ShareRootSquash	Définit des valeurs pour ShareRootSquash.
ShareSetAccessPolicyResponse	Contient des données de réponse pour l’opération setAccessPolicy.
ShareSetMetadataResponse	Contient des données de réponse pour l’opération setMetadata.
ShareSetPropertiesResponse	Contient des données de réponse pour l’opération setProperties.
ShareSetQuotaHeaders	Définit des en-têtes pour l’opération setQuota.
ShareSetQuotaResponse	Contient des données de réponse pour l’opération setQuota.
ShareTokenIntent	Définit des valeurs pour ShareTokenIntent. KnownShareTokenIntent peut être utilisé de manière interchangeable avec ShareTokenIntent. Cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service backup
TimeNowType	Indique le paramètre comme heure de la demande.
TimePreserveType	Indique que la valeur d’heure existante reste inchangée.
WithResponse	Type qui représente un résultat d’opération avec une propriété _response connue.

Énumérations

KnownShareTokenIntent	Valeurs connues de ShareTokenIntent que le service accepte.
SASProtocol	Protocoles pour la signature d’accès partagé généré.
StorageFileAudience	Définit les audiences cloud connues pour le stockage.
StorageRetryPolicyType	Types RetryPolicy.

Fonctions

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Génère un objet SASQueryParameters qui contient tous les paramètres de requête SAS nécessaires pour effectuer une requête REST réelle. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Crée une instance de SASQueryParameters. Accepte uniquement les paramètres requis pour créer une sap. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et l’identificateur. AVERTISSEMENT : Lorsque l’identificateur n’est pas fourni, les autorisations et expirentOn sont requises. Vous DEVEZ affecter une valeur à l’identificateur ou expireOn & autorisations manuellement si vous initialisez avec ce constructeur.
getFileServiceAccountAudience(string)	Pour obtenir l’audience OAuth pour un compte de stockage pour le service de fichiers.
isPipelineLike(unknown)	Un outil d’assistance pour déterminer si un argument donné satisfait au contrat de pipeline
newPipeline(Credential_2 \| TokenCredential, StoragePipelineOptions)	Crée un objet Pipeline avec les informations d’identification fournies.

Informations relatives à la fonction

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Génère un objet SASQueryParameters qui contient tous les paramètres de requête SAS nécessaires pour effectuer une requête REST réelle.

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paramètres

accountSASSignatureValues: AccountSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retours

SASQueryParameters

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Crée une instance de SASQueryParameters.

Accepte uniquement les paramètres requis pour créer une sap. Pour les paramètres facultatifs, définissez directement les propriétés correspondantes, telles que les autorisations, startsOn et l’identificateur.

AVERTISSEMENT : Lorsque l’identificateur n’est pas fourni, les autorisations et expirentOn sont requises. Vous DEVEZ affecter une valeur à l’identificateur ou expireOn & autorisations manuellement si vous initialisez avec ce constructeur.

function generateFileSASQueryParameters(fileSASSignatureValues: FileSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

Paramètres

fileSASSignatureValues: FileSASSignatureValues

sharedKeyCredential: StorageSharedKeyCredential

Retours

SASQueryParameters

Pour obtenir l’audience OAuth pour un compte de stockage pour le service de fichiers.

function getFileServiceAccountAudience(storageAccountName: string): string

Paramètres

storageAccountName: string

Retours

string

Un outil d’assistance pour déterminer si un argument donné satisfait au contrat de pipeline

function isPipelineLike(pipeline: unknown): pipeline

Paramètres

pipeline: unknown

Argument qui peut être un pipeline

Retours

pipeline

true lorsque l’argument satisfait au contrat de pipeline

Crée un objet Pipeline avec les informations d’identification fournies.

function newPipeline(credential?: Credential_2 | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

Paramètres

credential: Credential | TokenCredential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package pour authentifier les @azure/identity demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

pipelineOptions: StoragePipelineOptions

facultatif. Options.

Retours

Pipeline

Nouvel objet Pipeline.

Partager via

@azure/storage-file-share package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Énumérations

Fonctions

Informations relatives à la fonction

Paramètres

Retours

Paramètres

Retours

Paramètres

Retours

Paramètres

Retours

Paramètres

Retours

Ressources supplémentaires

Partager via

@azure/storage-file-share package

Classes

Interfaces

Alias de type

Valeurs connues prises en charge par le service

Énumérations

Fonctions

Informations relatives à la fonction

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

Paramètres

Retours

generateFileSASQueryParameters(FileSASSignatureValues, StorageSharedKeyCredential)

Paramètres

Retours

getFileServiceAccountAudience(string)

Paramètres

Retours

isPipelineLike(unknown)

Paramètres

Retours

newPipeline(Credential_2 | TokenCredential, StoragePipelineOptions)

Paramètres

Retours

Ressources supplémentaires