通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az healthcareapis service

Note

This reference is part of the healthcareapis extension for the Azure CLI (version 2.66.0 or higher). 该扩展会在首次运行 az healthcareapis service 命令时自动安装。 Learn more about extensions.

Healthcareapis service.

命令

名称 说明 类型 Status
az healthcareapis service create

创建服务实例的元数据。

 Extension GA
az healthcareapis service delete

删除服务实例。

 Extension GA
az healthcareapis service list

获取资源组中的所有服务实例。 获取订阅中的所有服务实例。

 Extension GA
az healthcareapis service show

获取服务实例的元数据。

 Extension GA
az healthcareapis service update

更新服务实例的元数据。

 Extension GA
az healthcareapis service wait

将 CLI 置于等待状态，直到满足医疗保健apis 服务的条件。

 Extension 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

Location. az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--resource-name

服务实例的名称。

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-policies

服务实例的访问策略。

用法：--access-policies object-id=XX

object-id: Required. 允许访问 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 的源。 标头：允许通过 CORS 的标头。 方法：允许通过 CORS 使用的方法。 max-age：允许通过 CORS 的最大期限。 allow-credentials：如果允许凭据通过 CORS。

--cosmos-db-configuration

支持服务的 Cosmos DB 数据库的设置。

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

产品/服务吞吐量：支持数据库的预配吞吐量。 key-vault-key-uri：支持数据库的客户管理的密钥的 URI。

--etag

与资源关联的 etag，在编辑资源时用于乐观并发。

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

默认导出存储帐户的名称。

--identity-type

指定的标识类型，当前允许 SystemAssigned 和 None。

属性 值
接受的值: None, SystemAssigned
--login-servers

应添加到服务实例的登录服务器列表。

属性 值
Parameter group: Acr Configuration Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--oci-artifacts

Open Container Initiative （OCI） 项目的列表。

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

login-server：Azure 容器注册表登录服务器。 image-name：项目名称。 摘要：项目摘要。

可以使用多个 --oci-artifacts 参数指定多个作。

属性 值
Parameter group: Acr Configuration Arguments
--private-endpoint-connections

为此资源设置的专用终结点连接列表。

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

状态：指示连接是否已被服务的所有者批准/拒绝/删除。 说明：批准/拒绝连接的原因。 action-required：一条消息，指示服务提供商上的更改是否需要对使用者进行任何更新。

可以使用多个 --private-endpoint-connections 参数来指定多个作。

--public-network-access

启用专用终结点时，控制来自公用网络的数据平面流量的权限。

属性 值
接受的值: Disabled, Enabled
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az healthcareapis service delete

删除服务实例。

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

示例

Delete service

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
Parameter group: Resource Id Arguments
--resource-name

服务实例的名称。

属性 值
Parameter group: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
Parameter group: Resource Id Arguments
--yes -y

不要提示确认。

属性 值
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az healthcareapis service list

获取资源组中的所有服务实例。 获取订阅中的所有服务实例。

az healthcareapis service list [--resource-group]

示例

列出资源组中的所有服务

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

列出订阅中的所有服务

az healthcareapis service list

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az healthcareapis service show

获取服务实例的元数据。

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

示例

Get metadata

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
Parameter group: Resource Id Arguments
--resource-name

服务实例的名称。

属性 值
Parameter group: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
Parameter group: Resource Id Arguments
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az healthcareapis service update

更新服务实例的元数据。

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

示例

Patch service

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--no-wait

不等待长时间运行的操作完成。

属性 值
默认值: False
--public-network-access

启用专用终结点时，控制来自公用网络的数据平面流量的权限。

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

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
Parameter group: Resource Id Arguments
--resource-name

服务实例的名称。

属性 值
Parameter group: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
Parameter group: Resource Id Arguments
--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False

az healthcareapis service wait

将 CLI 置于等待状态，直到满足医疗保健apis 服务的条件。

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

示例

暂停执行下一行 CLI 脚本，直到成功创建 Healthcareapis 服务。

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

暂停执行下一行 CLI 脚本，直到医疗保健apis 服务成功更新。

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

暂停执行下一行 CLI 脚本，直到成功删除 Healthcareapis 服务。

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

可选参数

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

等待在“Succeeded”中使用“provisioningState”创建。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

属性 值
Parameter group: Wait Condition Arguments
--deleted

等到删除为止。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--exists

等待资源存在。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性 值
Parameter group: Resource Id Arguments
--interval

轮询间隔（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 30
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性 值
Parameter group: Resource Id Arguments
--resource-name

服务实例的名称。

属性 值
Parameter group: Resource Id Arguments
--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性 值
Parameter group: Resource Id Arguments
--timeout

最大等待（以秒为单位）。

属性 值
Parameter group: Wait Condition Arguments
默认值: 3600
--updated

等到 provisioningState 更新为“Succeeded”。

属性 值
Parameter group: Wait Condition Arguments
默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

属性 值
默认值: False
--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性 值
默认值: False
--output -o

Output format.

属性 值
默认值: json
接受的值: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性 值
默认值: False