SharedAccessSignature class

パッケージ:

azure-iot-common

共有アクセス署名トークンは、(x509 証明書ではなく) 対称キーを使用して Azure IoT ハブとの接続をセキュリティで保護するときに、接続を認証するために使用されます。

メソッド

create(string, string, string, string | number)	指定されたパラメーターを使用して SharedAccessSignature トークンをインスタンス化します。
extend(number)	Sas を拡張し、その文字列形式を返します。
parse(string, string[])	文字列から SharedAccessSignature トークンをインスタンス化します。
toString()	SharedAccessSignatureObject を適切に書式設定された文字列に書式設定します。

メソッドの詳細

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

指定されたパラメーターを使用して SharedAccessSignature トークンをインスタンス化します。

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

パラメーター

resourceUri

string

トークンにエンコードするリソース URI。

keyName

string

キーに関連付けられている識別子。

key

string

base64 でエンコードされたキー値。

expiry

string | number

1970 年 1 月 1 日のエポック 00:00:00 UTC からの秒数を表す整数値。

戻り値

SharedAccessSignature

共有アクセス署名トークン。

extend(number)

Sas を拡張し、その文字列形式を返します。

function extend(expiry: number): string

パラメーター

expiry

number

1970 年 1 月 1 日のエポック 00:00:00 UTC からの秒数を表す整数値。

戻り値

string

共有アクセス署名の文字列形式。

parse(string, string[])

文字列から SharedAccessSignature トークンをインスタンス化します。

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

パラメーター

source

string

SharedAccessSignature トークンを作成するために解析する文字列。

requiredFields

string[]

ソース文字列で検索するフィールドの配列。

戻り値

SharedAccessSignature

共有アクセス署名トークン。

toString()

SharedAccessSignatureObject を適切に書式設定された文字列に書式設定します。

function toString(): string

戻り値

string

適切に書式設定された共有アクセス署名トークン。