Partager via

SASQueryParameters class

  • Référence
Paquet:
@azure/storage-file-datalake

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.<xref:BlobSASSignatureValues> Une fois généré, il peut être encodé en un toString() et ajouté directement à une URL (bien qu’il soit prudent ici au 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, number, string, string, string, string)

Crée une instance de SASQueryParameters.

Propriétés

agentObjectId

ID d’objet AAD non autorisé au format GUID. ID d’objet AAD d’un utilisateur qui est supposé être non autorisé par le propriétaire de la clé de délégation d’utilisateur. Le service stockage Azure effectue une vérification supplémentaire de la liste de contrôle d’accès POSIX pour déterminer si l’utilisateur est autorisé à effectuer l’opération demandée. Cela ne peut pas être utilisé dans la conjuction avec <xref:signedAuthorizedUserObjectId>. Il est utilisé uniquement pour la sape de délégation d’utilisateur.
cacheControl

Valeur de l’en-tête de contrôle de cache dans blob/service de fichiers SAP.
contentDisposition

Valeur de l’en-tête content-disposition dans la SAP d’objet blob/service de fichiers.
contentEncoding

Valeur de l’en-tête d’encodage de contenu dans la sape d’objet blob/service de fichiers.
contentLanguage

Valeur de l’en-tête de longueur de contenu dans blob/service de fichiers SAP.
contentType

Valeur de l’en-tête content-type dans blob/service de fichiers SAP.
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. Il est utilisé uniquement pour la sape de délégation d’utilisateur.
directoryDepth

Indiquez la profondeur du répertoire spécifié dans le champ canonicalizedresource du string-to-sign. La profondeur du répertoire correspond au nombre de répertoires situés sous le dossier racine.
encryptionScope

facultatif. Étendue de chiffrement à utiliser lors de l’envoi de requêtes autorisées avec cet URI SAS.
expiresOn

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

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

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, reportez-vous à 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 signature d’accès partagé. Le service Stockage Azure s’assure que le propriétaire de la clé de délégation utilisateur dispose des autorisations requises avant d’accorder l’accès, mais aucune vérification d’autorisation supplémentaire pour l’utilisateur spécifié dans cette valeur n’est effectuée. Cela ne peut pas être utilisé dans la conjuction avec <xref:signedUnauthorizedUserObjectId>. Il est utilisé uniquement pour la sape de délégation d’utilisateur.
protocol

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

facultatif. Spécifie les ressources accessibles via la signature d’accès partagé (uniquement pour <xref:BlobSASSignatureValues>).

Voir https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
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. Services de stockage auxquels vous accédez (uniquement pour la SAP de compte). Pour plus d’informations, consultez AccountSASServices .
signature

Signature du jeton SAS.
startsOn

facultatif. Heure de début de ce jeton SAS.
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

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ésentation de la signature pour le jeton SAP

options
SASQueryParametersOptions

facultatif. Options de construction de SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, 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, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: string, correlationId?: string, encryptionScope?: 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ésentation des services de stockage auxquels vous accédez (uniquement pour la SAP de compte)

resourceTypes

string

Représentation des 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 SAS

expiresOn

Date

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

ipRange
SasIPRange

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

identifier

string

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

resource

string

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

cacheControl

string

Représentation de l’en-tête cache-control (uniquement pour blob/service de fichiers SAP)

contentDisposition

string

Représentation de l’en-tête content-disposition (uniquement pour la SAP d’objet blob/service de fichiers)

contentEncoding

string

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

contentLanguage

string

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

contentType

string

Représentation de l’en-tête content-type (uniquement pour blob/service de fichiers SAP)

userDelegationKey
UserDelegationKey

Représentation des propriétés de clé de délégation utilisateur

directoryDepth

number

preauthorizedAgentObjectId

string

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

agentObjectId

string

Représentant l’ID d’objet AAD non 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)

encryptionScope

string

Détails de la propriété

agentObjectId

ID d’objet AAD non autorisé au format GUID. ID d’objet AAD d’un utilisateur qui est supposé être non autorisé par le propriétaire de la clé de délégation d’utilisateur. Le service stockage Azure effectue une vérification supplémentaire de la liste de contrôle d’accès POSIX pour déterminer si l’utilisateur est autorisé à effectuer l’opération demandée. Cela ne peut pas être utilisé dans la conjuction avec <xref:signedAuthorizedUserObjectId>. Il est utilisé uniquement pour la sape de délégation d’utilisateur.

agentObjectId?: string

Valeur de propriété

string

cacheControl

Valeur de l’en-tête de contrôle de cache dans blob/service de fichiers SAP.

cacheControl?: string

Valeur de propriété

string

contentDisposition

Valeur de l’en-tête content-disposition dans la SAP d’objet blob/service de fichiers.

contentDisposition?: string

Valeur de propriété

string

contentEncoding

Valeur de l’en-tête d’encodage de contenu dans la sape d’objet blob/service de fichiers.

contentEncoding?: string

Valeur de propriété

string

contentLanguage

Valeur de l’en-tête de longueur de contenu dans blob/service de fichiers SAP.

contentLanguage?: string

Valeur de propriété

string

contentType

Valeur de l’en-tête content-type dans blob/service de fichiers SAP.

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. Il est utilisé uniquement pour la sape de délégation d’utilisateur.

correlationId?: string

Valeur de propriété

string

directoryDepth

Indiquez la profondeur du répertoire spécifié dans le champ canonicalizedresource du string-to-sign. La profondeur du répertoire correspond au nombre de répertoires situés sous le dossier racine.

directoryDepth?: number

Valeur de propriété

number

encryptionScope

facultatif. Étendue de chiffrement à utiliser lors de l’envoi de requêtes autorisées avec cet URI SAS.

encryptionScope?: string

Valeur de propriété

string

expiresOn

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

expiresOn?: Date

Valeur de propriété

Date

identifier

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

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

identifier?: string

Valeur de propriété

string

ipRange

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

undefined | SasIPRange ipRange

Valeur de propriété

undefined | SasIPRange

permissions

Facultatif uniquement lorsque l’identificateur est fourni. Pour plus d’informations, reportez-vous à 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 signature d’accès partagé. Le service Stockage Azure s’assure que le propriétaire de la clé de délégation utilisateur dispose des autorisations requises avant d’accorder l’accès, mais aucune vérification d’autorisation supplémentaire pour l’utilisateur spécifié dans cette valeur n’est effectuée. Cela ne peut pas être utilisé dans la conjuction avec <xref:signedUnauthorizedUserObjectId>. Il est utilisé uniquement pour la sape de délégation d’utilisateur.

preauthorizedAgentObjectId?: string

Valeur de propriété

string

protocol

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

protocol?: SASProtocol

Valeur de propriété

SASProtocol

resource

facultatif. Spécifie les ressources accessibles via la signature d’accès partagé (uniquement pour <xref:BlobSASSignatureValues>).

Voir https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

Valeur de propriété

string

resourceTypes

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

services

facultatif. 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

Signature du jeton SAS.

signature: string

Valeur de propriété

string

startsOn

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

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 SAS dans une chaîne qui peut être ajoutée à une URL.

function toString(): string

Retours

string