Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. healthcare
  5. Service

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.healthcare.Service

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Healthcare Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.core.getClientConfig({});
const example = new azure.healthcare.Service("example", {
    name: "uniquefhirname",
    resourceGroupName: "sample-resource-group",
    location: "westus2",
    kind: "fhir-R4",
    cosmosdbThroughput: 2000,
    identity: {
        type: "SystemAssigned",
    },
    accessPolicyObjectIds: current.then(current => current.objectId),
    configurationExportStorageAccountName: "teststorage",
    tags: {
        environment: "testenv",
        purpose: "AcceptanceTests",
    },
    authenticationConfiguration: {
        authority: "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
        audience: "https://azurehealthcareapis.com/",
        smartProxyEnabled: true,
    },
    corsConfiguration: {
        allowedOrigins: [
            "http://www.example.com",
            "http://www.example2.com",
        ],
        allowedHeaders: [
            "x-tempo-*",
            "x-tempo2-*",
        ],
        allowedMethods: [
            "GET",
            "PUT",
        ],
        maxAgeInSeconds: 500,
        allowCredentials: true,
    },
});
Copy
import pulumi
import pulumi_azure as azure

current = azure.core.get_client_config()
example = azure.healthcare.Service("example",
    name="uniquefhirname",
    resource_group_name="sample-resource-group",
    location="westus2",
    kind="fhir-R4",
    cosmosdb_throughput=2000,
    identity={
        "type": "SystemAssigned",
    },
    access_policy_object_ids=current.object_id,
    configuration_export_storage_account_name="teststorage",
    tags={
        "environment": "testenv",
        "purpose": "AcceptanceTests",
    },
    authentication_configuration={
        "authority": "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
        "audience": "https://azurehealthcareapis.com/",
        "smart_proxy_enabled": True,
    },
    cors_configuration={
        "allowed_origins": [
            "http://www.example.com",
            "http://www.example2.com",
        ],
        "allowed_headers": [
            "x-tempo-*",
            "x-tempo2-*",
        ],
        "allowed_methods": [
            "GET",
            "PUT",
        ],
        "max_age_in_seconds": 500,
        "allow_credentials": True,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/healthcare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		current, err := core.GetClientConfig(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		_, err = healthcare.NewService(ctx, "example", &healthcare.ServiceArgs{
			Name:               pulumi.String("uniquefhirname"),
			ResourceGroupName:  pulumi.String("sample-resource-group"),
			Location:           pulumi.String("westus2"),
			Kind:               pulumi.String("fhir-R4"),
			CosmosdbThroughput: pulumi.Int(2000),
			Identity: &healthcare.ServiceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			AccessPolicyObjectIds:                 pulumi.String(current.ObjectId),
			ConfigurationExportStorageAccountName: pulumi.String("teststorage"),
			Tags: pulumi.StringMap{
				"environment": pulumi.String("testenv"),
				"purpose":     pulumi.String("AcceptanceTests"),
			},
			AuthenticationConfiguration: &healthcare.ServiceAuthenticationConfigurationArgs{
				Authority:         pulumi.String("https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D"),
				Audience:          pulumi.String("https://azurehealthcareapis.com/"),
				SmartProxyEnabled: pulumi.Bool(true),
			},
			CorsConfiguration: &healthcare.ServiceCorsConfigurationArgs{
				AllowedOrigins: pulumi.StringArray{
					pulumi.String("http://www.example.com"),
					pulumi.String("http://www.example2.com"),
				},
				AllowedHeaders: pulumi.StringArray{
					pulumi.String("x-tempo-*"),
					pulumi.String("x-tempo2-*"),
				},
				AllowedMethods: pulumi.StringArray{
					pulumi.String("GET"),
					pulumi.String("PUT"),
				},
				MaxAgeInSeconds:  pulumi.Int(500),
				AllowCredentials: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var current = Azure.Core.GetClientConfig.Invoke();

    var example = new Azure.Healthcare.Service("example", new()
    {
        Name = "uniquefhirname",
        ResourceGroupName = "sample-resource-group",
        Location = "westus2",
        Kind = "fhir-R4",
        CosmosdbThroughput = 2000,
        Identity = new Azure.Healthcare.Inputs.ServiceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        AccessPolicyObjectIds = current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
        ConfigurationExportStorageAccountName = "teststorage",
        Tags = 
        {
            { "environment", "testenv" },
            { "purpose", "AcceptanceTests" },
        },
        AuthenticationConfiguration = new Azure.Healthcare.Inputs.ServiceAuthenticationConfigurationArgs
        {
            Authority = "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
            Audience = "https://azurehealthcareapis.com/",
            SmartProxyEnabled = true,
        },
        CorsConfiguration = new Azure.Healthcare.Inputs.ServiceCorsConfigurationArgs
        {
            AllowedOrigins = new[]
            {
                "http://www.example.com",
                "http://www.example2.com",
            },
            AllowedHeaders = new[]
            {
                "x-tempo-*",
                "x-tempo2-*",
            },
            AllowedMethods = new[]
            {
                "GET",
                "PUT",
            },
            MaxAgeInSeconds = 500,
            AllowCredentials = true,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.healthcare.Service;
import com.pulumi.azure.healthcare.ServiceArgs;
import com.pulumi.azure.healthcare.inputs.ServiceIdentityArgs;
import com.pulumi.azure.healthcare.inputs.ServiceAuthenticationConfigurationArgs;
import com.pulumi.azure.healthcare.inputs.ServiceCorsConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var current = CoreFunctions.getClientConfig();

        var example = new Service("example", ServiceArgs.builder()
            .name("uniquefhirname")
            .resourceGroupName("sample-resource-group")
            .location("westus2")
            .kind("fhir-R4")
            .cosmosdbThroughput("2000")
            .identity(ServiceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .accessPolicyObjectIds(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
            .configurationExportStorageAccountName("teststorage")
            .tags(Map.ofEntries(
                Map.entry("environment", "testenv"),
                Map.entry("purpose", "AcceptanceTests")
            ))
            .authenticationConfiguration(ServiceAuthenticationConfigurationArgs.builder()
                .authority("https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D")
                .audience("https://azurehealthcareapis.com/")
                .smartProxyEnabled("true")
                .build())
            .corsConfiguration(ServiceCorsConfigurationArgs.builder()
                .allowedOrigins(                
                    "http://www.example.com",
                    "http://www.example2.com")
                .allowedHeaders(                
                    "x-tempo-*",
                    "x-tempo2-*")
                .allowedMethods(                
                    "GET",
                    "PUT")
                .maxAgeInSeconds("500")
                .allowCredentials("true")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:healthcare:Service
    properties:
      name: uniquefhirname
      resourceGroupName: sample-resource-group
      location: westus2
      kind: fhir-R4
      cosmosdbThroughput: '2000'
      identity:
        type: SystemAssigned
      accessPolicyObjectIds: ${current.objectId}
      configurationExportStorageAccountName: teststorage
      tags:
        environment: testenv
        purpose: AcceptanceTests
      authenticationConfiguration:
        authority: https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D
        audience: https://azurehealthcareapis.com/
        smartProxyEnabled: 'true'
      corsConfiguration:
        allowedOrigins:
          - http://www.example.com
          - http://www.example2.com
        allowedHeaders:
          - x-tempo-*
          - x-tempo2-*
        allowedMethods:
          - GET
          - PUT
        maxAgeInSeconds: '500'
        allowCredentials: 'true'
variables:
  current:
    fn::invoke:
      function: azure:core:getClientConfig
      arguments: {}
Copy

Create Service Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);
@overload
def Service(resource_name: str,
            args: ServiceArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Service(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            resource_group_name: Optional[str] = None,
            identity: Optional[ServiceIdentityArgs] = None,
            configuration_export_storage_account_name: Optional[str] = None,
            cors_configuration: Optional[ServiceCorsConfigurationArgs] = None,
            cosmosdb_key_vault_key_versionless_id: Optional[str] = None,
            cosmosdb_throughput: Optional[int] = None,
            access_policy_object_ids: Optional[Sequence[str]] = None,
            kind: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            public_network_access_enabled: Optional[bool] = None,
            authentication_configuration: Optional[ServiceAuthenticationConfigurationArgs] = None,
            tags: Optional[Mapping[str, str]] = None)
func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)
public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)
public Service(String name, ServiceArgs args)
public Service(String name, ServiceArgs args, CustomResourceOptions options)

type: azure:healthcare:Service
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleserviceResourceResourceFromHealthcareservice = new Azure.Healthcare.Service("exampleserviceResourceResourceFromHealthcareservice", new()
{
    ResourceGroupName = "string",
    Identity = new Azure.Healthcare.Inputs.ServiceIdentityArgs
    {
        Type = "string",
        PrincipalId = "string",
        TenantId = "string",
    },
    ConfigurationExportStorageAccountName = "string",
    CorsConfiguration = new Azure.Healthcare.Inputs.ServiceCorsConfigurationArgs
    {
        AllowCredentials = false,
        AllowedHeaders = new[]
        {
            "string",
        },
        AllowedMethods = new[]
        {
            "string",
        },
        AllowedOrigins = new[]
        {
            "string",
        },
        MaxAgeInSeconds = 0,
    },
    CosmosdbKeyVaultKeyVersionlessId = "string",
    CosmosdbThroughput = 0,
    AccessPolicyObjectIds = new[]
    {
        "string",
    },
    Kind = "string",
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    AuthenticationConfiguration = new Azure.Healthcare.Inputs.ServiceAuthenticationConfigurationArgs
    {
        Audience = "string",
        Authority = "string",
        SmartProxyEnabled = false,
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := healthcare.NewService(ctx, "exampleserviceResourceResourceFromHealthcareservice", &healthcare.ServiceArgs{
	ResourceGroupName: pulumi.String("string"),
	Identity: &healthcare.ServiceIdentityArgs{
		Type:        pulumi.String("string"),
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	ConfigurationExportStorageAccountName: pulumi.String("string"),
	CorsConfiguration: &healthcare.ServiceCorsConfigurationArgs{
		AllowCredentials: pulumi.Bool(false),
		AllowedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxAgeInSeconds: pulumi.Int(0),
	},
	CosmosdbKeyVaultKeyVersionlessId: pulumi.String("string"),
	CosmosdbThroughput:               pulumi.Int(0),
	AccessPolicyObjectIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Kind:                       pulumi.String("string"),
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	AuthenticationConfiguration: &healthcare.ServiceAuthenticationConfigurationArgs{
		Audience:          pulumi.String("string"),
		Authority:         pulumi.String("string"),
		SmartProxyEnabled: pulumi.Bool(false),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleserviceResourceResourceFromHealthcareservice = new Service("exampleserviceResourceResourceFromHealthcareservice", ServiceArgs.builder()
    .resourceGroupName("string")
    .identity(ServiceIdentityArgs.builder()
        .type("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .configurationExportStorageAccountName("string")
    .corsConfiguration(ServiceCorsConfigurationArgs.builder()
        .allowCredentials(false)
        .allowedHeaders("string")
        .allowedMethods("string")
        .allowedOrigins("string")
        .maxAgeInSeconds(0)
        .build())
    .cosmosdbKeyVaultKeyVersionlessId("string")
    .cosmosdbThroughput(0)
    .accessPolicyObjectIds("string")
    .kind("string")
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .authenticationConfiguration(ServiceAuthenticationConfigurationArgs.builder()
        .audience("string")
        .authority("string")
        .smartProxyEnabled(false)
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleservice_resource_resource_from_healthcareservice = azure.healthcare.Service("exampleserviceResourceResourceFromHealthcareservice",
    resource_group_name="string",
    identity={
        "type": "string",
        "principal_id": "string",
        "tenant_id": "string",
    },
    configuration_export_storage_account_name="string",
    cors_configuration={
        "allow_credentials": False,
        "allowed_headers": ["string"],
        "allowed_methods": ["string"],
        "allowed_origins": ["string"],
        "max_age_in_seconds": 0,
    },
    cosmosdb_key_vault_key_versionless_id="string",
    cosmosdb_throughput=0,
    access_policy_object_ids=["string"],
    kind="string",
    location="string",
    name="string",
    public_network_access_enabled=False,
    authentication_configuration={
        "audience": "string",
        "authority": "string",
        "smart_proxy_enabled": False,
    },
    tags={
        "string": "string",
    })
Copy
const exampleserviceResourceResourceFromHealthcareservice = new azure.healthcare.Service("exampleserviceResourceResourceFromHealthcareservice", {
    resourceGroupName: "string",
    identity: {
        type: "string",
        principalId: "string",
        tenantId: "string",
    },
    configurationExportStorageAccountName: "string",
    corsConfiguration: {
        allowCredentials: false,
        allowedHeaders: ["string"],
        allowedMethods: ["string"],
        allowedOrigins: ["string"],
        maxAgeInSeconds: 0,
    },
    cosmosdbKeyVaultKeyVersionlessId: "string",
    cosmosdbThroughput: 0,
    accessPolicyObjectIds: ["string"],
    kind: "string",
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    authenticationConfiguration: {
        audience: "string",
        authority: "string",
        smartProxyEnabled: false,
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure:healthcare:Service
properties:
    accessPolicyObjectIds:
        - string
    authenticationConfiguration:
        audience: string
        authority: string
        smartProxyEnabled: false
    configurationExportStorageAccountName: string
    corsConfiguration:
        allowCredentials: false
        allowedHeaders:
            - string
        allowedMethods:
            - string
        allowedOrigins:
            - string
        maxAgeInSeconds: 0
    cosmosdbKeyVaultKeyVersionlessId: string
    cosmosdbThroughput: 0
    identity:
        principalId: string
        tenantId: string
        type: string
    kind: string
    location: string
    name: string
    publicNetworkAccessEnabled: false
    resourceGroupName: string
    tags:
        string: string
Copy

Service Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Service resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
AccessPolicyObjectIds List<string>
AuthenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
ConfigurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
CorsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

CosmosdbThroughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
Identity ServiceIdentity
An identity block as defined below.
Kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

Name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
AccessPolicyObjectIds []string
AuthenticationConfiguration ServiceAuthenticationConfigurationArgs
An authentication_configuration block as defined below.
ConfigurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
CorsConfiguration ServiceCorsConfigurationArgs
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

CosmosdbThroughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
Identity ServiceIdentityArgs
An identity block as defined below.
Kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

Name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
Tags map[string]string
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
accessPolicyObjectIds List<String>
authenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
configurationExportStorageAccountName String
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. String

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput Integer
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentity
An identity block as defined below.
kind String
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. String

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. String
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
tags Map<String,String>
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
accessPolicyObjectIds string[]
authenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
configurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput number
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentity
An identity block as defined below.
kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
access_policy_object_ids Sequence[str]
authentication_configuration ServiceAuthenticationConfigurationArgs
An authentication_configuration block as defined below.
configuration_export_storage_account_name str
Specifies the name of the storage account which the operation configuration information is exported to.
cors_configuration ServiceCorsConfigurationArgs
A cors_configuration block as defined below.
cosmosdb_key_vault_key_versionless_id Changes to this property will trigger replacement. str

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdb_throughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentityArgs
An identity block as defined below.
kind str
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. str

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. str
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
public_network_access_enabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
accessPolicyObjectIds List<String>
authenticationConfiguration Property Map
An authentication_configuration block as defined below.
configurationExportStorageAccountName String
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration Property Map
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. String

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput Number
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity Property Map
An identity block as defined below.
kind String
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. String

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. String
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Service Resource

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Service
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_policy_object_ids: Optional[Sequence[str]] = None,
        authentication_configuration: Optional[ServiceAuthenticationConfigurationArgs] = None,
        configuration_export_storage_account_name: Optional[str] = None,
        cors_configuration: Optional[ServiceCorsConfigurationArgs] = None,
        cosmosdb_key_vault_key_versionless_id: Optional[str] = None,
        cosmosdb_throughput: Optional[int] = None,
        identity: Optional[ServiceIdentityArgs] = None,
        kind: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        public_network_access_enabled: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Service
func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
public static Service get(String name, Output<String> id, ServiceState state, CustomResourceOptions options)
resources:  _:    type: azure:healthcare:Service    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AccessPolicyObjectIds List<string>
AuthenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
ConfigurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
CorsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

CosmosdbThroughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
Identity ServiceIdentity
An identity block as defined below.
Kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

Name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AccessPolicyObjectIds []string
AuthenticationConfiguration ServiceAuthenticationConfigurationArgs
An authentication_configuration block as defined below.
ConfigurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
CorsConfiguration ServiceCorsConfigurationArgs
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

CosmosdbThroughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
Identity ServiceIdentityArgs
An identity block as defined below.
Kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

Name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
PublicNetworkAccessEnabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
Tags map[string]string
A mapping of tags to assign to the resource.
accessPolicyObjectIds List<String>
authenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
configurationExportStorageAccountName String
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. String

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput Integer
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentity
An identity block as defined below.
kind String
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. String

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. String
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
tags Map<String,String>
A mapping of tags to assign to the resource.
accessPolicyObjectIds string[]
authenticationConfiguration ServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
configurationExportStorageAccountName string
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration ServiceCorsConfiguration
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. string

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput number
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentity
An identity block as defined below.
kind string
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. string

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. string
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
access_policy_object_ids Sequence[str]
authentication_configuration ServiceAuthenticationConfigurationArgs
An authentication_configuration block as defined below.
configuration_export_storage_account_name str
Specifies the name of the storage account which the operation configuration information is exported to.
cors_configuration ServiceCorsConfigurationArgs
A cors_configuration block as defined below.
cosmosdb_key_vault_key_versionless_id Changes to this property will trigger replacement. str

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdb_throughput int
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity ServiceIdentityArgs
An identity block as defined below.
kind str
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. str

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. str
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
public_network_access_enabled bool
Whether public network access is enabled or disabled for this service instance. Defaults to true.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
accessPolicyObjectIds List<String>
authenticationConfiguration Property Map
An authentication_configuration block as defined below.
configurationExportStorageAccountName String
Specifies the name of the storage account which the operation configuration information is exported to.
corsConfiguration Property Map
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId Changes to this property will trigger replacement. String

A versionless Key Vault Key ID for CMK encryption of the backing database. Changing this forces a new resource to be created.

Please Note: In order to use a Custom Key from Key Vault for encryption you must grant Azure Cosmos DB Service access to your key vault. For instructions on how to configure your Key Vault correctly please refer to the product documentation

cosmosdbThroughput Number
The provisioned throughput for the backing database. Range of 400-100000. Defaults to 1000.
identity Property Map
An identity block as defined below.
kind String
The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location Changes to this property will trigger replacement. String

Specifies the supported Azure Region where the Service should be created. Changing this forces a new resource to be created.

Please Note: Not all locations support this resource. Some are West US 2, North Central US, and UK West.

name Changes to this property will trigger replacement. String
The name of the service instance. Used for service endpoint, must be unique within the audience. Changing this forces a new resource to be created.
publicNetworkAccessEnabled Boolean
Whether public network access is enabled or disabled for this service instance. Defaults to true.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which to create the Service. Changing this forces a new resource to be created.
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

ServiceAuthenticationConfiguration
, ServiceAuthenticationConfigurationArgs

Audience string
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
Authority string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
SmartProxyEnabled bool
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.
Audience string
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
Authority string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
SmartProxyEnabled bool
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.
audience String
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority String
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
smartProxyEnabled Boolean
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.
audience string
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
smartProxyEnabled boolean
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.
audience str
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority str
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
smart_proxy_enabled bool
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.
audience String
The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority String
The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.
smartProxyEnabled Boolean
(Boolean) Enables the 'SMART on FHIR' option for mobile and web implementations.

ServiceCorsConfiguration
, ServiceCorsConfigurationArgs

AllowCredentials bool
(Boolean) If credentials are allowed via CORS.
AllowedHeaders List<string>
A set of headers to be allowed via CORS.
AllowedMethods List<string>
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
AllowedOrigins List<string>
A set of origins to be allowed via CORS.
MaxAgeInSeconds int
The max age to be allowed via CORS.
AllowCredentials bool
(Boolean) If credentials are allowed via CORS.
AllowedHeaders []string
A set of headers to be allowed via CORS.
AllowedMethods []string
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
AllowedOrigins []string
A set of origins to be allowed via CORS.
MaxAgeInSeconds int
The max age to be allowed via CORS.
allowCredentials Boolean
(Boolean) If credentials are allowed via CORS.
allowedHeaders List<String>
A set of headers to be allowed via CORS.
allowedMethods List<String>
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
allowedOrigins List<String>
A set of origins to be allowed via CORS.
maxAgeInSeconds Integer
The max age to be allowed via CORS.
allowCredentials boolean
(Boolean) If credentials are allowed via CORS.
allowedHeaders string[]
A set of headers to be allowed via CORS.
allowedMethods string[]
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
allowedOrigins string[]
A set of origins to be allowed via CORS.
maxAgeInSeconds number
The max age to be allowed via CORS.
allow_credentials bool
(Boolean) If credentials are allowed via CORS.
allowed_headers Sequence[str]
A set of headers to be allowed via CORS.
allowed_methods Sequence[str]
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
allowed_origins Sequence[str]
A set of origins to be allowed via CORS.
max_age_in_seconds int
The max age to be allowed via CORS.
allowCredentials Boolean
(Boolean) If credentials are allowed via CORS.
allowedHeaders List<String>
A set of headers to be allowed via CORS.
allowedMethods List<String>
The methods to be allowed via CORS. Possible values are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PATCH and PUT.
allowedOrigins List<String>
A set of origins to be allowed via CORS.
maxAgeInSeconds Number
The max age to be allowed via CORS.

ServiceIdentity
, ServiceIdentityArgs

Type This property is required. string
The type of managed identity to assign. The only possible value is SystemAssigned.
PrincipalId string
TenantId string
Type This property is required. string
The type of managed identity to assign. The only possible value is SystemAssigned.
PrincipalId string
TenantId string
type This property is required. String
The type of managed identity to assign. The only possible value is SystemAssigned.
principalId String
tenantId String
type This property is required. string
The type of managed identity to assign. The only possible value is SystemAssigned.
principalId string
tenantId string
type This property is required. str
The type of managed identity to assign. The only possible value is SystemAssigned.
principal_id str
tenant_id str
type This property is required. String
The type of managed identity to assign. The only possible value is SystemAssigned.
principalId String
tenantId String

Import

Healthcare Service can be imported using the resourceid, e.g.

$ pulumi import azure:healthcare/service:Service example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resource_group/providers/Microsoft.HealthcareApis/services/service_name
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure