az iot central organization

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az iot central organization コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

IoT Central アプリケーションの組織を管理および構成します。

コマンド

名前	説明	型	状態
az iot central organization create	アプリケーションで組織を作成します。	拡張子	GA
az iot central organization delete	ID で組織を削除します。	拡張子	GA
az iot central organization list	IoT Central アプリケーションの組織の一覧を取得します。	拡張子	GA
az iot central organization show	ID で組織の詳細を取得します。	拡張子	GA
az iot central organization update	アプリケーション内の組織を更新します。	拡張子	GA

az iot central organization create

アプリケーションで組織を作成します。

az iot central organization create --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--org-name]
                                   [--parent-id]
                                   [--token]

例

組織の作成

az iot central organization create --app-id {appid} --org-id {organizationId}

アプリケーションで親組織の子である組織を作成します。

az iot central organization create --app-id {appid} --org-id {organizationId} --parent-id {parentId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--org-id

組織を表す一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

要求された操作の API バージョン。

指定可能な値: 2022-07-31

規定値: 2022-07-31

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

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--org-name

組織の表示名です。

--parent-id

組織の親の ID。

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

ID で組織を削除します。

az iot central organization delete --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--token]

例

組織を削除する

az iot central organization delete --app-id {appid} --org-id {organizationId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--org-id

組織を表す一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

要求された操作の API バージョン。

指定可能な値: 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 organization list

IoT Central アプリケーションの組織の一覧を取得します。

az iot central organization list --app-id
                                 [--api-version {2022-07-31}]
                                 [--central-api-uri]
                                 [--token]

例

アプリケーション内の組織を一覧表示する

az iot central organization list --app-id {appid}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

要求された操作の API バージョン。

指定可能な値: 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 organization show

ID で組織の詳細を取得します。

az iot central organization show --app-id
                                 --org-id
                                 [--api-version {2022-07-31}]
                                 [--central-api-uri]
                                 [--token]

例

組織の詳細を取得する

az iot central organization show --app-id {appid} --org-id {organizationId}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--org-id

組織を表す一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

要求された操作の API バージョン。

指定可能な値: 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 organization update

アプリケーション内の組織を更新します。

az iot central organization update --app-id
                                   --org-id
                                   [--api-version {2022-07-31}]
                                   [--central-api-uri]
                                   [--org-name]
                                   [--parent-id]
                                   [--token]

例

組織の親を更新する

az iot central organization update --app-id {appid} --org-id {organizationId} --parent-id {parentId}

組織の更新名

az iot central organization update --app-id {appid} --org-id {organizationId} --org-name {organizationName}

必須のパラメーター

--app-id -n

管理する IoT Central アプリのアプリ ID。アプリ ID は、アプリケーションの [バージョン情報] ページのヘルプメニューにあります。

--org-id

組織を表す一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

引数 'api_version' は非推奨となり、今後のリリースで削除される予定です。

要求された操作の API バージョン。

指定可能な値: 2022-07-31

規定値: 2022-07-31

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

アプリケーションに関連付けられている IoT Central DNS サフィックス。

規定値: azureiotcentral.com

--org-name

組織の表示名です。

--parent-id

組織の親の ID。

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

コマンド

az iot central organization create

例

必須のパラメーター

省略可能のパラメーター

az iot central organization delete

例

必須のパラメーター

省略可能のパラメーター

az iot central organization list

例

必須のパラメーター

省略可能のパラメーター

az iot central organization show

例

必須のパラメーター

省略可能のパラメーター

az iot central organization update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース