az iot central api-token

注意

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

管理 IoT Central 應用程式的 API 權杖。

IoT Central 可讓您產生和管理 API 權杖,以用來存取 IoT Central 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
                                --tkid
                                [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                [--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 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-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

az iot central api-token delete

刪除與 IoT Central 應用程式相關聯的 API 權杖。

az iot central api-token delete --app-id
                                --tkid
                                [--api-version {1.0, 1.1-preview, 2022-05-31, preview}]
                                [--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 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: 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, 1.1-preview, 2022-05-31, preview}]
                              [--central-api-uri]
                              [--token]

範例

API 權杖清單

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

必要參數

--app-id -n

您想要管理的 IoT Central 應用程式的應用程式識別碼。 您可以在應用程式 [關於] 頁面的 [說明] 功能表底下找到應用程式識別碼。

選擇性參數

--api-version --av

所要求作業的 API 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: 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, 1.1-preview, 2022-05-31, preview}]
                              [--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 版本。

接受的值: 1.0, 1.1-preview, 2022-05-31, preview
預設值: 2022-05-31
--central-api-uri --central-dns-suffix

與應用程式相關聯的 IoT Central DNS 尾碼。

預設值: azureiotcentral.com
--token

如果您想要提交要求而不向 Azure CLI 進行驗證,您可以指定有效的使用者權杖來驗證您的要求。 您必須將金鑰類型指定為要求的一部分。 深入了解:https://aka.ms/iotcentraldocsapi