az healthcareapis workspace fhir-service

參考

注意

此參考是 Azure CLI 的 healthcareapis 延伸模組的一部分（2.66.0 版或更高版本）。擴充功能會在您第一次執行 az healthcareapis workspace fhir-service 命令時自動安裝。深入了解擴充功能。

使用 Healthcareapis 管理 fhir 服務。

命令

名稱	Description	類型	狀態
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	Patch FHIR 服務詳細數據。	副檔名	GA
az healthcareapis workspace fhir-service wait	將 CLI 置於等候狀態，直到符合 healthcareapis 工作區 fhir-service 的條件為止。	副檔名	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 物件識別碼（使用者或應用程式）。

您可以使用多個 --access-policies 自變數來指定多個動作。

--authentication-configuration -c

Fhir 服務驗證組態。

使用方式：--authentication-configuration authority=XX audience=XX smart-proxy-enabled=XX

authority：服務對象的授權單位 URL：已啟用 smart-proxy 的服務物件 URL：如果已啟用 SMART on FHIR Proxy。

--cors-configuration

Fhir 服務 Cors 設定。

使用方式：-cors-configuration origins=XX headers=XX methods=XX max-age=XX allow-credentials=XX

origins：允許透過CORS的來源。標頭：允許透過CORS的標頭。方法：允許透過 CORS 的方法。 max-age：允許透過CORS的最長存留期。 allow-credentials：如果允許透過 CORS 認證。

--default

所有資源追蹤歷程記錄的預設值。

接受的值: no-version, versioned, versioned-update

--etag

與資源相關聯的 etag，在編輯資源時用於開放式並行存取。

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

默認匯出記憶體帳戶的名稱。

--identity-type

正在指定的身分識別類型，目前允許 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 Container Registry 登入伺服器的清單。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--oci-artifacts

Open Container Initiative （OCI）成品的清單。

使用方式：--oci-artifacts login-server=XX image-name=XX digest=XX

您可以使用多個 --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

與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。字典值可以是要求中的空白物件（{}）。預期值：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

訂用帳戶的名稱或識別碼。您可以使用 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

一或多個資源識別碼 (以空格分隔)。它應該是完整資源識別碼，其中包含「資源標識碼」引數的所有資訊。您應該提供 --ids 或其他「資源識別碼」引數。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 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

訂用帳戶的名稱或識別碼。您可以使用 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

訂用帳戶的名稱或識別碼。您可以使用 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

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 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

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az healthcareapis workspace fhir-service update

Patch 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

正在指定的身分識別類型，目前允許 SystemAssigned 和 None。

接受的值: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ids

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--user-assigned-identities -i

--workspace-name

工作區資源的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az healthcareapis workspace fhir-service wait

將 CLI 置於等候狀態，直到符合 healthcareapis 工作區 fhir-service 的條件為止。

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

範例

暫停執行下一行 CLI 腳本，直到 healthcareapis 工作區 fhir-service 成功建立為止。

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

暫停執行下一行 CLI 腳本，直到 healthcareapis 工作區 fhir-service 成功更新為止。

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

暫停執行下一行 CLI 腳本，直到成功刪除 healthcareapis 工作區 fhir-service 為止。

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

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

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

FHIR 服務資源的名稱。

--ids

--interval

輪詢間隔以秒為單位。

預設值: 30

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--subscription

訂用帳戶的名稱或識別碼。您可以使用 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

訂用帳戶的名稱或識別碼。您可以使用 az account set -s NAME_OR_ID 設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az healthcareapis workspace fhir-service

命令

az healthcareapis workspace fhir-service create

範例

必要參數

選擇性參數

az healthcareapis workspace fhir-service delete

範例

選擇性參數

az healthcareapis workspace fhir-service list

範例

必要參數

az healthcareapis workspace fhir-service show

範例

選擇性參數

az healthcareapis workspace fhir-service update

範例

選擇性參數

az healthcareapis workspace fhir-service wait

範例

選擇性參數

其他資源