az iot central user

注意

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

管理及設定 IoT Central 使用者。

命令

名稱	Description	類型	狀態
az iot central user create	將使用者新增至應用程式。	擴充	GA
az iot central user delete	從應用程式刪除使用者。	擴充	GA
az iot central user list	取得 IoT Central 應用程式的使用者清單。	擴充	GA
az iot central user show	依識別碼取得使用者的詳細資料。	擴充	GA
az iot central user update	更新應用程式中使用者的角色。	擴充	GA

az iot central user create

將使用者新增至應用程式。

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

範例

透過電子郵件將使用者新增至應用程式

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

將服務主體新增至應用程式

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

必要參數

--app-id -n

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

--assignee --user-id

與使用者相關聯的識別碼。

--role -r

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

選擇性參數

--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

--email

要新增至應用程式之使用者的電子郵件地址。 如果指定此專案，則會忽略服務主體參數 （tenant_id 和 object_id]。

--object-id --oid

要新增至應用程式之服務主體的物件識別碼。 也必須指定租使用者識別碼。 如果指定電子郵件，則會忽略此專案，而且使用者不會是服務主體使用者，而是標準「電子郵件」使用者。

--org-id --organization-id

使用者角色指派的組織識別碼。 僅適用于 api-version == 1.1-preview。

--tenant-id --tnid

要新增至應用程式的服務主體租使用者識別碼。 也必須指定物件識別碼。 如果指定電子郵件，則會忽略此專案，而且使用者不會是服務主體使用者，而是標準「電子郵件」使用者。

--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 user delete

從應用程式刪除使用者。

az iot central user delete --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

範例

刪除使用者

az iot central user delete --app-id {appid} --user-id {userId}

必要參數

--app-id -n

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

--assignee --user-id

與使用者相關聯的識別碼。

選擇性參數

--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

如果您想要提交要求而不向 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 user list

取得 IoT Central 應用程式的使用者清單。

az iot central user list --app-id
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

範例

使用者清單

az iot central user 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

如果您想要提交要求而不向 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 user show

依識別碼取得使用者的詳細資料。

az iot central user show --app-id
                         --assignee
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

範例

取得使用者的詳細資料

az iot central user show --app-id {appid} --user-id {userId}

必要參數

--app-id -n

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

--assignee --user-id

與使用者相關聯的識別碼。

選擇性參數

--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

如果您想要提交要求而不向 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 user update

更新應用程式中使用者的角色。

以不同的角色更新使用者。 不允許更新服務主體使用者的 tenantId 或 objectId。 不允許更新電子郵件使用者的電子郵件地址。

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

範例

透過電子郵件或服務主體在應用程式中更新使用者的角色。

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

必要參數

--app-id -n

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

--assignee --user-id

與使用者相關聯的識別碼。

選擇性參數

--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

--email

要新增至應用程式之使用者的電子郵件地址。 如果指定此專案，則會忽略服務主體參數 （tenant_id 和 object_id]。

--object-id --oid

要新增至應用程式之服務主體的物件識別碼。 也必須指定租使用者識別碼。 如果指定電子郵件，則會忽略此專案，而且使用者不會是服務主體使用者，而是標準「電子郵件」使用者。

--roles

將與此使用者相關聯的角色逗號分隔清單。 您可以指定其中一個內建角色，或指定自訂角色的角色識別碼。 如需詳細資訊， https://aka.ms/iotcentral-customrolesdocs 請參閱 。 使用 API 版本 == 1.1-preview 執行時，可以與角色一起指定組織。 例如「organization_id\role」。

--tenant-id --tnid

要新增至應用程式的服務主體租使用者識別碼。 也必須指定物件識別碼。 如果指定電子郵件，則會忽略此專案，而且使用者不會是服務主體使用者，而是標準「電子郵件」使用者。

--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 來取得完整偵錯記錄。