Share via

az healthcareapis service

  • リファレンス

Note

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

Healthcareapis サービス。

コマンド

名前 説明 型 Status
az healthcareapis service create

サービス インスタンスのメタデータを作成します。

 拡張 GA
az healthcareapis service delete

サービス インスタンスを削除します。

 拡張 GA
az healthcareapis service list

リソース グループ内のすべてのサービス インスタンスを取得します。 また、サブスクリプション内のすべてのサービス インスタンスを取得します。

 拡張 GA
az healthcareapis service show

サービス インスタンスのメタデータを取得します。

 拡張 GA
az healthcareapis service update

サービス インスタンスのメタデータを更新します。

 拡張 GA
az healthcareapis service wait

healthcareapis サービスの条件が満たされるまで、CLI を待機状態にします。

 拡張 GA

az healthcareapis service create

サービス インスタンスのメタデータを作成します。

az healthcareapis service create --kind {fhir, fhir-R4, fhir-Stu3}
                                 --location
                                 --resource-group
                                 --resource-name
                                 [--access-policies]
                                 [--authentication-configuration]
                                 [--cors-configuration]
                                 [--cosmos-db-configuration]
                                 [--etag]
                                 [--export-configuration-storage-account-name]
                                 [--identity-type {None, SystemAssigned}]
                                 [--login-servers]
                                 [--no-wait]
                                 [--oci-artifacts]
                                 [--private-endpoint-connections]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--tags]

例

すべてのパラメーターを使用してサービスを作成または更新する

az healthcareapis service create --resource-group "rg1" --resource-name "service1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --authentication-configuration audience="https://azurehealthcareapis.com" authority="https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc" smart-proxy-enabled=true --cors-configuration allow-credentials=false headers="*" max-age=1440 methods="DELETE" methods="GET" methods="OPTIONS" methods="PATCH" methods="POST" methods="PUT" origins="*" --cosmos-db-configuration key-vault-key-uri="https://my-vault.vault.azure.net/keys/my-key" offer-throughput=1000 --export-configuration-storage-account-name "existingStorageAccount" --public-network-access "Disabled"

最小パラメーターを使用してサービスを作成または更新する

az healthcareapis service create --resource-group "rg1" --resource-name "service2" --kind "fhir-R4" --location "westus2" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47"

必須のパラメーター

--kind

サービスの種類。

承認された値: fhir, fhir-R4, fhir-Stu3
--location -l

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

--resource-group -g

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

--resource-name

サービス インスタンスの名前。

省略可能のパラメーター

--access-policies

サービス インスタンスのアクセス ポリシー。

使用法: --access-policies object-id=XX

object-id: 必須。 FHIR サービスへのアクセスが許可されている Azure AD オブジェクト ID (ユーザーまたはアプリ)。

複数の --access-policies 引数を使用して、複数のアクションを指定できます。

--authentication-configuration -c

サービス インスタンスの認証構成。

使用法: --authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

authority: サービス対象ユーザーの機関 URL: サービス スマート プロキシ対応の対象ユーザー URL: SMART on FHIR プロキシが有効になっている場合。

--cors-configuration

サービス インスタンスの CORS 構成の設定。

使用法: --cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

origins: CORS 経由で許可されるオリジン。 headers: CORS 経由で許可されるヘッダー。 methods: CORS を介して許可されるメソッド。 max-age: CORS を介して許可される最大年齢。 allow-credentials: 資格情報が CORS 経由で許可されている場合。

--cosmos-db-configuration

サービスをバックアップする Cosmos DB データベースの設定。

使用法: --cosmos-db-configuration offer-throughput=XX key-vault-key-uri=XX

offer-throughput: バッキング データベースのプロビジョニング済みスループット。 key-vault-key-uri: バッキング データベースのカスタマー マネージド キーの URI。

--etag

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

--export-configuration-storage-account-name -s

既定のエクスポート ストレージ アカウントの名前。

--identity-type

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

承認された値: None, SystemAssigned
--login-servers

サービス インスタンスに追加するログイン サーバーの一覧。

--no-wait

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

既定値: False
--oci-artifacts

Open Container Initiative (OCI) 成果物の一覧。

使用法: --oci-artifacts login-server=XX image-name=XX digest=XX

login-server: Azure Container Registry ログイン サーバー。 image-name: アーティファクト名。 ダイジェスト: 成果物ダイジェスト。

複数の --oci-artifacts 引数を使用して、複数のアクションを指定できます。

--private-endpoint-connections

このリソースに設定されているプライベート エンドポイント接続の一覧。

使用法: --private-endpoint-connections status=XX description=XX actions-required=XX

status: 接続がサービスの所有者によって承認/拒否/削除されたかどうかを示します。 description: 接続の承認/拒否の理由。 actions-required: サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。

複数の --private-endpoint-connections 引数を使用して、複数のアクションを指定できます。

--public-network-access

プライベート エンドポイントが有効になっている間、パブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

承認された値: Disabled, Enabled
--tags

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

グローバル パラメーター
--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 service delete

サービス インスタンスを削除します。

az healthcareapis service delete [--ids]
                                 [--no-wait]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--yes]

例

サービスの削除

az healthcareapis service delete --resource-group "rg1" --resource-name "service1"

省略可能のパラメーター

--ids

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

--no-wait

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

既定値: False
--resource-group -g

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

--resource-name

サービス インスタンスの名前。

--subscription

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

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

リソース グループ内のすべてのサービス インスタンスを取得します。 また、サブスクリプション内のすべてのサービス インスタンスを取得します。

az healthcareapis service list [--resource-group]

例

リソース グループ内のすべてのサービスを一覧表示する

az healthcareapis service list --resource-group "rgname"

サブスクリプション内のすべてのサービスを一覧表示する

az healthcareapis service list

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 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 healthcareapis service show

サービス インスタンスのメタデータを取得します。

az healthcareapis service show [--ids]
                               [--resource-group]
                               [--resource-name]
                               [--subscription]

例

メタデータの取得

az healthcareapis service show --resource-group "rg1" --resource-name "service1"

省略可能のパラメーター

--ids

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

--resource-group -g

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

--resource-name

サービス インスタンスの名前。

--subscription

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

グローバル パラメーター
--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 service update

サービス インスタンスのメタデータを更新します。

az healthcareapis service update [--ids]
                                 [--no-wait]
                                 [--public-network-access {Disabled, Enabled}]
                                 [--resource-group]
                                 [--resource-name]
                                 [--subscription]
                                 [--tags]

例

パッチ サービス

az healthcareapis service update --resource-group "rg1" --resource-name "service1" --tags tag1="value1" tag2="value2"

省略可能のパラメーター

--ids

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

--no-wait

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

既定値: False
--public-network-access

プライベート エンドポイントが有効になっている間、パブリック ネットワークから送信されるデータ プレーン トラフィックのアクセス許可を制御します。

承認された値: Disabled, Enabled
--resource-group -g

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

--resource-name

サービス インスタンスの名前。

--subscription

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

--tags

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

グローバル パラメーター
--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 service wait

healthcareapis サービスの条件が満たされるまで、CLI を待機状態にします。

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

例

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

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --created

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

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --updated

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

az healthcareapis service wait --resource-group "rg1" --resource-name "service1" --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
--resource-group -g

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

--resource-name

サービス インスタンスの名前。

--subscription

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

--timeout

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

既定値: 3600
--updated

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

既定値: 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 を使います。