你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az iot central api-token

参考

注意

此参考是 Azure CLI（版本 2.46.0 或更高版本）的 azure-iot 扩展的一部分。该扩展将在首次运行 az iot central api-token 命令时自动安装。详细了解扩展。

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

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

命令

名称	说明	类型	Status
az iot central api-token create	生成与 IoT Central 应用程序关联的 API 令牌。	扩展	GA
az iot central api-token delete	删除与 IoT Central 应用程序关联的 API 令牌。	扩展	GA
az iot central api-token list	获取与 IoT Central 应用程序关联的 API 令牌列表。	扩展	GA
az iot central api-token show	获取与 IoT Central 应用程序关联的 API 令牌的详细信息。	扩展	GA

az iot central api-token create

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

注意：生成令牌后记下令牌，因为无法再次检索令牌。

az iot central api-token create --app-id
                                --role
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--central-api-uri]
                                [--org-id]
                                [--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有关详细信息，

--tkid --token-id

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

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--org-id --organization-id

令牌角色分配的组织 ID。仅适用于 api-version == 1.1-preview。

--token

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

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az iot central api-token delete

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

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {2022-06-30-preview, 2022-07-31}]
                                [--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-zA-Z-] 最大长度限制为 40。指定稍后通过 CLI 或 API 修改或删除此令牌时要使用的 ID。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az iot central api-token list

获取与 IoT Central 应用程序关联的 API 令牌列表。

列表中的信息包含有关应用程序中令牌的基本信息，不包括令牌值。

az iot central api-token list --app-id
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--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_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

az iot central api-token show

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

列出 IoT Central 应用中 API 令牌的详细信息，例如其关联的角色。

az iot central api-token show --app-id
                              --tkid
                              [--api-version {2022-06-30-preview, 2022-07-31}]
                              [--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-zA-Z-] 最大长度限制为 40。指定稍后通过 CLI 或 API 修改或删除此令牌时要使用的 ID。

可选参数

--api-version --av

已放弃

参数“api_version”已弃用，将在将来的版本中删除。

此命令参数已弃用，将被忽略。在未来版本中，我们仅支持最新版本的 IoT Central API。如果任何 API 尚未正式发布，我们将调用最新的预览版。

接受的值: 2022-06-30-preview, 2022-07-31

默认值: 2022-07-31

--central-api-uri --central-dns-suffix

与应用程序关联的 IoT Central DNS 后缀。

默认值: azureiotcentral.com

--token

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。使用 --debug 获取完整的调试日志。

通过

az iot central api-token

命令

az iot central api-token create

示例

必需参数

可选参数

az iot central api-token delete

示例

必需参数

可选参数

az iot central api-token list

示例

必需参数

可选参数

az iot central api-token show

示例

必需参数

可选参数

其他资源