通过

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

az healthcareapis workspace fhir-service

  • 参考

注意

此参考是 Azure CLI（版本 2.15.0 或更高版本）的医疗保健apis 扩展的一部分。 该扩展将在首次运行 az healthcareapis workspace fhir-service 命令时自动安装。 详细了解扩展。

使用 Healthcareapis 管理hir 服务。

命令

名称 说明 类型 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

将 CLI 置于等待状态，直到满足医疗保健apis 工作区 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 对象 ID（用户或应用）。

可以使用多个 --access-policies 参数指定多个操作。

--authentication-configuration -c

Fhir 服务身份验证配置。

用法：--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 的源。 标头：允许通过 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

Location。 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 容器注册表登录服务器。 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

与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/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

订阅的名称或 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

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

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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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

与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 预期值：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

将 CLI 置于等待状态，直到满足医疗保健apis 工作区 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

一个或多个资源 ID（空格分隔）。 它应该是包含“资源 ID”参数的所有信息的完整资源 ID。 应提供 --id 或其他“资源 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 获取完整的调试日志。