Services - List

Get all the service instances in a subscription.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True

string

The subscription identifier.

api-version
query True

string

Client Api Version.

Responses

Name Type Description
200 OK

ServicesDescriptionListResult

This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

List all services in subscription

Sample request

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

Sample response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/service1",
      "name": "service1",
      "location": "West US",
      "type": "Microsoft.HealthcareApis/services",
      "kind": "fhir-R4",
      "etag": "etag",
      "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
        },
        "privateEndpointConnections": [],
        "publicNetworkAccess": "Disabled"
      }
    }
  ],
  "nextLink": "https://host/subscriptions/subid/providers/Microsoft.HealthcareApis/services?api-version=2018-08-20-preview&%24skipToken=e30%3d"
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorDetails

Error details.

ErrorDetailsInternal

Error details.

Identity

Setting indicating whether the service has a managed identity associated with it.

kind

The kind of the service.

ManagedServiceIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.

PrivateEndpoint

The Private Endpoint resource.

PrivateEndpointConnection

The Private Endpoint Connection resource.

PrivateEndpointConnectionProvisioningState

The current provisioning state.

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

provisioningState

The provisioning state.

PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

ServiceAccessPolicyEntry

An access policy entry.

ServiceAcrConfigurationInfo

Azure container registry configuration information

ServiceAuthenticationConfigurationInfo

Authentication configuration information

ServiceCorsConfigurationInfo

The settings for the CORS configuration of the service instance.

ServiceCosmosDbConfigurationInfo

The settings for the Cosmos DB database backing the service.

ServiceExportConfigurationInfo

Export operation configuration information

ServiceImportConfigurationInfo

Import operation configuration information

ServiceOciArtifactEntry

An Open Container Initiative (OCI) artifact.

ServicesDescription

The description of the service.

ServicesDescriptionListResult

A list of service description objects with a next link.

ServicesProperties

The properties of a service instance.

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDetails

Error details.

Name Type Description
error

ErrorDetailsInternal

Error details

ErrorDetailsInternal

Error details.

Name Type Description
code

string

The error code.

message

string

The error message.

target

string

The target of the particular error.

Identity

Setting indicating whether the service has a managed identity associated with it.

Name Type Description
principalId

string

The principal ID of the resource identity.

tenantId

string

The tenant ID of the resource.

type

ManagedServiceIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.

kind

The kind of the service.

Name Type Description
fhir

string

fhir-R4

string

fhir-Stu3

string

ManagedServiceIdentityType

Type of identity being specified, currently SystemAssigned and None are allowed.

Name Type Description
None

string

SystemAssigned

string

PrivateEndpoint

The Private Endpoint resource.

Name Type Description
id

string

The ARM identifier for Private Endpoint

PrivateEndpointConnection

The Private Endpoint Connection resource.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.privateEndpoint

PrivateEndpoint

The resource of private end point.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state of the private endpoint connection resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The current provisioning state.

Name Type Description
Creating

string

Deleting

string

Failed

string

Succeeded

string

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.

Name Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

Name Type Description
actionsRequired

string

A message indicating if changes on the service provider require any updates on the consumer.

description

string

The reason for approval/rejection of the connection.

status

PrivateEndpointServiceConnectionStatus

Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

provisioningState

The provisioning state.

Name Type Description
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

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

Name Type Description
Disabled

string

Enabled

string

ServiceAccessPolicyEntry

An access policy entry.

Name Type Description
objectId

string

An Azure AD object ID (User or Apps) that is allowed access to the FHIR service.

ServiceAcrConfigurationInfo

Azure container registry configuration information

Name Type Description
loginServers

string[]

The list of the ACR login servers.

ociArtifacts

ServiceOciArtifactEntry[]

The list of Open Container Initiative (OCI) artifacts.

ServiceAuthenticationConfigurationInfo

Authentication configuration information

Name Type Description
audience

string

The audience url for the service

authority

string

The authority url for the service

smartProxyEnabled

boolean

If the SMART on FHIR proxy is enabled

ServiceCorsConfigurationInfo

The settings for the CORS configuration of the service instance.

Name Type Description
allowCredentials

boolean

If credentials are allowed via CORS.

headers

string[]

The headers to be allowed via CORS.

maxAge

integer

The max age to be allowed via CORS.

methods

string[]

The methods to be allowed via CORS.

origins

string[]

The origins to be allowed via CORS.

ServiceCosmosDbConfigurationInfo

The settings for the Cosmos DB database backing the service.

Name Type Description
keyVaultKeyUri

string

The URI of the customer-managed key for the backing database.

offerThroughput

integer

The provisioned throughput for the backing database.

ServiceExportConfigurationInfo

Export operation configuration information

Name Type Description
storageAccountName

string

The name of the default export storage account.

ServiceImportConfigurationInfo

Import operation configuration information

Name Type Description
enabled

boolean

If the import operation is enabled.

initialImportMode

boolean

If the FHIR service is in InitialImportMode.

integrationDataStore

string

The name of the default integration storage account.

ServiceOciArtifactEntry

An Open Container Initiative (OCI) artifact.

Name Type Description
digest

string

The artifact digest.

imageName

string

The artifact name.

loginServer

string

The Azure Container Registry login server.

ServicesDescription

The description of the service.

Name Type Description
etag

string

An etag associated with the resource, used for optimistic concurrency when editing it.

id

string

The resource identifier.

identity

Identity

Setting indicating whether the service has a managed identity associated with it.

kind

kind

The kind of the service.

location

string

The resource location.

name

string

The resource name.

properties

ServicesProperties

The common properties of a service.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

tags

object

The resource tags.

type

string

The resource type.

ServicesDescriptionListResult

A list of service description objects with a next link.

Name Type Description
nextLink

string

The link used to get the next page of service description objects.

value

ServicesDescription[]

A list of service description objects.

ServicesProperties

The properties of a service instance.

Name Type Description
accessPolicies

ServiceAccessPolicyEntry[]

The access policies of the service instance.

acrConfiguration

ServiceAcrConfigurationInfo

The azure container registry settings used for convert data operation of the service instance.

authenticationConfiguration

ServiceAuthenticationConfigurationInfo

The authentication configuration for the service instance.

corsConfiguration

ServiceCorsConfigurationInfo

The settings for the CORS configuration of the service instance.

cosmosDbConfiguration

ServiceCosmosDbConfigurationInfo

The settings for the Cosmos DB database backing the service.

exportConfiguration

ServiceExportConfigurationInfo

The settings for the export operation of the service instance.

importConfiguration

ServiceImportConfigurationInfo

The settings for the import operation of the service instance.

privateEndpointConnections

PrivateEndpointConnection[]

The list of private endpoint connections that are set up for this resource.

provisioningState

provisioningState

The provisioning state.

publicNetworkAccess

PublicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.