az iot central api-token
注意
此參考是 Azure CLI 的 azure-iot 延伸模組的一部分 (2.37.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
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
將與此權杖或使用者相關聯的角色。 您可以指定其中一個內建角色,或指定自訂角色的角色識別碼。 如需詳細資訊, https://aka.ms/iotcentral-customrolesdocs 請參閱 。
與此權杖相關聯的 IoT Central 識別碼 [0-9a-zA-Z-] 允許,最大長度限制為 40。 指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
權杖角色指派的組織識別碼。 僅適用于 api-version == 1.1-preview。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
與此權杖相關聯的 IoT Central 識別碼 [0-9a-zA-Z-] 允許,最大長度限制為 40。 指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --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}
必要參數
您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表下找到應用程式識別碼。
與此權杖相關聯的 IoT Central 識別碼 [0-9a-zA-Z-] 允許,最大長度限制為 40。 指定您稍後透過 CLI 或 API 修改或刪除此權杖時將使用的識別碼。
選擇性參數
引數 'api_version' 已被取代,並將在未來版本中移除。
此命令參數已被取代,將會忽略。在未來版本中,我們只會支援最新 GA 版本的 IoT Central API。如果任何 API 尚未正式運作,我們將呼叫最新的預覽版本。
與您的應用程式相關聯的 IoT Central DNS 尾碼。
如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 請至https://aka.ms/iotcentraldocsapi,即可深入瞭解。
全域參數
增加記錄詳細資訊,以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤,隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID
帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應