次の方法で共有

az healthcareapis workspace fhir-service

  • リファレンス

Note

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

healthcareapis を使用して fhir サービスを管理します。

コマンド

名前 説明 型 Status
az healthcareapis workspace fhir-service create

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

 拡張 GA
az healthcareapis workspace fhir-service delete

FHIR サービスを削除します。

 拡張 GA
az healthcareapis workspace fhir-service list

特定のワークスペースのすべての FHIR サービスを一覧表示します。

 拡張 GA
az healthcareapis workspace fhir-service show

指定した FHIR サービスのプロパティを取得します。

 拡張 GA
az healthcareapis workspace fhir-service update

FHIR サービスの詳細にパッチを適用します。

 拡張 GA
az healthcareapis workspace fhir-service wait

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

 拡張 GA

az healthcareapis workspace fhir-service create

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

az healthcareapis workspace fhir-service create --fhir-service-name
                                                --resource-group
                                                --workspace-name
                                                [--access-policies]
                                                [--authentication-configuration]
                                                [--cors-configuration]
                                                [--default {no-version, versioned, versioned-update}]
                                                [--etag]
                                                [--export-configuration-storage-account-name]
                                                [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                                                [--kind {fhir-R4, fhir-Stu3}]
                                                [--location]
                                                [--login-servers]
                                                [--no-wait]
                                                [--oci-artifacts]
                                                [--public-network-access {Disabled, Enabled}]
                                                [--resource-type-overrides]
                                                [--tags]
                                                [--user-assigned-identities]

例

Fhir サービスを作成または更新する

az healthcareapis workspace fhir-service create --name "fhirservice1" --identity-type "SystemAssigned" --kind "fhir-R4" --location "westus" --access-policies object-id="c487e7d1-3210-41a3-8ccc-e9372b78da47" --access-policies object-id="5b307da8-43d4-492b-8b66-b0294ade872f" --login-servers "test1.azurecr.io" --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="*" --export-configuration-storage-account-name "existingStorageAccount" --tags additionalProp1="string" additionalProp2="string" additionalProp3="string" --resource-group "testRG" --workspace-name "workspace1"

必須のパラメーター

--fhir-service-name --name -n

FHIR サービス リソースの名前。

--resource-group -g

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

--workspace-name

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

省略可能のパラメーター

--access-policies

Fhir サービスのアクセス ポリシー。

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

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

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

--authentication-configuration -c

Fhir Service 認証の構成。

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

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

--cors-configuration

Fhir Service 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 経由で許可されている場合。

--default

すべてのリソースの履歴を追跡するための既定値。

承認された値: no-version, versioned, versioned-update
--etag

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

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

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

--identity-type

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

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

サービスの種類。

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

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

--login-servers

Azure コンテナー レジストリ ログイン サーバーの一覧。

--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 引数を使用して、複数のアクションを指定できます。

--public-network-access

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

承認された値: Disabled, Enabled
--resource-type-overrides -r

FHIR リソースとそのバージョン ポリシーのオーバーライドの一覧。 期待値: KEY1=VALUE1 KEY2=VALUE2 ...

--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 fhir-service delete

FHIR サービスを削除します。

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

例

Fhir サービスを削除する

az healthcareapis workspace fhir-service delete --name "fhirservice1" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--fhir-service-name --name -n

FHIR サービス リソースの名前。

--ids

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

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

特定のワークスペースのすべての FHIR サービスを一覧表示します。

az healthcareapis workspace fhir-service list --resource-group
                                              --workspace-name

例

fhirservices を一覧表示する

az healthcareapis workspace fhir-service 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 fhir-service show

指定した FHIR サービスのプロパティを取得します。

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

例

Fhir サービスを取得する

az healthcareapis workspace fhir-service show --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--fhir-service-name --name -n

FHIR サービス リソースの名前。

--ids

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

--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 fhir-service update

FHIR サービスの詳細にパッチを適用します。

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

例

Fhir サービスを更新する

az healthcareapis workspace fhir-service update --name "fhirservice1" --tags tagKey="tagValue" --resource-group "testRG" --workspace-name "workspace1"

省略可能のパラメーター

--fhir-service-name --name -n

FHIR サービス リソースの名前。

--identity-type

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

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

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

--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 fhir-service wait

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

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

例

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --created

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --updated

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

az healthcareapis workspace fhir-service wait --name "fhirservices1" --resource-group "testRG" --workspace-name "workspace1" --deleted

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--exists

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

既定値: False
--fhir-service-name --name -n

FHIR サービス リソースの名前。

--ids

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

--interval

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

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