Service

Manages a Healthcare Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Azure.Healthcare.Service("example", new Azure.Healthcare.ServiceArgs
        {
            AccessPolicyObjectIds = 
            {
                "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            },
            AuthenticationConfiguration = new Azure.Healthcare.Inputs.ServiceAuthenticationConfigurationArgs
            {
                Audience = "https://azurehealthcareapis.com/",
                Authority = "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
                SmartProxyEnabled = true,
            },
            CorsConfiguration = new Azure.Healthcare.Inputs.ServiceCorsConfigurationArgs
            {
                AllowCredentials = true,
                AllowedHeaders = 
                {
                    "x-tempo-*",
                    "x-tempo2-*",
                },
                AllowedMethods = 
                {
                    "GET",
                    "PUT",
                },
                AllowedOrigins = 
                {
                    "http://www.example.com",
                    "http://www.example2.com",
                },
                MaxAgeInSeconds = 500,
            },
            CosmosdbThroughput = 2000,
            Kind = "fhir-R4",
            Location = "westus2",
            ResourceGroupName = "sample-resource-group",
            Tags = 
            {
                { "environment", "testenv" },
                { "purpose", "AcceptanceTests" },
            },
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/healthcare"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err = healthcare.NewService(ctx, "example", &healthcare.ServiceArgs{
            AccessPolicyObjectIds: pulumi.StringArray{
                pulumi.String("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
            },
            AuthenticationConfiguration: &healthcare.ServiceAuthenticationConfigurationArgs{
                Audience:          pulumi.String("https://azurehealthcareapis.com/"),
                Authority:         pulumi.String(fmt.Sprintf("%v%v%v%v%v%v", "https://login.microsoftonline.com/", "$", "%", "7Bdata.azurerm_client_config.current.tenant_id", "%", "7D")),
                SmartProxyEnabled: pulumi.Bool(true),
            },
            CorsConfiguration: &healthcare.ServiceCorsConfigurationArgs{
                AllowCredentials: pulumi.Bool(true),
                AllowedHeaders: pulumi.StringArray{
                    pulumi.String("x-tempo-*"),
                    pulumi.String("x-tempo2-*"),
                },
                AllowedMethods: pulumi.StringArray{
                    pulumi.String("GET"),
                    pulumi.String("PUT"),
                },
                AllowedOrigins: pulumi.StringArray{
                    pulumi.String("http://www.example.com"),
                    pulumi.String("http://www.example2.com"),
                },
                MaxAgeInSeconds: pulumi.Int(500),
            },
            CosmosdbThroughput: pulumi.Int(2000),
            Kind:               pulumi.String("fhir-R4"),
            Location:           pulumi.String("westus2"),
            ResourceGroupName:  pulumi.String("sample-resource-group"),
            Tags: pulumi.Map{
                "environment": pulumi.String("testenv"),
                "purpose":     pulumi.String("AcceptanceTests"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_azure as azure

example = azure.healthcare.Service("example",
    access_policy_object_ids=["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
    authentication_configuration={
        "audience": "https://azurehealthcareapis.com/",
        "authority": "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
        "smartProxyEnabled": "true",
    },
    cors_configuration={
        "allowCredentials": "true",
        "allowedHeaders": [
            "x-tempo-*",
            "x-tempo2-*",
        ],
        "allowedMethods": [
            "GET",
            "PUT",
        ],
        "allowedOrigins": [
            "http://www.example.com",
            "http://www.example2.com",
        ],
        "maxAgeInSeconds": "500",
    },
    cosmosdb_throughput="2000",
    kind="fhir-R4",
    location="westus2",
    resource_group_name="sample-resource-group",
    tags={
        "environment": "testenv",
        "purpose": "AcceptanceTests",
    })

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

const example = new azure.healthcare.Service("example", {
    accessPolicyObjectIds: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
    authenticationConfiguration: {
        audience: "https://azurehealthcareapis.com/",
        authority: "https://login.microsoftonline.com/$%7Bdata.azurerm_client_config.current.tenant_id%7D",
        smartProxyEnabled: true,
    },
    corsConfiguration: {
        allowCredentials: true,
        allowedHeaders: [
            "x-tempo-*",
            "x-tempo2-*",
        ],
        allowedMethods: [
            "GET",
            "PUT",
        ],
        allowedOrigins: [
            "http://www.example.com",
            "http://www.example2.com",
        ],
        maxAgeInSeconds: 500,
    },
    cosmosdbThroughput: 2000,
    kind: "fhir-R4",
    location: "westus2",
    resourceGroupName: "sample-resource-group",
    tags: {
        environment: "testenv",
        purpose: "AcceptanceTests",
    },
});

Create a Service Resource

new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);

def Service(resource_name, opts=None, access_policy_object_ids=None, authentication_configuration=None, cors_configuration=None, cosmosdb_throughput=None, kind=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)

public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ServiceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Service Resource Properties

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

Inputs

The Service resource accepts the following input properties:

ResourceGroupName string: The name of the Resource Group in which to create the Service.
AccessPolicyObjectIds List<string>
AuthenticationConfiguration ServiceAuthenticationConfigurationArgs: An authentication_configuration block as defined below.
CorsConfiguration ServiceCorsConfigurationArgs: A cors_configuration block as defined below.
CosmosdbThroughput int: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
Kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location string: Specifies the supported Azure Region where the Service should be created.
Name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the Resource Group in which to create the Service.
AccessPolicyObjectIds []string
AuthenticationConfiguration ServiceAuthenticationConfiguration: An authentication_configuration block as defined below.
CorsConfiguration ServiceCorsConfiguration: A cors_configuration block as defined below.
CosmosdbThroughput int: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
Kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location string: Specifies the supported Azure Region where the Service should be created.
Name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the Resource Group in which to create the Service.
accessPolicyObjectIds string[]
authenticationConfiguration ServiceAuthenticationConfiguration: An authentication_configuration block as defined below.
corsConfiguration ServiceCorsConfiguration: A cors_configuration block as defined below.
cosmosdbThroughput number: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location string: Specifies the supported Azure Region where the Service should be created.
name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the Resource Group in which to create the Service.
access_policy_object_ids List[str]
authentication_configuration Dict[ServiceAuthenticationConfiguration]: An authentication_configuration block as defined below.
cors_configuration Dict[ServiceCorsConfiguration]: A cors_configuration block as defined below.
cosmosdb_throughput float: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
kind str: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location str: Specifies the supported Azure Region where the Service should be created.
name str: The name of the service instance. Used for service endpoint, must be unique within the audience.
tags Dict[str, str]: 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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, access_policy_object_ids=None, authentication_configuration=None, cors_configuration=None, cosmosdb_throughput=None, kind=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

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)

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: 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: The unique name of the resulting resource.
id: 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 ServiceAuthenticationConfigurationArgs: An authentication_configuration block as defined below.
CorsConfiguration ServiceCorsConfigurationArgs: A cors_configuration block as defined below.
CosmosdbThroughput int: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
Kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location string: Specifies the supported Azure Region where the Service should be created.
Name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
ResourceGroupName string: The name of the Resource Group in which to create the Service.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AccessPolicyObjectIds []string
AuthenticationConfiguration ServiceAuthenticationConfiguration: An authentication_configuration block as defined below.
CorsConfiguration ServiceCorsConfiguration: A cors_configuration block as defined below.
CosmosdbThroughput int: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
Kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
Location string: Specifies the supported Azure Region where the Service should be created.
Name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
ResourceGroupName string: The name of the Resource Group in which to create the Service.
Tags map[string]string: A mapping of tags to assign to the resource.

accessPolicyObjectIds string[]
authenticationConfiguration ServiceAuthenticationConfiguration: An authentication_configuration block as defined below.
corsConfiguration ServiceCorsConfiguration: A cors_configuration block as defined below.
cosmosdbThroughput number: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
kind string: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location string: Specifies the supported Azure Region where the Service should be created.
name string: The name of the service instance. Used for service endpoint, must be unique within the audience.
resourceGroupName string: The name of the Resource Group in which to create the Service.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

access_policy_object_ids List[str]
authentication_configuration Dict[ServiceAuthenticationConfiguration]: An authentication_configuration block as defined below.
cors_configuration Dict[ServiceCorsConfiguration]: A cors_configuration block as defined below.
cosmosdb_throughput float: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
kind str: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location str: Specifies the supported Azure Region where the Service should be created.
name str: The name of the service instance. Used for service endpoint, must be unique within the audience.
resource_group_name str: The name of the Resource Group in which to create the Service.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

ServiceAuthenticationConfiguration

See the input and output API doc for this type.

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: 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: 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: 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}.
smartProxyEnabled bool: Enables the ‘SMART on FHIR’ option for mobile and web implementations.

ServiceCorsConfiguration

See the input and output API doc for this type.

AllowCredentials bool: 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.
AllowedOrigins List<string>: A set of origins to be allowed via CORS.
MaxAgeInSeconds int: The max age to be allowed via CORS.

AllowCredentials bool: 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.
AllowedOrigins []string: A set of origins to be allowed via CORS.
MaxAgeInSeconds int: The max age to be allowed via CORS.

allowCredentials 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.
allowedOrigins string[]: A set of origins to be allowed via CORS.
maxAgeInSeconds number: The max age to be allowed via CORS.

allowCredentials bool: If credentials are allowed via CORS.
allowedHeaders List[str]: A set of headers to be allowed via CORS.
allowedMethods List[str]: The methods to be allowed via CORS.
allowedOrigins List[str]: A set of origins to be allowed via CORS.
maxAgeInSeconds float: The max age to be allowed via CORS.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud