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

Services - Create Or Update

创建或更新服务实例的元数据。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services/{resourceName}?api-version=2022-06-01

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

包含服务实例的资源组的名称。

正则表达式模式: ^[-\w\._\(\)]+$

resourceName
path True

string

服务实例的名称。

subscriptionId
path True

string

订阅标识符。

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
kind True

kind

服务的种类。

location True

string

资源位置。

etag

string

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

identity

Identity

指示服务是否具有与之关联的托管标识的设置。

properties

ServicesProperties

服务的通用属性。

tags

object

资源标记。

响应

名称 类型 说明
200 OK

ServicesDescription

已更新 - 接受放置请求并正在更新现有资源;操作将以异步方式完成。

201 Created

ServicesDescription

已创建 - 接受放置请求并创建了一个新资源;操作将以异步方式完成。

Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Create or Update a service with all parameters
Create or Update a service with minimum parameters

Create or Update a service with all parameters

示例请求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1?api-version=2022-06-01

{
  "location": "westus2",
  "tags": {},
  "kind": "fhir-R4",
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key"
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": "https://my-vault.vault.azure.net/keys/my-key"
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
  "name": "service1",
  "location": "West US 2",
  "type": "Microsoft.HealthcareApis/services",
  "kind": "fhir-R4",
  "etag": "etagvalue",
  "tags": {},
  "properties": {
    "provisioningState": "Creating",
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      },
      {
        "objectId": "5b307da8-43d4-492b-8b66-b0294ade872f"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": true
    },
    "corsConfiguration": {
      "origins": [
        "*"
      ],
      "headers": [
        "*"
      ],
      "methods": [
        "DELETE",
        "GET",
        "OPTIONS",
        "PATCH",
        "POST",
        "PUT"
      ],
      "maxAge": 1440,
      "allowCredentials": false
    },
    "exportConfiguration": {
      "storageAccountName": "existingStorageAccount"
    },
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  },
  "identity": {
    "principalId": "03fe6ae0-952c-4e4b-954b-cc0364dd252e",
    "tenantId": "72f988bf-86f1-41af-91ab-2d8cd011db47",
    "type": "SystemAssigned"
  }
}

Create or Update a service with minimum parameters

示例请求

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2?api-version=2022-06-01

{
  "location": "westus2",
  "tags": {},
  "kind": "fhir-R4",
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ]
  }
}

