你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
SharedAccessSignature class
使用对称密钥(而不是 x509 证书)来保护与 Azure IoT 中心的连接时,使用共享访问签名令牌对连接进行身份验证。
方法
create(string, string, string, string | number) | 使用给定参数实例化 SharedAccessSignature 令牌。 |
extend(number) | 扩展 Sas 并返回它的字符串形式。 |
parse(string, string[]) | 从字符串实例化 SharedAccessSignature 令牌。 |
to |
将 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 以来的秒数。
返回
共享访问签名令牌。
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[]
我们希望在源字符串中找到的字段数组。
返回
共享访问签名令牌。
toString()
将 SharedAccessSignatureObject 格式设置为格式正确的字符串。
function toString(): string
返回
string
格式正确的共享访问签名令牌。