az healthcareapis workspace iot-connector

Note

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

Healthcareapis を使用して IoT コネクタを管理します。

コマンド

名前	説明	型	Status
az healthcareapis workspace iot-connector create	指定したパラメーターを使用して IoT Connector リソースを作成します。	拡張	GA
az healthcareapis workspace iot-connector delete	IoT コネクタを削除します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination	Healthcareapis を使用して IoT コネクタの変換先を管理します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination create	指定したパラメーターを使用して、IoT Connector FHIR 変換先リソースを作成します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination delete	IoT Connector FHIR 変換先を削除します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination list	指定された IoT コネクタのすべての FHIR 変換先を一覧表示します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination show	指定した IoT Connector FHIR 変換先のプロパティを取得します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination update	指定されたパラメーターを使用して、IoT Connector FHIR 変換先リソースを更新します。	拡張	GA
az healthcareapis workspace iot-connector fhir-destination wait	healthcareapis ワークスペースの iot-connector fhir-destination の条件が満たされるまで、CLI を待機状態にします。	拡張	GA
az healthcareapis workspace iot-connector list	特定のワークスペースのすべての IoT コネクタを一覧表示します。	拡張	GA
az healthcareapis workspace iot-connector show	指定した IoT コネクタのプロパティを取得します。	拡張	GA
az healthcareapis workspace iot-connector update	IoT コネクタにパッチを適用します。	拡張	GA
az healthcareapis workspace iot-connector wait	healthcareapis ワークスペース iot-connector の条件が満たされるまで、CLI を待機状態にします。	拡張	GA

az healthcareapis workspace iot-connector create

指定したパラメーターを使用して IoT Connector リソースを作成します。

az healthcareapis workspace iot-connector create --iot-connector-name
                                                 --resource-group
                                                 --workspace-name
                                                 [--content]
                                                 [--etag]
                                                 [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                 [--ingestion-endpoint-configuration]
                                                 [--location]
                                                 [--no-wait]
                                                 [--tags]
                                                 [--user-assigned-identities]

例

IoT コネクタを作成する

az healthcareapis workspace iot-connector create --identity-type "SystemAssigned" --location "westus" --content "{\"template\":[{\"template\":{\"deviceIdExpression\":\"$.deviceid\",\"timestampExpression\":\"$.measurementdatetime\",\"typeMatchExpression\":\"$..[?(@heartrate)]\",\"typeName\":\"heartrate\",\"values\":[{\"required\":\"true\",\"valueExpression\":\"$.heartrate\",\"valueName\":\"hr\"}]},\"templateType\":\"JsonPathContent\"}],\"templateType\":\"CollectionContent\"}" --ingestion-endpoint-configuration consumer-group="ConsumerGroupA" event-hub-name="MyEventHubName" fully-qualified-event-hub-namespace="myeventhub.servicesbus.windows.net" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --name "blue" --resource-group "testRG" --workspace-name "workspace1"

必須のパラメーター

--iot-connector-name --name -n

IoT Connector リソースの名前。

--resource-group -g

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

--workspace-name

ワークスペース リソースの名前。

省略可能のパラメーター

--content

マッピング。 予期される値: json-string/json-file/@json-file。

--etag

リソースに関連付けられている etag。編集時にオプティミスティック コンカレンシーに使用されます。

--identity-type

指定されている ID の種類 。現在 SystemAssigned と None は許可されていません。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ingestion-endpoint-configuration -c

ソース構成。

使用法: --ingestion-endpoint-configuration event-hub-name=XX consumer-group=XX fully-qualified-event-hub-namespace=XX

event-hub-name: 接続先のイベント ハブ名。consumer-group: 接続先のイベント ハブのコンシューマー グループ。fully-qualified-event-hub-namespace: 接続先のイベント ハブの完全修飾名前空間。

--location -l

場所。 値のソース: az account list-locations az configure --defaults location=<location> を使用して、既定の場所を構成できます。

--no-wait

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

既定値: False

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--user-assigned-identities -i

リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 予期される値: json-string/json-file/@json-file。

グローバル パラメーター

--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 healthcareapis workspace iot-connector delete

IoT コネクタを削除します。

az healthcareapis workspace iot-connector delete [--ids]
                                                 [--iot-connector-name]
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--workspace-name]
                                                 [--yes]

例

IoT コネクタを削除する

az healthcareapis workspace iot-connector delete --name "blue" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--iot-connector-name --name -n

IoT Connector リソースの名前。

--no-wait

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

既定値: False

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--workspace-name

ワークスペース リソースの名前。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--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 healthcareapis workspace iot-connector list

特定のワークスペースのすべての IoT コネクタを一覧表示します。

az healthcareapis workspace iot-connector list --resource-group
                                               --workspace-name

例

iotconnectors を一覧表示する

az healthcareapis workspace iot-connector list --resource-group "testRG" --workspace-name "workspace1"

必須のパラメーター

--resource-group -g

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

--workspace-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 healthcareapis workspace iot-connector show

指定した IoT コネクタのプロパティを取得します。

az healthcareapis workspace iot-connector show [--ids]
                                               [--iot-connector-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--workspace-name]

例

IoT コネクタを取得する

az healthcareapis workspace iot-connector show --name "blue" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--iot-connector-name --name -n

IoT Connector リソースの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--workspace-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 healthcareapis workspace iot-connector update

IoT コネクタにパッチを適用します。

az healthcareapis workspace iot-connector update [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                 [--ids]
                                                 [--iot-connector-name]
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--tags]
                                                 [--user-assigned-identities]
                                                 [--workspace-name]

例

IoT コネクタにパッチを適用する

az healthcareapis workspace iot-connector update --name "blue" --identity-type "SystemAssigned" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--identity-type

指定されている ID の種類 。現在 SystemAssigned と None は許可されていません。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--iot-connector-name --name -n

IoT Connector リソースの名前。

--no-wait

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

既定値: False

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。

--user-assigned-identities -i

リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。 予期される値: json-string/json-file/@json-file。

--workspace-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 healthcareapis workspace iot-connector wait

healthcareapis ワークスペース iot-connector の条件が満たされるまで、CLI を待機状態にします。

az healthcareapis workspace iot-connector wait [--created]
                                               [--custom]
                                               [--deleted]
                                               [--exists]
                                               [--ids]
                                               [--interval]
                                               [--iot-connector-name]
                                               [--resource-group]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]
                                               [--workspace-name]

例

healthcareapis ワークスペース iot-connector が正常に作成されるまで、CLI スクリプトの次の行の実行を一時停止します。

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --created

healthcareapis ワークスペース iot-connector が正常に更新されるまで、CLI スクリプトの次の行の実行を一時停止します。

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --updated

healthcareapis ワークスペース iot-connector が正常に削除されるまで、CLI スクリプトの次の行の実行を一時停止します。

az healthcareapis workspace iot-connector wait --name "blue" --resource-group "testRG" --workspace-name "workspace1" --deleted

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--iot-connector-name --name -n

IoT Connector リソースの名前。

--resource-group -g

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

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

--workspace-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 を使います。