示例响应

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service2",
  "name": "service2",
  "type": "Microsoft.HealthcareApis/services",
  "etag": "etagvalue",
  "location": "westus2",
  "kind": "fhir-R4",
  "tags": {},
  "properties": {
    "accessPolicies": [
      {
        "objectId": "c487e7d1-3210-41a3-8ccc-e9372b78da47"
      }
    ],
    "cosmosDbConfiguration": {
      "offerThroughput": 1000,
      "keyVaultKeyUri": null
    },
    "authenticationConfiguration": {
      "authority": "https://login.microsoftonline.com/abfde7b2-df0f-47e6-aabf-2462b07508dc",
      "audience": "https://azurehealthcareapis.com",
      "smartProxyEnabled": false
    },
    "corsConfiguration": {
      "origins": [],
      "headers": [],
      "methods": [],
      "maxAge": null,
      "allowCredentials": false
    },
    "provisioningState": "Creating",
    "privateEndpointConnections": [],
    "publicNetworkAccess": "Disabled"
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorDetails

错误详细信息。

ErrorDetailsInternal

错误详细信息。

Identity

指示服务是否具有与之关联的托管标识的设置。

kind

服务的种类。

ManagedServiceIdentityType

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

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

provisioningState

预配状态。

PublicNetworkAccess

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

ServiceAccessPolicyEntry

访问策略条目。

ServiceAcrConfigurationInfo

Azure 容器注册表配置信息

ServiceAuthenticationConfigurationInfo

身份验证配置信息

ServiceCorsConfigurationInfo

服务实例的 CORS 配置设置。

ServiceCosmosDbConfigurationInfo

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

ServiceExportConfigurationInfo

导出操作配置信息

ServiceImportConfigurationInfo

导入操作配置信息

ServiceOciArtifactEntry

开放容器计划 (OCI) 项目。

ServicesDescription

服务的说明。

ServicesProperties

服务实例的属性。

systemData

与资源的创建和上次修改相关的元数据。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

错误详细信息。

名称 类型 说明
error

ErrorDetailsInternal

错误详细信息

ErrorDetailsInternal

错误详细信息。

名称 类型 说明
code

string

错误代码。

message

string

错误消息。

target

string

特定错误的目标。

Identity

指示服务是否具有与之关联的托管标识的设置。

名称 类型 说明
principalId

string

资源标识的主体 ID。

tenantId

string

资源的租户 ID。

type

ManagedServiceIdentityType

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

kind

服务的种类。

名称 类型 说明
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

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

名称 类型 说明
None

string

SystemAssigned

string

PrivateEndpoint

专用终结点资源。

名称 类型 说明
id

string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.privateEndpoint

PrivateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

properties.provisioningState

PrivateEndpointConnectionProvisioningState

专用终结点连接资源的预配状态。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称 类型 说明
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

有关服务使用者和提供程序之间的连接状态的信息集合。

名称 类型 说明
actionsRequired

string

一条消息,指示服务提供商的更改是否需要对使用者进行任何更新。

description

string

批准/拒绝连接的原因。

status

PrivateEndpointServiceConnectionStatus

指示连接是否已由服务的所有者批准/拒绝/删除。

provisioningState

预配状态。

名称 类型 说明
Accepted

string

Canceled

string

Creating

string

Deleting

string

Deprovisioned

string

Failed

string

Moving

string

Succeeded

string

Suspended

string

SystemMaintenance

string

Updating

string

Verifying

string

Warned

string

PublicNetworkAccess

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

名称 类型 说明
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

访问策略条目。

名称 类型 说明
objectId

string

Azure AD 对象 ID (允许访问 FHIR 服务的用户或应用) 。

ServiceAcrConfigurationInfo

Azure 容器注册表配置信息

名称 类型 说明
loginServers

string[]

ACR 登录服务器的列表。

ociArtifacts

ServiceOciArtifactEntry[]

开放容器计划列表 (OCI) 项目。

ServiceAuthenticationConfigurationInfo

身份验证配置信息

名称 类型 说明
audience

string

服务的受众 URL

authority

string

服务的颁发机构 URL

smartProxyEnabled

boolean

如果启用了 SMART on FHIR 代理

ServiceCorsConfigurationInfo

服务实例的 CORS 配置设置。

名称 类型 说明
allowCredentials

boolean

如果允许通过 CORS 使用凭据。

headers

string[]

允许通过 CORS 的标头。

maxAge

integer

通过 CORS 允许的最大期限。

methods

string[]

允许通过 CORS 使用的方法。

origins

string[]

允许通过 CORS 的源。

ServiceCosmosDbConfigurationInfo

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

名称 类型 说明
keyVaultKeyUri

string

支持数据库的客户管理的密钥的 URI。

offerThroughput

integer

后备数据库的预配吞吐量。

ServiceExportConfigurationInfo

导出操作配置信息

名称 类型 说明
storageAccountName

string

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

ServiceImportConfigurationInfo

导入操作配置信息

名称 类型 说明
enabled

boolean

如果启用了导入操作。

initialImportMode

boolean

如果 FHIR 服务位于 InitialImportMode 中。

integrationDataStore

string

默认集成存储帐户的名称。

ServiceOciArtifactEntry

开放容器计划 (OCI) 项目。

名称 类型 说明
digest

string

项目摘要。

imageName

string

项目名称。

loginServer

string

Azure 容器注册表登录服务器。

ServicesDescription

服务的说明。

名称 类型 说明
etag

string

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

id

string

资源标识符。

identity

Identity

指示服务是否具有与之关联的托管标识的设置。

kind

kind

服务的种类。

location

string

资源位置。

name

string

资源名称。

properties

ServicesProperties

服务的通用属性。

systemData

systemData

与资源的创建和上次修改相关的元数据。

tags

object

资源标记。

type

string

资源类型。

ServicesProperties

服务实例的属性。

名称 类型 说明
accessPolicies

ServiceAccessPolicyEntry[]

服务实例的访问策略。

acrConfiguration

ServiceAcrConfigurationInfo

用于转换服务实例的数据操作的 azure 容器注册表设置。

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

服务实例的身份验证配置。

corsConfiguration

ServiceCorsConfigurationInfo

服务实例的 CORS 配置设置。

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

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

exportConfiguration

ServiceExportConfigurationInfo

服务实例的导出操作的设置。

importConfiguration

ServiceImportConfigurationInfo

服务实例的导入操作的设置。

privateEndpointConnections

PrivateEndpointConnection[]

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

provisioningState

provisioningState

预配状态。

publicNetworkAccess

PublicNetworkAccess

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

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。