Services - List By Resource Group

Service:

Healthcare Apis

API Version:

2022-06-01

Get all the service instances in a resource group.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the service instance. Regex pattern: ^[-\w\._\(\)]+$
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 resource group.
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 resource group

Sample request

HTTP

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.healthcareapis import HealthcareApisManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-healthcareapis
# USAGE
    python service_list_by_resource_group.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HealthcareApisManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.list_by_resource_group(
        resource_group_name="rgname",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceListByResourceGroup.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HealthcareApis;
using Azure.ResourceManager.HealthcareApis.Models;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/healthcareapis/resource-manager/Microsoft.HealthcareApis/stable/2022-06-01/examples/legacy/ServiceListByResourceGroup.json
// this example is just showing the usage of "Services_ListByResourceGroup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rgname";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this HealthcareApisServiceResource
HealthcareApisServiceCollection collection = resourceGroupResource.GetHealthcareApisServices();

// invoke the operation and iterate over the result
await foreach (HealthcareApisServiceResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    HealthcareApisServiceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HealthcareApis/services/dddb8dcb-effb-4290-bb47-ce1e8440c729",
      "name": "service1",
      "location": "westus",
      "type": "Microsoft.HealthcareApis/services",
      "kind": "fhir-R4",
      "tags": {},
      "etag": "etagvalue",
      "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/resourceGroups/rgname/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.