SASQueryParameters class

Paquet:

@azure/storage-blob

Représente les composants qui composent les paramètres de requête d’azure Storage SAS. Ce type n’est pas construit directement par l’utilisateur ; elle est générée uniquement par les types <xref:AccountSASSignatureValues> et <xref:BlobSASSignatureValues>. Une fois généré, il peut être encodé dans un <xref:String> et ajouté directement à une URL (bien que la prudence soit 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, SASQueryParametersOptions)	Crée une instance de SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string)	Crée une instance de SASQueryParameters.

Propriétés

cacheControl	Valeur de l’en-tête de contrôle du cache dans la SAP Blob/File Service.
contentDisposition	Valeur de l’en-tête de disposition de contenu dans la SAP du service blob/fichier.
contentEncoding	Valeur de l’en-tête d’encodage de contenu dans la SAP du service blob/fichier.
contentLanguage	Valeur de l’en-tête de longueur de contenu dans la SAP du service d’objets blob/fichier.
contentType	Valeur de l’en-tête de type de contenu dans la SAP Blob/File Service.
correlationId	Valeur GUID qui sera journalisée dans les journaux de diagnostic de stockage et qui peut être utilisée pour mettre en corrélation la génération SAS avec l’accès aux ressources de stockage. Cela est utilisé uniquement pour la SAP de délégation d’utilisateur.
expiresOn	Facultatif uniquement lorsque l’identificateur est fourni. Heure d’expiration de ce jeton SAP.
identifier	Optionnel. Identificateur signé (uniquement pour <xref:BlobSASSignatureValues>).
ipRange	Optionnel. Plage d’adresses IP autorisée pour cette SAP.
permissions	Facultatif uniquement lorsque l’identificateur est fourni. Pour plus d’informations, reportez-vous à <xref:AccountSASPermissions>, <xref:BlobSASPermissions>ou <xref:ContainerSASPermissions>.
preauthorizedAgentObjectId	ID d’objet AAD autorisé au format GUID. ID d’objet AAD d’un utilisateur autorisé par le propriétaire de la clé de délégation d’utilisateur à effectuer l’action accordée par la SAP. Le service Stockage Azure garantit que le propriétaire de la clé de délégation d’utilisateur dispose des autorisations requises avant d’accorder l’accès, mais aucun contrôle d’autorisation supplémentaire pour l’utilisateur spécifié dans cette valeur sera effectué. Cela est utilisé uniquement pour la SAP de délégation d’utilisateur.
protocol	Optionnel. Protocole(s) HTTP autorisé(s).
resource	Optionnel. Spécifie les ressources accessibles via la SAP (uniquement pour <xref:BlobSASSignatureValues>).
resourceTypes	Optionnel. Types de ressources de stockage accessibles (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à <xref:AccountSASResourceTypes>.
services	Optionnel. Les services de stockage accessibles (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à <xref:AccountSASServices>.
signature	Signature du jeton SAP.
startsOn	Optionnel. 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 SAP dans une chaîne qui peut être ajoutée à une URL.

Détails du constructeur

SASQueryParameters(string, string, SASQueryParametersOptions)

Crée une instance de SASQueryParameters.

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Paramètres

version

string

Représentation de la version de stockage

signature

string

Représentant la signature du jeton SAP

options

SASQueryParametersOptions

Optionnel. Options de construction de SASQueryParameters.

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

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, userDelegationKey?: UserDelegationKey, preauthorizedAgentObjectId?: string, correlationId?: string)

Paramètres

version

string

Représentation de la version de stockage

signature

string

Représentant la signature du jeton SAP

permissions

string

Représentant les autorisations de stockage

services

string

Représentant les services de stockage accessibles (uniquement pour la SAP de compte)

resourceTypes

string

Représentant les types de ressources de stockage accessibles (uniquement pour la SAP de compte)

protocol

SASProtocol

Représentant 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 la SAP de service)

resource

string

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

cacheControl

