1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. healthcare

Module healthcare

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.

Resources

Functions

Others

Resources

Resource Service

class Service extends CustomResource

Manages a Healthcare Service.

Example Usage

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

constructor

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

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessPolicyObjectIds

public accessPolicyObjectIds: pulumi.Output<string[]>;

property authenticationConfiguration

public authenticationConfiguration: pulumi.Output<ServiceAuthenticationConfiguration>;

An authenticationConfiguration block as defined below.

property corsConfiguration

public corsConfiguration: pulumi.Output<ServiceCorsConfiguration>;

A corsConfiguration block as defined below.

property cosmosdbThroughput

public cosmosdbThroughput: pulumi.Output<number | undefined>;

The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<string | undefined>;

The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.

property location

public location: pulumi.Output<string>;

Specifies the supported Azure Region where the Service should be created.

property name

public name: pulumi.Output<string>;

The name of the service instance. Used for service endpoint, must be unique within the audience.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

The name of the Resource Group in which to create the Service.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

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

Example Usage

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

const example = azure.healthcare.getService({
    name: "example-healthcare_service",
    resourceGroupName: "example-resources",
    location: "westus2",
});
export const healthcareServiceId = example.then(example => example.id);

Others

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property location

location: string;

The Azure Region where the Service is located.

property name

name: string;

Specifies the name of the Healthcare Service.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the Healthcare Service exists.

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property accessPolicyObjectIds

accessPolicyObjectIds: string[];

property authenticationConfigurations

authenticationConfigurations: GetServiceAuthenticationConfiguration[];

An authenticationConfiguration block as defined below.

property corsConfigurations

corsConfigurations: GetServiceCorsConfiguration[];

A corsConfiguration block as defined below.

property cosmosdbThroughput

cosmosdbThroughput: number;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kind

kind: string;

The type of the service.

property location

location: string;

The Azure Region where the Service is located.

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property tags

tags: {[key: string]: string};

A mapping of tags to assign to the resource.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property accessPolicyObjectIds

accessPolicyObjectIds: pulumi.Input<pulumi.Input<string>[]>;

property authenticationConfiguration

authenticationConfiguration?: pulumi.Input<ServiceAuthenticationConfiguration>;

An authenticationConfiguration block as defined below.

property corsConfiguration

corsConfiguration?: pulumi.Input<ServiceCorsConfiguration>;

A corsConfiguration block as defined below.

property cosmosdbThroughput

cosmosdbThroughput?: pulumi.Input<number>;

The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.

property kind

kind?: pulumi.Input<string>;

The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the Service should be created.

property name

name?: pulumi.Input<string>;

The name of the service instance. Used for service endpoint, must be unique within the audience.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

The name of the Resource Group in which to create the Service.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property accessPolicyObjectIds

accessPolicyObjectIds?: pulumi.Input<pulumi.Input<string>[]>;

property authenticationConfiguration

authenticationConfiguration?: pulumi.Input<ServiceAuthenticationConfiguration>;

An authenticationConfiguration block as defined below.

property corsConfiguration

corsConfiguration?: pulumi.Input<ServiceCorsConfiguration>;

A corsConfiguration block as defined below.

property cosmosdbThroughput

cosmosdbThroughput?: pulumi.Input<number>;

The provisioned throughput for the backing database. Range of 400-1000. Defaults to 400.

property kind

kind?: pulumi.Input<string>;

The type of the service. Values at time of publication are: fhir, fhir-Stu3 and fhir-R4. Default value is fhir.

property location

location?: pulumi.Input<string>;

Specifies the supported Azure Region where the Service should be created.

property name

name?: pulumi.Input<string>;

The name of the service instance. Used for service endpoint, must be unique within the audience.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

The name of the Resource Group in which to create the Service.

property tags

tags?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.