az dt endpoint create

リファレンス

Note

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

Digital Twins インスタンスにエグレスエンドポイントを追加します。

コマンド

名前	説明	型	Status
az dt endpoint create eventgrid	EventGrid トピックエンドポイントを Digital Twins インスタンスに追加します。事前に作成されたリソースが必要です。	拡張子	GA
az dt endpoint create eventhub	Digital Twins インスタンスに EventHub エンドポイントを追加します。	拡張子	GA
az dt endpoint create servicebus	ServiceBus トピックエンドポイントを Digital Twins インスタンスに追加します。	拡張子	GA

az dt endpoint create eventgrid

EventGrid トピックエンドポイントを Digital Twins インスタンスに追加します。事前に作成されたリソースが必要です。

EventGrid トピックエンドポイントは、ID ベースのエンドポイント統合をサポートしていません。

az dt endpoint create eventgrid --dt-name
                                --egt
                                --en
                                [--deadletter-sas-uri]
                                [--deadletter-uri]
                                [--egg]
                                [--egs]
                                [--no-wait]
                                [--resource-group]

例

EventGrid トピックエンドポイントをターゲットインスタンスに追加します。

az dt endpoint create eventgrid --endpoint-name {endpoint_name} --eventgrid-resource-group {eventgrid_resource_group} --eventgrid-topic {eventgrid_topic_name} -n {instance_name}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--egt --eventgrid-topic

統合する EventGrid トピックの名前。

--en --endpoint-name

エンドポイント名。

省略可能のパラメーター

--deadletter-sas-uri --dsu

キーベースの認証用の SAS トークンを含む配信不能ストレージコンテナー URL。

--deadletter-uri --du

ID ベースの認証用の配信不能ストレージコンテナー URL。

--egg --eventgrid-resource-group

EventGrid トピックリソースグループの名前。指定しない場合は、Digital Twin インスタンスリソースグループが使用されます。

--egs --eventgrid-subscription

エンドポイントリソースが存在するサブスクリプションの名前または ID。サブスクリプションが指定されていない場合は、既定のサブスクリプションが使用されます。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--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 dt endpoint create eventhub

Digital Twins インスタンスに EventHub エンドポイントを追加します。

事前に作成されたリソースが必要です。

インスタンスには、システム割り当て ID ベースのエンドポイント統合をサポートするためのシステム割り当て ID が必要です。インスタンスには、ユーザー割り当て ID ベースのエンドポイント統合をサポートするために、ユーザー割り当て ID が関連付けられている必要があります。

az dt endpoint create eventhub --dt-name
                               --eh
                               --ehn
                               --en
                               [--auth-type {IdentityBased, KeyBased}]
                               [--deadletter-sas-uri]
                               [--deadletter-uri]
                               [--ehg]
                               [--ehp]
                               [--ehs]
                               [--mi-system-assigned {false, true}]
                               [--mi-user-assigned]
                               [--no-wait]
                               [--resource-group]

例

キーベースの認証を使用して、EventHub エンドポイントをターゲットインスタンスに追加します。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --eventhub-policy {eventhub_policy} -n {instance_name}

認証にシステム割り当て ID を使用して、EventHub エンドポイントをターゲットインスタンスに追加します。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --mi-system-assigned -n {instance_name}

認証にユーザー割り当て ID を使用して、EventHub エンドポイントをターゲットインスタンスに追加します。

az dt endpoint create eventhub --endpoint-name {endpoint_name} --eventhub-resource-group {eventhub_resource_group} --eventhub-namespace {eventhub_namespace} --eventhub {eventhub_name} --mi-user-assigned {resource_id} -n {instance_name}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--eh --eventhub

統合する EventHub の名前。

--ehn --eventhub-namespace

EventHub 名前空間識別子。

--en --endpoint-name

エンドポイント名。

省略可能のパラメーター

--auth-type

非推奨

引数 'auth_type' は非推奨となり、今後のリリースで削除される予定です。代わりに 'identity' を使用してください。