string

Représentant l’en-tête de cache-contrôle (uniquement pour la SAP du service d’objets blob/de fichiers)

contentDisposition

string

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

contentEncoding

string

Représentant l’en-tête d’encodage de contenu (uniquement pour la SAP du service d’objets blob/de fichiers)

contentLanguage

string

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

contentType

string

Représentant l’en-tête de type de contenu (uniquement pour la SAP du service blob/fichier)

userDelegationKey

UserDelegationKey

Représentant les propriétés de clé de délégation d’utilisateur

preauthorizedAgentObjectId

string

Représentant l’ID d’objet AAD autorisé (uniquement pour la SAP de délégation d’utilisateur)

correlationId

string

Représentant l’ID de corrélation (uniquement pour la SAP de délégation d’utilisateur)

Détails de la propriété

cacheControl

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

cacheControl?: string

Valeur de propriété

string

contentDisposition

Valeur de l’en-tête de disposition de contenu dans la SAP du service blob/fichier.

contentDisposition?: string

Valeur de propriété

string

contentEncoding

Valeur de l’en-tête d’encodage de contenu dans la SAP du service blob/fichier.

contentEncoding?: string

Valeur de propriété

string

contentLanguage

Valeur de l’en-tête de longueur de contenu dans la SAP du service d’objets blob/fichier.

contentLanguage?: string

Valeur de propriété

string

contentType

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

contentType?: string

Valeur de propriété

string

correlationId

Valeur GUID qui sera journalisée dans les journaux de diagnostic de stockage et qui peut être utilisée pour mettre en corrélation la génération SAS avec l’accès aux ressources de stockage. Cela est utilisé uniquement pour la SAP de délégation d’utilisateur.

correlationId?: string

Valeur de propriété

string

expiresOn

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

expiresOn?: Date

Valeur de propriété

Date

identifier

Optionnel. Identificateur signé (uniquement pour <xref:BlobSASSignatureValues>).

identifier?: string

Valeur de propriété

string

ipRange

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

SasIPRange | undefined ipRange

Valeur de propriété

SasIPRange | undefined

permissions

Facultatif uniquement lorsque l’identificateur est fourni. Pour plus d’informations, reportez-vous à <xref:AccountSASPermissions>, <xref:BlobSASPermissions>ou <xref:ContainerSASPermissions>.

permissions?: string

Valeur de propriété

string

preauthorizedAgentObjectId

ID d’objet AAD autorisé au format GUID. ID d’objet AAD d’un utilisateur autorisé par le propriétaire de la clé de délégation d’utilisateur à effectuer l’action accordée par la SAP. Le service Stockage Azure garantit que le propriétaire de la clé de délégation d’utilisateur dispose des autorisations requises avant d’accorder l’accès, mais aucun contrôle d’autorisation supplémentaire pour l’utilisateur spécifié dans cette valeur sera effectué. Cela est utilisé uniquement pour la SAP de délégation d’utilisateur.

preauthorizedAgentObjectId?: string

Valeur de propriété

string

protocol

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

protocol?: SASProtocol

Valeur de propriété

SASProtocol

resource

Optionnel. Spécifie les ressources accessibles via la SAP (uniquement pour <xref:BlobSASSignatureValues>).

resource?: string

Valeur de propriété

string

resourceTypes

Optionnel. Types de ressources de stockage accessibles (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à <xref:AccountSASResourceTypes>.

resourceTypes?: string

Valeur de propriété

string

services

Optionnel. Les services de stockage accessibles (uniquement pour la SAP de compte). Pour plus d’informations, reportez-vous à <xref:AccountSASServices>.

services?: string

Valeur de propriété

string

signature

Signature du jeton SAP.

signature: string

Valeur de propriété

string

startsOn

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

startsOn?: Date

Valeur de propriété

Date

version

Version de l’API de stockage.

version: string

Valeur de propriété

string

Détails de la méthode

toString()

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

function toString()

Retours

string