az iot central api-token

參考

注意

此參考是 Azure CLI 的 azure-iot 延伸模組的一部分（2.46.0 版或更高版本）。擴充功能會在您第一次執行 az iot central api-token 命令時自動安裝。深入了解擴充功能。

管理 IoT Central 應用程式的 API 令牌。

IoT Central 可讓您產生和管理用來存取 IoT Central API 的 API 令牌。如需 API 的詳細資訊，請參閱 https://aka.ms/iotcentraldocsapi。

命令

名稱	Description	類型	狀態
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 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--role -r

將與此令牌或使用者相關聯的角色。您可以指定其中一個內建角色，或指定自定義角色的角色標識符。如需詳細資訊， https://aka.ms/iotcentral-customrolesdocs請參閱。

--tkid --token-id

與此令牌相關聯的IoT Central標識碼 [0-9a-zA-Z-] 允許，最大長度限制為40。指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

令牌角色指派的組織標識碼。僅適用於 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

訂用帳戶的名稱或識別碼。您可以使用 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 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--tkid --token-id

與此令牌相關聯的IoT Central標識碼 [0-9a-zA-Z-] 允許，最大長度限制為40。指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

訂用帳戶的名稱或識別碼。您可以使用 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 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

訂用帳戶的名稱或識別碼。您可以使用 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 應用程式的應用程式識別碼。您可以在應用程式[關於] 頁面的 [說明] 選單下找到應用程式識別碼。

--tkid --token-id

與此令牌相關聯的IoT Central標識碼 [0-9a-zA-Z-] 允許，最大長度限制為40。指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。

選擇性參數

--api-version --av

已被取代

自變數 'api_version' 已被取代，並將在未來版本中移除。

此命令參數已被取代，將會忽略。在未來版本中，我們只會支援最新 GA 版本的 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

訂用帳戶的名稱或識別碼。您可以使用 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

範例

必要參數

選擇性參數

其他資源