您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

az iot central api-token

备注

此引用是适用于 Azure CLI 的 azure iot 扩展的一部分,需要2.17.1 或更高版本。 首次运行 az iot central api 标记 命令时,扩展将自动安装。 详细了解扩展。

管理 IoT Central 应用程序的 API 令牌。

IoT Central 允许生成和管理用于访问 IoT Central API 的 API 令牌。 有关 Api 的详细信息,请参阅 https://aka.ms/iotcentraldocsapi

命令

az iot central api-token create

生成与 IoT Central 应用程序关联的 API 令牌。

az iot central api-token delete

删除与 IoT Central 应用程序关联的 API 令牌。

az iot central api-token list

列出与 IoT Central 应用程序关联的所有 API 令牌。

az iot central api-token show

获取与 IoT Central 应用程序关联的 API 令牌的详细信息。

az iot central api-token create

生成与 IoT Central 应用程序关联的 API 令牌。

注意:生成令牌后,你将无法再次检索它。

az iot central api-token create --app-id
                                --role {admin, builder, operator}
                                --tkid
                                [--api-version {1.0, preview}]
                                [--central-api-uri]
                                [--token]

示例

添加新的 API 令牌

az iot central api-token create --token-id {tokenId} --app-id {appId} --role admin

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在 "帮助" 菜单下的应用程序的 "关于" 页中找到应用程序 ID。

--role -r

将与此令牌关联的角色。 您可以指定一个内置角色,也可以指定自定义角色的角色 ID。 有关详细信息,请参阅 https://aka.ms/iotcentral-customrolesdocs

接受的值: admin, builder, operator
--tkid --token-id

与此令牌关联的 IoT Central ID [0-9a-z-Z-] 允许,最大长度限制为40。 指定稍后通过 CLI 或 API 修改或删除此令牌时将使用的 ID。

可选参数

--api-version --av

所请求操作的 API 版本。

接受的值: 1.0, preview
默认值: 1.0
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。 默认值为: azureiotcentral.com。

默认值: azureiotcentral.com
--token

如果希望在不针对 Azure CLI 进行身份验证的情况下提交请求,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi。

az iot central api-token delete

删除与 IoT Central 应用程序关联的 API 令牌。

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {1.0, preview}]
                                [--central-api-uri]
                                [--token]

示例

删除 API 令牌

az iot central api-token delete --app-id {appid} --token-id {tokenId}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在 "帮助" 菜单下的应用程序的 "关于" 页中找到应用程序 ID。

--tkid --token-id

与此令牌关联的 IoT Central ID [0-9a-z-Z-] 允许,最大长度限制为40。 指定稍后通过 CLI 或 API 修改或删除此令牌时将使用的 ID。

可选参数

--api-version --av

所请求操作的 API 版本。

接受的值: 1.0, preview
默认值: 1.0
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。 默认值为: azureiotcentral.com。

默认值: azureiotcentral.com
--token

如果希望在不针对 Azure CLI 进行身份验证的情况下提交请求,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi。

az iot central api-token list

列出与 IoT Central 应用程序关联的所有 API 令牌。

列表中的信息包含有关应用程序中的令牌的基本信息,并且不包括标记值。

az iot central api-token list --app-id
                              [--api-version {1.0, preview}]
                              [--central-api-uri]
                              [--token]

示例

API 令牌列表

az iot central api-token list --app-id {appid}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在 "帮助" 菜单下的应用程序的 "关于" 页中找到应用程序 ID。

可选参数

--api-version --av

所请求操作的 API 版本。

接受的值: 1.0, preview
默认值: 1.0
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。 默认值为: azureiotcentral.com。

默认值: azureiotcentral.com
--token

如果希望在不针对 Azure CLI 进行身份验证的情况下提交请求,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi。

az iot central api-token show

获取与 IoT Central 应用程序关联的 API 令牌的详细信息。

在 IoT Central 应用程序中列出 API 令牌的详细信息,如其关联的角色。

az iot central api-token show --app-id
                              --tkid
                              [--api-version {1.0, preview}]
                              [--central-api-uri]
                              [--token]

示例

获取 API 令牌

az iot central api-token show --app-id {appid} --token-id {tokenId}

必需参数

--app-id -n

要管理的 IoT Central 应用的应用 ID。 可以在 "帮助" 菜单下的应用程序的 "关于" 页中找到应用程序 ID。

--tkid --token-id

与此令牌关联的 IoT Central ID [0-9a-z-Z-] 允许,最大长度限制为40。 指定稍后通过 CLI 或 API 修改或删除此令牌时将使用的 ID。

可选参数

--api-version --av

所请求操作的 API 版本。

接受的值: 1.0, preview
默认值: 1.0
--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。 默认值为: azureiotcentral.com。

默认值: azureiotcentral.com
--token

如果希望在不针对 Azure CLI 进行身份验证的情况下提交请求,可以指定有效的用户令牌来对请求进行身份验证。 必须将密钥类型指定为请求的一部分。 更多信息请访问 https://aka.ms/iotcentraldocsapi。