az iot central export destination

プレビュー
リファレンス

Note

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

コマンドグループ "iot central export" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Central エクスポート先を管理および構成します。

コマンド

名前	説明	型	状態
az iot central export destination create	IoT Central アプリケーションのエクスポート先を作成します。	拡張子	プレビュー
az iot central export destination delete	IoT Central アプリケーションのエクスポート先を削除します。	拡張子	プレビュー
az iot central export destination list	IoT Central アプリケーションのエクスポート先の完全な一覧を取得します。	拡張子	プレビュー
az iot central export destination show	エクスポート先の詳細を取得します。	拡張子	プレビュー
az iot central export destination update	IoT Central アプリケーションのエクスポート先を更新します。	拡張子	プレビュー

az iot central export destination create

プレビュー

コマンドグループ "iot central export destination" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Central アプリケーションのエクスポート先を作成します。

az iot central export destination create --app-id
                                         --dest-id
                                         --display-name
                                         --type {blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1}
                                         [--api-version {2022-06-30-preview}]
                                         [--au]
                                         [--central-api-uri]
                                         [--cluster-url]
                                         [--database]
                                         [--header]
                                         [--table]
                                         [--token]
                                         [--url]

例

json ペイロードを使用して Webhook エクスポート先を作成する

az iot central export destination create --app-id {appid} --dest-id {destinationid} --name {displayname} --url {url} --type webhook@v1 --header '{"x-custom-region":{"value":"westus", "secret": false}}'

JSON ペイロードを使用して BLOB ストレージのエクスポート先を作成する

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type blobstorage@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString":"DefaultEndpointsProtocol=https;AccountName=[accountName];AccountKey=[key];EndpointSuffix=core.windows.net",
  "containerName": "test"
}'

json ペイロードを使用して Azure Data Explorer エクスポート先を作成する

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type dataexplorer@v1 --name {displayname} --cluster-url {clusterurl} --database {database} --table {table} --authorization '{
  "type": "servicePrincipal",
  "clientId": "3b420743-2020-44c6-9b70-cc42f945db0x",
  "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
  "clientSecret": "[Secret]"
}'

json ペイロードを使用して Event Hub エクスポート先を作成する

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type eventhubs@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[hubName].servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=*****;EntityPath=entityPath1"
}'

json ペイロードを使用して Service Bus キューの宛先を作成する

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebusqueue@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespance].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

json ペイロードを使用して Service Bus トピックの宛先を作成する

az iot central export destination create --app-id {appid} --dest-id {destintionid} --type servicebustopic@v1 --name {displayname} --authorization '{
  "type": "connectionString",
  "connectionString": "Endpoint=sb://[namespace].servicebus.windows.net/;SharedAccessKeyName=xxx;SharedAccessKey=[key];EntityPath=[name]"
}'

必須のパラメーター

--app-id -n

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

--dest-id

エクスポート先の一意識別子。

--display-name --name

変換先の表示名。

--type -t

変換先の型です。

指定可能な値: blobstorage@v1, dataexplorer@v1, eventhubs@v1, servicebusqueue@v1, servicebustopic@v1, webhook@v1

省略可能のパラメーター

--api-version --av

非推奨

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

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

指定可能な値: 2022-06-30-preview

規定値: 2022-06-30-preview

--au --authorization

json の承認構成。

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

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

規定値: azureiotcentral.com

--cluster-url --cu

Azure データエクスプローラークラスターの URL。

--database

Azure データエクスプローラーデータベース。

--header

json 内の webhook 変換先のカスタムヘッダーコレクション。

--table

Azure データエクスプローラーのテーブル。

--token

Azure CLI に対して認証せずに要求を送信する場合は、要求を認証するための有効なユーザートークンを指定できます。要求の一部としてキーの種類を指定する必要があります。詳細については、https://aka.ms/iotcentraldocsapi をご覧ください。

--url

webhook の URL。

グローバルパラメーター

--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 export destination delete

プレビュー

コマンドグループ "iot central export destination" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Central アプリケーションのエクスポート先を削除します。

az iot central export destination delete --app-id
                                         --dest-id
                                         [--api-version {2022-06-30-preview}]
                                         [--central-api-uri]
                                         [--token]

例

エクスポート先を削除する

az iot central export destination delete --app-id {appid} --dest-id {destinationid}

必須のパラメーター

--app-id -n

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

--dest-id

エクスポート先の一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

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

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

指定可能な値: 2022-06-30-preview

規定値: 2022-06-30-preview

--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 export destination list

プレビュー

コマンドグループ "iot central export destination" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Central アプリケーションのエクスポート先の完全な一覧を取得します。

az iot central export destination list --app-id
                                       [--api-version {2022-06-30-preview}]
                                       [--central-api-uri]
                                       [--token]

例

アプリケーション内のすべてのエクスポート先を一覧表示する

az iot central export destination list --app-id {appid}

必須のパラメーター

--app-id -n

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

省略可能のパラメーター

--api-version --av

非推奨

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

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

指定可能な値: 2022-06-30-preview

規定値: 2022-06-30-preview

--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 export destination show

プレビュー

コマンドグループ "iot central export destination" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

エクスポート先の詳細を取得します。

az iot central export destination show --app-id
                                       --dest-id
                                       [--api-version {2022-06-30-preview}]
                                       [--central-api-uri]
                                       [--token]

例

エクスポート先の詳細を取得する

az iot central export destination show --app-id {appid} --dest-id {destinationid}

必須のパラメーター

--app-id -n

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

--dest-id

エクスポート先の一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

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

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

指定可能な値: 2022-06-30-preview

規定値: 2022-06-30-preview

--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 export destination update

プレビュー

コマンドグループ "iot central export destination" はプレビュー段階であり、開発中です。参照レベルとサポートレベル: https://aka.ms/CLI_refstatus

IoT Central アプリケーションのエクスポート先を更新します。

コピー先の型は、作成後は変更できません。新しい変換先は、新しい型で作成する必要があります。

az iot central export destination update --app-id
                                         --content
                                         --dest-id
                                         [--api-version {2022-06-30-preview}]
                                         [--central-api-uri]
                                         [--token]

例

ファイルからエクスポート先を更新する

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content './filepath/payload.json'

json-patch ペイロードを使用してエクスポート先を更新する

az iot central export destination update --app-id {appid} --dest-id {destinationid} --content '{"displayName": "Web Hook Updated"}'

必須のパラメーター

--app-id -n

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

--content -k

部分的な変換先の定義。 JSON ファイルまたは未加工の文字列化された JSON へのパスを指定します。 [ファイルパスの例:./path/to/file.json][文字列化された JSON の例:{}]。要求本文には、Destination の部分的なコンテンツが含まれている必要があります。

--dest-id

エクスポート先の一意識別子。

省略可能のパラメーター

--api-version --av

非推奨

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

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

指定可能な値: 2022-06-30-preview

規定値: 2022-06-30-preview

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

コマンド

az iot central export destination create

例

必須のパラメーター

省略可能のパラメーター

az iot central export destination delete

例

必須のパラメーター

省略可能のパラメーター

az iot central export destination list

例

必須のパラメーター

省略可能のパラメーター

az iot central export destination show

例

必須のパラメーター

省略可能のパラメーター

az iot central export destination update

例

必須のパラメーター

省略可能のパラメーター

その他のリソース