エンドポイント認証の種類。

承認された値: IdentityBased, KeyBased

既定値: KeyBased

--deadletter-sas-uri --dsu

キーベースの認証用の SAS トークンを含む配信不能ストレージコンテナー URL。

--deadletter-uri --du

ID ベースの認証用の配信不能ストレージコンテナー URL。

--ehg --eventhub-resource-group

EventHub リソースグループの名前。指定しない場合は、Digital Twin インスタンスリソースグループが使用されます。

--ehp --eventhub-policy

エンドポイント構成に使用する EventHub ポリシー。 --auth-type が KeyBased の場合に必要です。

--ehs --eventhub-subscription

--mi-system-assigned --system

エンドポイント認証には、システム割り当てマネージド ID を使用します。

承認された値: false, true

--mi-user-assigned --user

エンドポイント認証には、ユーザー割り当てマネージド ID を使用します。 ID リソース ID を受け入れます。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--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 dt endpoint create servicebus

ServiceBus トピックエンドポイントを Digital Twins インスタンスに追加します。

事前に作成されたリソースが必要です。

az dt endpoint create servicebus --dt-name
                                 --en
                                 --sbn
                                 --sbt
                                 [--auth-type {IdentityBased, KeyBased}]
                                 [--deadletter-sas-uri]
                                 [--deadletter-uri]
                                 [--mi-system-assigned {false, true}]
                                 [--mi-user-assigned]
                                 [--no-wait]
                                 [--resource-group]
                                 [--sbg]
                                 [--sbp]
                                 [--sbs]

例

キーベースの認証を使用して、ServiceBus トピックエンドポイントをターゲットインスタンスに追加します。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --servicebus-policy {servicebus_policy} -n {instance_name}

認証にシステム割り当て ID を使用して、ServiceBus トピックエンドポイントをターゲットインスタンスに追加します。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --mi-system-assigned -n {instance_name}

認証にユーザー割り当て ID を使用して、ServiceBus トピックエンドポイントをターゲットインスタンスに追加します。

az dt endpoint create servicebus --endpoint-name {endpoint_name} --servicebus-resource-group {servicebus_resource_group} --servicebus-namespace {servicebus_namespace} --servicebus-topic {servicebus_topic_name} --mi-user-assigned {resource_id} -n {instance_name}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--en --endpoint-name

エンドポイント名。

--sbn --servicebus-namespace

ServiceBus 名前空間識別子。

--sbt --servicebus-topic

統合する ServiceBus トピックの名前。

省略可能のパラメーター

--auth-type

非推奨

引数 'auth_type' は非推奨となり、今後のリリースで削除される予定です。代わりに 'identity' を使用してください。

エンドポイント認証の種類。

承認された値: IdentityBased, KeyBased

既定値: KeyBased

--deadletter-sas-uri --dsu

キーベースの認証用の SAS トークンを含む配信不能ストレージコンテナー URL。

--deadletter-uri --du

ID ベースの認証用の配信不能ストレージコンテナー URL。

--mi-system-assigned --system

エンドポイント認証には、システム割り当てマネージド ID を使用します。

承認された値: false, true

--mi-user-assigned --user

エンドポイント認証には、ユーザー割り当てマネージド ID を使用します。 ID リソース ID を受け入れます。

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--sbg --servicebus-resource-group

ServiceBus リソースグループの名前。指定しない場合は、Digital Twin インスタンスリソースグループが使用されます。

--sbp --servicebus-policy

エンドポイント構成に使用する ServiceBus トピックポリシー。 --auth-type が KeyBased の場合に必要です。

--sbs --servicebus-subscription

グローバルパラメーター

--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 dt endpoint create

コマンド

az dt endpoint create eventgrid

例

必須のパラメーター

省略可能のパラメーター

az dt endpoint create eventhub

例

必須のパラメーター

省略可能のパラメーター

az dt endpoint create servicebus

例

必須のパラメーター

省略可能のパラメーター

その他のリソース