共用方式為

az healthcareapis service

  • 參考

注意

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

Healthcareapis 服務。

命令

名稱 Description 類型 狀態
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

將 CLI 置於等候狀態，直到符合 healthcareapis 服務的條件為止。

 擴充 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 物件識別碼（使用者或應用程式）。

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

--authentication-configuration -c

服務實例的驗證組態。

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

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

--cors-configuration

服務實例之 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 認證。

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

正在指定的身分識別類型，目前允許 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：指出服務擁有者是否已核准/拒絕/移除連線。 描述：核准/拒絕連線的原因。 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

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

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

--no-wait

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

預設值: False
--resource-group -g

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

--resource-name

服務實例的名稱。

--subscription

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

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

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

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

--resource-group -g

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

--resource-name

服務實例的名稱。

--subscription

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

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

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

--no-wait

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

預設值: False
--public-network-access

在啟用私人端點時，控制來自公用網路的資料平面流量許可權。

接受的值: Disabled, Enabled
--resource-group -g

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

--resource-name

服務實例的名稱。

--subscription

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

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

--verbose

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

az healthcareapis service wait

將 CLI 置於等候狀態，直到符合 healthcareapis 服務的條件為止。

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

範例

暫停執行下一行 CLI 腳本，直到醫療保健apis 服務成功建立為止。

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

暫停執行下一行 CLI 腳本，直到 healthcareapis 服務成功更新為止。

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

暫停執行下一行 CLI 腳本，直到成功刪除 Healthcareapis 服務為止。

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

選擇性參數

--created

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

預設值: False
--custom

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

--deleted

等到刪除為止。

預設值: False
--exists

等候資源存在。

預設值: False
--ids

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

--interval

輪詢間隔以秒為單位。

預設值: 30
--resource-group -g

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

--resource-name

服務實例的名稱。

--subscription

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

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

--verbose

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