This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

healthcare¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.healthcare.AwaitableGetServiceResult(access_policy_object_ids=None, authentication_configurations=None, cors_configurations=None, cosmosdb_throughput=None, id=None, kind=None, location=None, name=None, resource_group_name=None, tags=None)¶

class pulumi_azure.healthcare.GetServiceResult(access_policy_object_ids=None, authentication_configurations=None, cors_configurations=None, cosmosdb_throughput=None, id=None, kind=None, location=None, name=None, resource_group_name=None, tags=None)¶

A collection of values returned by getService.

authentication_configurations = None¶: An authentication_configuration block as defined below.

cors_configurations = None¶: A cors_configuration block as defined below.

id = None¶: The provider-assigned unique ID for this managed resource.

kind = None¶: The type of the service.

location = None¶: The Azure Region where the Service is located.

tags = None¶: A mapping of tags to assign to the resource.

class pulumi_azure.healthcare.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, __name__=None, __opts__=None)¶

Manages a Healthcare Service.

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",
    })

Parameters

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

The authentication_configuration object supports the following:

audience (pulumi.Input[str]) - The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority (pulumi.Input[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 (pulumi.Input[bool]) - Enables the ‘SMART on FHIR’ option for mobile and web implementations.

The cors_configuration object supports the following:

allowCredentials (pulumi.Input[bool]) - If credentials are allowed via CORS.
allowedHeaders (pulumi.Input[list]) - A set of headers to be allowed via CORS.
allowedMethods (pulumi.Input[list]) - The methods to be allowed via CORS.
allowedOrigins (pulumi.Input[list]) - A set of origins to be allowed via CORS.
maxAgeInSeconds (pulumi.Input[float]) - The max age to be allowed via CORS.

authentication_configuration: pulumi.Output[dict] = None¶

An authentication_configuration block as defined below.

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.

cors_configuration: pulumi.Output[dict] = None¶

A cors_configuration block as defined below.

allowCredentials (bool) - If credentials are allowed via CORS.
allowedHeaders (list) - A set of headers to be allowed via CORS.
allowedMethods (list) - The methods to be allowed via CORS.
allowedOrigins (list) - A set of origins to be allowed via CORS.
maxAgeInSeconds (float) - The max age to be allowed via CORS.

cosmosdb_throughput: pulumi.Output[float] = None¶: The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.

kind: pulumi.Output[str] = None¶: The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.

location: pulumi.Output[str] = None¶: Specifies the supported Azure Region where the Service should be created.

name: pulumi.Output[str] = None¶: The name of the service instance. Used for service endpoint, must be unique within the audience.

resource_group_name: pulumi.Output[str] = None¶: The name of the Resource Group in which to create the Service.

tags: pulumi.Output[dict] = None¶: A mapping of tags to assign to the resource.

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)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
authentication_configuration (pulumi.Input[dict]) – An authentication_configuration block as defined below.
cors_configuration (pulumi.Input[dict]) – A cors_configuration block as defined below.
cosmosdb_throughput (pulumi.Input[float]) – The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.
kind (pulumi.Input[str]) – The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.
location (pulumi.Input[str]) – Specifies the supported Azure Region where the Service should be created.
name (pulumi.Input[str]) – The name of the service instance. Used for service endpoint, must be unique within the audience.
resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which to create the Service.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The authentication_configuration object supports the following:

audience (pulumi.Input[str]) - The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com
authority (pulumi.Input[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 (pulumi.Input[bool]) - Enables the ‘SMART on FHIR’ option for mobile and web implementations.

The cors_configuration object supports the following:

allowCredentials (pulumi.Input[bool]) - If credentials are allowed via CORS.
allowedHeaders (pulumi.Input[list]) - A set of headers to be allowed via CORS.
allowedMethods (pulumi.Input[list]) - The methods to be allowed via CORS.
allowedOrigins (pulumi.Input[list]) - A set of origins to be allowed via CORS.
maxAgeInSeconds (pulumi.Input[float]) - The max age to be allowed via CORS.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_azure.healthcare.get_service(location=None, name=None, resource_group_name=None, opts=None)¶

Use this data source to access information about an existing Healthcare Service

import pulumi
import pulumi_azure as azure

example = azure.healthcare.get_service(name="example-healthcare_service",
    resource_group_name="example-resources",
    location="westus2")
pulumi.export("healthcareServiceId", example.id)

Parameters

location (str) – The Azure Region where the Service is located.
name (str) – Specifies the name of the Healthcare Service.
resource_group_name (str) – The name of the Resource Group in which the Healthcare Service exists.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

healthcare¶

On This Page