SharedAccessSignature class

Pakiet:

azure-iot-common

Tokeny sygnatury dostępu współdzielonego są używane do uwierzytelniania połączenia w przypadku używania kluczy symetrycznych (w przeciwieństwie do certyfikatów x509) w celu zabezpieczenia połączenia z centrum Azure IoT.

Metody

create(string, string, string, string | number)	Utwórz wystąpienie tokenu SharedAccessSignature z podanymi parametrami.
extend(number)	Rozszerz sygnaturę dostępu współdzielonego i zwróć jego postać ciągu.
parse(string, string[])	Utworzenie wystąpienia tokenu SharedAccessSignature z ciągu.
toString()	Formatuje obiekt SharedAccessSignatureObject w prawidłowo sformatowany ciąg.

Szczegóły metody

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

Utwórz wystąpienie tokenu SharedAccessSignature z podanymi parametrami.

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

Parametry

resourceUri

string

identyfikator URI zasobu do kodowania do tokenu.

keyName

string

identyfikator skojarzony z kluczem.

key

string

wartość klucza zakodowana w formacie Base64.

expiry

string | number

wartość całkowita reprezentująca liczbę sekund od epoki 00:00:00 UTC 1 stycznia 1970 r.

Zwraca

SharedAccessSignature

Token sygnatury dostępu współdzielonego.

extend(number)

Rozszerz sygnaturę dostępu współdzielonego i zwróć jego postać ciągu.

function extend(expiry: number): string

Parametry

expiry

number

wartość całkowita reprezentująca liczbę sekund od epoki 00:00:00 UTC 1 stycznia 1970 r.

Zwraca

string

Formularz ciągu sygnatury dostępu współdzielonego.

parse(string, string[])

Utworzenie wystąpienia tokenu SharedAccessSignature z ciągu.

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

Parametry

source

string

ciąg do analizy w celu utworzenia tokenu SharedAccessSignature.

requiredFields

string[]

tablica pól, które chcemy znaleźć w ciągu źródłowym.

Zwraca

SharedAccessSignature

Token sygnatury dostępu współdzielonego.

toString()

Formatuje obiekt SharedAccessSignatureObject w prawidłowo sformatowany ciąg.

function toString(): string

Zwraca

string

Poprawnie sformatowany token sygnatury dostępu współdzielonego.