Partager via

SharedAccessSignature class

  • Référence
Paquet:
azure-iot-common

Les jetons de signature d’accès partagé sont utilisés pour authentifier la connexion lors de l’utilisation de clés symétriques (par opposition aux certificats x509) pour sécuriser la connexion avec Azure IoT Hub.

Méthodes

create(string, string, string, string | number)

Instanciez un jeton SharedAccessSignature avec les paramètres donnés.
extend(number)

Étendez le sas et retournez la forme de chaîne de celui-ci.
parse(string, string[])

Instancier un jeton SharedAccessSignature à partir d’une chaîne.
toString()

Met en forme un objet SharedAccessSignatureObject dans une chaîne correctement mise en forme.

Détails de la méthode

create(string, string, string, string | number)

Instanciez un jeton SharedAccessSignature avec les paramètres donnés.

static function create(resourceUri: string, keyName: string, key: string, expiry: string | number): SharedAccessSignature

Paramètres

resourceUri

string

URI de ressource à encoder dans le jeton.

keyName

string

identificateur associé à la clé.

key

string

valeur de clé encodée en base64.

expiry

string | number

valeur entière représentant le nombre de secondes depuis l’époque 00:00:00 UTC au 1er janvier 1970.

Retours

SharedAccessSignature

Jeton de signature d’accès partagé.

extend(number)

Étendez le sas et retournez la forme de chaîne de celui-ci.

function extend(expiry: number): string

Paramètres

expiry

number

valeur entière représentant le nombre de secondes depuis l’époque 00:00:00 UTC au 1er janvier 1970.

Retours

string

Forme de chaîne de la signature d’accès partagé.

parse(string, string[])

Instancier un jeton SharedAccessSignature à partir d’une chaîne.

static function parse(source: string, requiredFields?: string[]): SharedAccessSignature

Paramètres

source

string

chaîne à analyser afin de créer le jeton SharedAccessSignature.

requiredFields

string[]

tableau de champs que nous nous attendons à trouver dans la chaîne source.

Retours

SharedAccessSignature

Jeton de signature d’accès partagé.

toString()

Met en forme un objet SharedAccessSignatureObject dans une chaîne correctement mise en forme.

function toString(): string

Retours

string

Jeton de signature d’accès partagé correctement mis en forme.