SASQueryParameters class

Référence

Paquet:: @azure/storage-file-share

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.

Constructeurs

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string)

Crée une instance de SASQueryParameters.

Propriétés

cacheControl	Valeur de l’en-tête de contrôle du cache dans Blob/File Service SAS.
contentDisposition	Valeur de l’en-tête de disposition de contenu dans Blob/File Service SAS.
contentEncoding	Valeur de l’en-tête d’encodage de contenu dans Blob/File Service SAS.
contentLanguage	Valeur de l’en-tête de longueur de contenu dans Blob/File Service SAS.
contentType	Valeur de l’en-tête de type de contenu dans Blob/File Service SAS.
expiresOn	Facultatif uniquement lorsque l’identificateur est fourni. Heure d’expiration de ce jeton SAP.
identifier	facultatif. Identificateur signé (uniquement pour FileSASSignatureValues). Voir https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	facultatif. Plage d’adresses IP autorisée pour cette SAP.
permissions	Facultatif uniquement lorsque l’identificateur est fourni. Pour plus d’informations, consultez AccountSASPermissions, FileSASPermissions ou ShareSASPermissions .
protocol	facultatif. Protocole(s) HTTP autorisé(s).
resource	facultatif. Le partage de stockage ou le chemin du fichier (uniquement pour FileSASSignatureValues).
resourceTypes	facultatif. Types de ressources de stockage auxquels vous accédez (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à AccountSASResourceTypes .
services	facultatif. Les services de stockage auxquels vous accédez (uniquement pour la SAP de compte). Pour plus d’informations, consultez AccountSASServices .
signature	Signature du jeton SAP.
startsOn	facultatif. Heure de début de ce jeton SAP.
version	Version de l’API de stockage.

Méthodes

toString()

Encode tous les paramètres de requête SAS dans une chaîne qui peut être ajoutée à une URL.

Détails du constructeur

Crée une instance de SASQueryParameters.

new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string)

Paramètres

version: string

Représentation de la version de stockage

signature: string

Représentation de la signature pour le jeton SAP

permissions: string

Représentation des autorisations de stockage

services: string

Représentant les services de stockage auxquels vous accédez (uniquement pour la SAP de compte)

resourceTypes: string

Représentant les types de ressources de stockage auxquels vous accédez (uniquement pour la SAP de compte)

protocol: SASProtocol

Représentant le ou les protocoles HTTP autorisés

startsOn: Date

Représentant l’heure de début de ce jeton SAP

expiresOn: Date

Représentant l’heure d’expiration de ce jeton SAP

ipRange: SasIPRange

Représentant la plage d’adresses IP valides pour ce jeton SAP

identifier: string

Représentant l’identificateur signé (uniquement pour service SAS)

resource: string

Représentant le conteneur de stockage ou l’objet blob (uniquement pour service SAS)

cacheControl: string

Représentant l’en-tête cache-control (uniquement pour blob/file service SAS)

contentDisposition: string

Représentant l’en-tête content-disposition (uniquement pour blob/file service SAS)

contentEncoding: string

Représentant l’en-tête d’encodage de contenu (uniquement pour blob/file service SAS)

contentLanguage: string

Représentant l’en-tête du langage de contenu (uniquement pour la sap d’objet blob/service de fichiers)

contentType: string

Représentant l’en-tête de type de contenu (uniquement pour blob/file service SAS)

Détails de la propriété

Valeur de l’en-tête de contrôle du cache dans Blob/File Service SAS.

cacheControl?: string

Valeur de propriété

string

Valeur de l’en-tête de disposition de contenu dans Blob/File Service SAS.

contentDisposition?: string

Valeur de propriété

string

Valeur de l’en-tête d’encodage de contenu dans Blob/File Service SAS.

contentEncoding?: string

Valeur de propriété

string

Valeur de l’en-tête de longueur de contenu dans Blob/File Service SAS.

contentLanguage?: string

Valeur de propriété

string

Valeur de l’en-tête de type de contenu dans Blob/File Service SAS.

contentType?: string

Valeur de propriété

string

Facultatif uniquement lorsque l’identificateur est fourni. Heure d’expiration de ce jeton SAP.

expiresOn?: Date

Valeur de propriété

Date

facultatif. Identificateur signé (uniquement pour FileSASSignatureValues).

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

Valeur de propriété

string

facultatif. Plage d’adresses IP autorisée pour cette SAP.

undefined | SasIPRange ipRange

Valeur de propriété

undefined | SasIPRange

Facultatif uniquement lorsque l’identificateur est fourni. Pour plus d’informations, consultez AccountSASPermissions, FileSASPermissions ou ShareSASPermissions .

permissions?: string

Valeur de propriété

string

facultatif. Protocole(s) HTTP autorisé(s).

protocol?: SASProtocol

Valeur de propriété

SASProtocol

facultatif. Le partage de stockage ou le chemin du fichier (uniquement pour FileSASSignatureValues).

resource?: string

Valeur de propriété

string

facultatif. Types de ressources de stockage auxquels vous accédez (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à AccountSASResourceTypes .

resourceTypes?: string

Valeur de propriété

string

facultatif. Les services de stockage auxquels vous accédez (uniquement pour la SAP de compte). Pour plus d’informations, consultez AccountSASServices .

services?: string

Valeur de propriété

string

Signature du jeton SAP.

signature: string

Valeur de propriété

string

facultatif. Heure de début de ce jeton SAP.

startsOn?: Date

Valeur de propriété

Date

Version de l’API de stockage.

version: string

Valeur de propriété

string

Détails de la méthode

Encode tous les paramètres de requête SAS dans une chaîne qui peut être ajoutée à une URL.

function toString(): string

Retours

string

Partager via

SASQueryParameters class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

Paramètres

Détails de la propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Valeur de propriété

Détails de la méthode

Retours

Ressources supplémentaires