1. Packages
  2. Azure Classic
  3. API Docs
  4. healthcare
  5. FhirService

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

azure.healthcare.FhirService

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi

    Manages a Healthcare FHIR (Fast Healthcare Interoperability Resources) Service

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var current = Azure.Core.GetClientConfig.Invoke();
    
        var exampleWorkspace = new Azure.Healthcare.Workspace("exampleWorkspace", new()
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
        });
    
        var exampleFhirService = new Azure.Healthcare.FhirService("exampleFhirService", new()
        {
            Location = "east us",
            ResourceGroupName = "tfex-resource_group",
            WorkspaceId = exampleWorkspace.Id,
            Kind = "fhir-R4",
            Authentication = new Azure.Healthcare.Inputs.FhirServiceAuthenticationArgs
            {
                Authority = "https://login.microsoftonline.com/tenantId",
                Audience = "https://tfexfhir.fhir.azurehealthcareapis.com",
            },
            AccessPolicyObjectIds = new[]
            {
                current.Apply(getClientConfigResult => getClientConfigResult.ObjectId),
            },
            Identity = new Azure.Healthcare.Inputs.FhirServiceIdentityArgs
            {
                Type = "SystemAssigned",
            },
            ContainerRegistryLoginServerUrls = new[]
            {
                "tfex-container_registry_login_server",
            },
            Cors = new Azure.Healthcare.Inputs.FhirServiceCorsArgs
            {
                AllowedOrigins = new[]
                {
                    "https://tfex.com:123",
                    "https://tfex1.com:3389",
                },
                AllowedHeaders = new[]
                {
                    "*",
                },
                AllowedMethods = new[]
                {
                    "GET",
                    "DELETE",
                    "PUT",
                },
                MaxAgeInSeconds = 3600,
                CredentialsAllowed = true,
            },
            ConfigurationExportStorageAccountName = "storage_account_name",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/healthcare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		current, err := core.GetClientConfig(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		exampleWorkspace, err := healthcare.NewWorkspace(ctx, "exampleWorkspace", &healthcare.WorkspaceArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		_, err = healthcare.NewFhirService(ctx, "exampleFhirService", &healthcare.FhirServiceArgs{
    			Location:          pulumi.String("east us"),
    			ResourceGroupName: pulumi.String("tfex-resource_group"),
    			WorkspaceId:       exampleWorkspace.ID(),
    			Kind:              pulumi.String("fhir-R4"),
    			Authentication: &healthcare.FhirServiceAuthenticationArgs{
    				Authority: pulumi.String("https://login.microsoftonline.com/tenantId"),
    				Audience:  pulumi.String("https://tfexfhir.fhir.azurehealthcareapis.com"),
    			},
    			AccessPolicyObjectIds: pulumi.StringArray{
    				*pulumi.String(current.ObjectId),
    			},
    			Identity: &healthcare.FhirServiceIdentityArgs{
    				Type: pulumi.String("SystemAssigned"),
    			},
    			ContainerRegistryLoginServerUrls: pulumi.StringArray{
    				pulumi.String("tfex-container_registry_login_server"),
    			},
    			Cors: &healthcare.FhirServiceCorsArgs{
    				AllowedOrigins: pulumi.StringArray{
    					pulumi.String("https://tfex.com:123"),
    					pulumi.String("https://tfex1.com:3389"),
    				},
    				AllowedHeaders: pulumi.StringArray{
    					pulumi.String("*"),
    				},
    				AllowedMethods: pulumi.StringArray{
    					pulumi.String("GET"),
    					pulumi.String("DELETE"),
    					pulumi.String("PUT"),
    				},
    				MaxAgeInSeconds:    pulumi.Int(3600),
    				CredentialsAllowed: pulumi.Bool(true),
    			},
    			ConfigurationExportStorageAccountName: pulumi.String("storage_account_name"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.core.CoreFunctions;
    import com.pulumi.azure.healthcare.Workspace;
    import com.pulumi.azure.healthcare.WorkspaceArgs;
    import com.pulumi.azure.healthcare.FhirService;
    import com.pulumi.azure.healthcare.FhirServiceArgs;
    import com.pulumi.azure.healthcare.inputs.FhirServiceAuthenticationArgs;
    import com.pulumi.azure.healthcare.inputs.FhirServiceIdentityArgs;
    import com.pulumi.azure.healthcare.inputs.FhirServiceCorsArgs;
    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) {
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            final var current = CoreFunctions.getClientConfig();
    
            var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()        
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .build());
    
            var exampleFhirService = new FhirService("exampleFhirService", FhirServiceArgs.builder()        
                .location("east us")
                .resourceGroupName("tfex-resource_group")
                .workspaceId(exampleWorkspace.id())
                .kind("fhir-R4")
                .authentication(FhirServiceAuthenticationArgs.builder()
                    .authority("https://login.microsoftonline.com/tenantId")
                    .audience("https://tfexfhir.fhir.azurehealthcareapis.com")
                    .build())
                .accessPolicyObjectIds(current.applyValue(getClientConfigResult -> getClientConfigResult.objectId()))
                .identity(FhirServiceIdentityArgs.builder()
                    .type("SystemAssigned")
                    .build())
                .containerRegistryLoginServerUrls("tfex-container_registry_login_server")
                .cors(FhirServiceCorsArgs.builder()
                    .allowedOrigins(                
                        "https://tfex.com:123",
                        "https://tfex1.com:3389")
                    .allowedHeaders("*")
                    .allowedMethods(                
                        "GET",
                        "DELETE",
                        "PUT")
                    .maxAgeInSeconds(3600)
                    .credentialsAllowed(true)
                    .build())
                .configurationExportStorageAccountName("storage_account_name")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    current = azure.core.get_client_config()
    example_workspace = azure.healthcare.Workspace("exampleWorkspace",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_fhir_service = azure.healthcare.FhirService("exampleFhirService",
        location="east us",
        resource_group_name="tfex-resource_group",
        workspace_id=example_workspace.id,
        kind="fhir-R4",
        authentication=azure.healthcare.FhirServiceAuthenticationArgs(
            authority="https://login.microsoftonline.com/tenantId",
            audience="https://tfexfhir.fhir.azurehealthcareapis.com",
        ),
        access_policy_object_ids=[current.object_id],
        identity=azure.healthcare.FhirServiceIdentityArgs(
            type="SystemAssigned",
        ),
        container_registry_login_server_urls=["tfex-container_registry_login_server"],
        cors=azure.healthcare.FhirServiceCorsArgs(
            allowed_origins=[
                "https://tfex.com:123",
                "https://tfex1.com:3389",
            ],
            allowed_headers=["*"],
            allowed_methods=[
                "GET",
                "DELETE",
                "PUT",
            ],
            max_age_in_seconds=3600,
            credentials_allowed=True,
        ),
        configuration_export_storage_account_name="storage_account_name")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const current = azure.core.getClientConfig({});
    const exampleWorkspace = new azure.healthcare.Workspace("exampleWorkspace", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleFhirService = new azure.healthcare.FhirService("exampleFhirService", {
        location: "east us",
        resourceGroupName: "tfex-resource_group",
        workspaceId: exampleWorkspace.id,
        kind: "fhir-R4",
        authentication: {
            authority: "https://login.microsoftonline.com/tenantId",
            audience: "https://tfexfhir.fhir.azurehealthcareapis.com",
        },
        accessPolicyObjectIds: [current.then(current => current.objectId)],
        identity: {
            type: "SystemAssigned",
        },
        containerRegistryLoginServerUrls: ["tfex-container_registry_login_server"],
        cors: {
            allowedOrigins: [
                "https://tfex.com:123",
                "https://tfex1.com:3389",
            ],
            allowedHeaders: ["*"],
            allowedMethods: [
                "GET",
                "DELETE",
                "PUT",
            ],
            maxAgeInSeconds: 3600,
            credentialsAllowed: true,
        },
        configurationExportStorageAccountName: "storage_account_name",
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleWorkspace:
        type: azure:healthcare:Workspace
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
      exampleFhirService:
        type: azure:healthcare:FhirService
        properties:
          location: east us
          resourceGroupName: tfex-resource_group
          workspaceId: ${exampleWorkspace.id}
          kind: fhir-R4
          authentication:
            authority: https://login.microsoftonline.com/tenantId
            audience: https://tfexfhir.fhir.azurehealthcareapis.com
          accessPolicyObjectIds:
            - ${current.objectId}
          identity:
            type: SystemAssigned
          containerRegistryLoginServerUrls:
            - tfex-container_registry_login_server
          cors:
            allowedOrigins:
              - https://tfex.com:123
              - https://tfex1.com:3389
            allowedHeaders:
              - '*'
            allowedMethods:
              - GET
              - DELETE
              - PUT
            maxAgeInSeconds: 3600
            credentialsAllowed: true
          configurationExportStorageAccountName: storage_account_name
    variables:
      current:
        fn::invoke:
          Function: azure:core:getClientConfig
          Arguments: {}
    

    Create FhirService Resource

    new FhirService(name: string, args: FhirServiceArgs, opts?: CustomResourceOptions);
    @overload
    def FhirService(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    access_policy_object_ids: Optional[Sequence[str]] = None,
                    authentication: Optional[FhirServiceAuthenticationArgs] = None,
                    configuration_export_storage_account_name: Optional[str] = None,
                    container_registry_login_server_urls: Optional[Sequence[str]] = None,
                    cors: Optional[FhirServiceCorsArgs] = None,
                    identity: Optional[FhirServiceIdentityArgs] = None,
                    kind: Optional[str] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    oci_artifacts: Optional[Sequence[FhirServiceOciArtifactArgs]] = None,
                    resource_group_name: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    workspace_id: Optional[str] = None)
    @overload
    def FhirService(resource_name: str,
                    args: FhirServiceArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewFhirService(ctx *Context, name string, args FhirServiceArgs, opts ...ResourceOption) (*FhirService, error)
    public FhirService(string name, FhirServiceArgs args, CustomResourceOptions? opts = null)
    public FhirService(String name, FhirServiceArgs args)
    public FhirService(String name, FhirServiceArgs args, CustomResourceOptions options)
    
    type: azure:healthcare:FhirService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args FhirServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FhirServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FhirServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FhirServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FhirServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    FhirService Resource Properties

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

    Inputs

    The FhirService resource accepts the following input properties:

    Authentication FhirServiceAuthentication

    An authentication block as defined below.

    ResourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    WorkspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    AccessPolicyObjectIds List<string>

    A list of the access policies of the service instance.

    ConfigurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    ContainerRegistryLoginServerUrls List<string>

    A list of azure container registry settings used for convert data operation of the service instance.

    Cors FhirServiceCors

    A cors block as defined below.

    Identity FhirServiceIdentity

    An identity block as defined below.

    Kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    Location string

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

    Name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    OciArtifacts List<FhirServiceOciArtifact>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the Healthcare FHIR Service.

    Authentication FhirServiceAuthenticationArgs

    An authentication block as defined below.

    ResourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    WorkspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    AccessPolicyObjectIds []string

    A list of the access policies of the service instance.

    ConfigurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    ContainerRegistryLoginServerUrls []string

    A list of azure container registry settings used for convert data operation of the service instance.

    Cors FhirServiceCorsArgs

    A cors block as defined below.

    Identity FhirServiceIdentityArgs

    An identity block as defined below.

    Kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    Location string

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

    Name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    OciArtifacts []FhirServiceOciArtifactArgs

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    Tags map[string]string

    A mapping of tags to assign to the Healthcare FHIR Service.

    authentication FhirServiceAuthentication

    An authentication block as defined below.

    resourceGroupName String

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    workspaceId String

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds List<String>

    A list of the access policies of the service instance.

    configurationExportStorageAccountName String

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls List<String>

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCors

    A cors block as defined below.

    identity FhirServiceIdentity

    An identity block as defined below.

    kind String

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location String

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

    name String

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts List<FhirServiceOciArtifact>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    tags Map<String,String>

    A mapping of tags to assign to the Healthcare FHIR Service.

    authentication FhirServiceAuthentication

    An authentication block as defined below.

    resourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    workspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds string[]

    A list of the access policies of the service instance.

    configurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls string[]

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCors

    A cors block as defined below.

    identity FhirServiceIdentity

    An identity block as defined below.

    kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location string

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

    name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts FhirServiceOciArtifact[]

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    tags {[key: string]: string}

    A mapping of tags to assign to the Healthcare FHIR Service.

    authentication FhirServiceAuthenticationArgs

    An authentication block as defined below.

    resource_group_name str

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    workspace_id str

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    access_policy_object_ids Sequence[str]

    A list of the access policies of the service instance.

    configuration_export_storage_account_name str

    Specifies the name of the storage account which the operation configuration information is exported to.

    container_registry_login_server_urls Sequence[str]

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCorsArgs

    A cors block as defined below.

    identity FhirServiceIdentityArgs

    An identity block as defined below.

    kind str

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location str

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

    name str

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    oci_artifacts Sequence[FhirServiceOciArtifactArgs]

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    tags Mapping[str, str]

    A mapping of tags to assign to the Healthcare FHIR Service.

    authentication Property Map

    An authentication block as defined below.

    resourceGroupName String

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    workspaceId String

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds List<String>

    A list of the access policies of the service instance.

    configurationExportStorageAccountName String

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls List<String>

    A list of azure container registry settings used for convert data operation of the service instance.

    cors Property Map

    A cors block as defined below.

    identity Property Map

    An identity block as defined below.

    kind String

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location String

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

    name String

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts List<Property Map>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    tags Map<String>

    A mapping of tags to assign to the Healthcare FHIR Service.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    PublicNetworkAccessEnabled bool

    Whether public networks access is enabled.

    Id string

    The provider-assigned unique ID for this managed resource.

    PublicNetworkAccessEnabled bool

    Whether public networks access is enabled.

    id String

    The provider-assigned unique ID for this managed resource.

    publicNetworkAccessEnabled Boolean

    Whether public networks access is enabled.

    id string

    The provider-assigned unique ID for this managed resource.

    publicNetworkAccessEnabled boolean

    Whether public networks access is enabled.

    id str

    The provider-assigned unique ID for this managed resource.

    public_network_access_enabled bool

    Whether public networks access is enabled.

    id String

    The provider-assigned unique ID for this managed resource.

    publicNetworkAccessEnabled Boolean

    Whether public networks access is enabled.

    Look up Existing FhirService Resource

    Get an existing FhirService 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?: FhirServiceState, opts?: CustomResourceOptions): FhirService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_policy_object_ids: Optional[Sequence[str]] = None,
            authentication: Optional[FhirServiceAuthenticationArgs] = None,
            configuration_export_storage_account_name: Optional[str] = None,
            container_registry_login_server_urls: Optional[Sequence[str]] = None,
            cors: Optional[FhirServiceCorsArgs] = None,
            identity: Optional[FhirServiceIdentityArgs] = None,
            kind: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            oci_artifacts: Optional[Sequence[FhirServiceOciArtifactArgs]] = None,
            public_network_access_enabled: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            workspace_id: Optional[str] = None) -> FhirService
    func GetFhirService(ctx *Context, name string, id IDInput, state *FhirServiceState, opts ...ResourceOption) (*FhirService, error)
    public static FhirService Get(string name, Input<string> id, FhirServiceState? state, CustomResourceOptions? opts = null)
    public static FhirService get(String name, Output<String> id, FhirServiceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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>

    A list of the access policies of the service instance.

    Authentication FhirServiceAuthentication

    An authentication block as defined below.

    ConfigurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    ContainerRegistryLoginServerUrls List<string>

    A list of azure container registry settings used for convert data operation of the service instance.

    Cors FhirServiceCors

    A cors block as defined below.

    Identity FhirServiceIdentity

    An identity block as defined below.

    Kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    Location string

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

    Name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    OciArtifacts List<FhirServiceOciArtifact>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    PublicNetworkAccessEnabled bool

    Whether public networks access is enabled.

    ResourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    Tags Dictionary<string, string>

    A mapping of tags to assign to the Healthcare FHIR Service.

    WorkspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    AccessPolicyObjectIds []string

    A list of the access policies of the service instance.

    Authentication FhirServiceAuthenticationArgs

    An authentication block as defined below.

    ConfigurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    ContainerRegistryLoginServerUrls []string

    A list of azure container registry settings used for convert data operation of the service instance.

    Cors FhirServiceCorsArgs

    A cors block as defined below.

    Identity FhirServiceIdentityArgs

    An identity block as defined below.

    Kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    Location string

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

    Name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    OciArtifacts []FhirServiceOciArtifactArgs

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    PublicNetworkAccessEnabled bool

    Whether public networks access is enabled.

    ResourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    Tags map[string]string

    A mapping of tags to assign to the Healthcare FHIR Service.

    WorkspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds List<String>

    A list of the access policies of the service instance.

    authentication FhirServiceAuthentication

    An authentication block as defined below.

    configurationExportStorageAccountName String

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls List<String>

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCors

    A cors block as defined below.

    identity FhirServiceIdentity

    An identity block as defined below.

    kind String

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location String

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

    name String

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts List<FhirServiceOciArtifact>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    publicNetworkAccessEnabled Boolean

    Whether public networks access is enabled.

    resourceGroupName String

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    tags Map<String,String>

    A mapping of tags to assign to the Healthcare FHIR Service.

    workspaceId String

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds string[]

    A list of the access policies of the service instance.

    authentication FhirServiceAuthentication

    An authentication block as defined below.

    configurationExportStorageAccountName string

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls string[]

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCors

    A cors block as defined below.

    identity FhirServiceIdentity

    An identity block as defined below.

    kind string

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location string

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

    name string

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts FhirServiceOciArtifact[]

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    publicNetworkAccessEnabled boolean

    Whether public networks access is enabled.

    resourceGroupName string

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    tags {[key: string]: string}

    A mapping of tags to assign to the Healthcare FHIR Service.

    workspaceId string

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    access_policy_object_ids Sequence[str]

    A list of the access policies of the service instance.

    authentication FhirServiceAuthenticationArgs

    An authentication 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.

    container_registry_login_server_urls Sequence[str]

    A list of azure container registry settings used for convert data operation of the service instance.

    cors FhirServiceCorsArgs

    A cors block as defined below.

    identity FhirServiceIdentityArgs

    An identity block as defined below.

    kind str

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location str

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

    name str

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    oci_artifacts Sequence[FhirServiceOciArtifactArgs]

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    public_network_access_enabled bool

    Whether public networks access is enabled.

    resource_group_name str

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    tags Mapping[str, str]

    A mapping of tags to assign to the Healthcare FHIR Service.

    workspace_id str

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    accessPolicyObjectIds List<String>

    A list of the access policies of the service instance.

    authentication Property Map

    An authentication block as defined below.

    configurationExportStorageAccountName String

    Specifies the name of the storage account which the operation configuration information is exported to.

    containerRegistryLoginServerUrls List<String>

    A list of azure container registry settings used for convert data operation of the service instance.

    cors Property Map

    A cors block as defined below.

    identity Property Map

    An identity block as defined below.

    kind String

    Specifies the kind of the Healthcare FHIR Service. Possible values are: fhir-Stu3 and fhir-R4. Defaults to fhir-R4. Changing this forces a new Healthcare FHIR Service to be created.

    location String

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

    name String

    Specifies the name of the Healthcare FHIR Service. Changing this forces a new Healthcare FHIR Service to be created.

    ociArtifacts List<Property Map>

    A list of oci_artifact objects as defined below to describe OCI artifacts for export.

    publicNetworkAccessEnabled Boolean

    Whether public networks access is enabled.

    resourceGroupName String

    Specifies the name of the Resource Group in which to create the Healthcare FHIR Service. Changing this forces a new resource to be created.

    tags Map<String>

    A mapping of tags to assign to the Healthcare FHIR Service.

    workspaceId String

    Specifies the id of the Healthcare Workspace where the Healthcare FHIR Service should exist. Changing this forces a new Healthcare FHIR Service to be created.

    Supporting Types

    FhirServiceAuthentication, FhirServiceAuthenticationArgs

    Audience string

    The intended audience to receive authentication tokens for the service.

    Authority string
    SmartProxyEnabled bool

    Whether smart proxy is enabled.

    Audience string

    The intended audience to receive authentication tokens for the service.

    Authority string
    SmartProxyEnabled bool

    Whether smart proxy is enabled.

    audience String

    The intended audience to receive authentication tokens for the service.

    authority String
    smartProxyEnabled Boolean

    Whether smart proxy is enabled.

    audience string

    The intended audience to receive authentication tokens for the service.

    authority string
    smartProxyEnabled boolean

    Whether smart proxy is enabled.

    audience str

    The intended audience to receive authentication tokens for the service.

    authority str
    smart_proxy_enabled bool

    Whether smart proxy is enabled.

    audience String

    The intended audience to receive authentication tokens for the service.

    authority String
    smartProxyEnabled Boolean

    Whether smart proxy is enabled.

    FhirServiceCors, FhirServiceCorsArgs

    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.

    CredentialsAllowed bool

    If credentials are allowed via CORS.

    MaxAgeInSeconds int

    The max age to be 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.

    CredentialsAllowed bool

    If credentials are allowed via CORS.

    MaxAgeInSeconds int

    The max age to be 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.

    credentialsAllowed Boolean

    If credentials are allowed via CORS.

    maxAgeInSeconds Integer

    The max age to be 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.

    credentialsAllowed boolean

    If credentials are allowed via CORS.

    maxAgeInSeconds number

    The max age to be 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.

    credentials_allowed bool

    If credentials are allowed via CORS.

    max_age_in_seconds int

    The max age to be 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.

    credentialsAllowed Boolean

    If credentials are allowed via CORS.

    maxAgeInSeconds Number

    The max age to be allowed via CORS.

    FhirServiceIdentity, FhirServiceIdentityArgs

    Type string

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    IdentityIds List<string>

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    PrincipalId string
    TenantId string
    Type string

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    IdentityIds []string

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    PrincipalId string
    TenantId string
    type String

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    identityIds List<String>

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    principalId String
    tenantId String
    type string

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    identityIds string[]

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    principalId string
    tenantId string
    type str

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    identity_ids Sequence[str]

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    principal_id str
    tenant_id str
    type String

    The type of managed identity to assign. Possible values are UserAssigned and SystemAssigned.

    identityIds List<String>

    A list of one or more Resource IDs for User Assigned Managed identities to assign. Required when type is set to UserAssigned.

    principalId String
    tenantId String

    FhirServiceOciArtifact, FhirServiceOciArtifactArgs

    LoginServer string

    An Azure container registry used for export operations of the service instance.

    Digest string

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    ImageName string

    An image within Azure container registry used for export operations of the service instance.

    LoginServer string

    An Azure container registry used for export operations of the service instance.

    Digest string

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    ImageName string

    An image within Azure container registry used for export operations of the service instance.

    loginServer String

    An Azure container registry used for export operations of the service instance.

    digest String

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    imageName String

    An image within Azure container registry used for export operations of the service instance.

    loginServer string

    An Azure container registry used for export operations of the service instance.

    digest string

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    imageName string

    An image within Azure container registry used for export operations of the service instance.

    login_server str

    An Azure container registry used for export operations of the service instance.

    digest str

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    image_name str

    An image within Azure container registry used for export operations of the service instance.

    loginServer String

    An Azure container registry used for export operations of the service instance.

    digest String

    A digest of an image within Azure container registry used for export operations of the service instance to narrow the artifacts down.

    imageName String

    An image within Azure container registry used for export operations of the service instance.

    Import

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

     $ pulumi import azure:healthcare/fhirService:FhirService example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.HealthcareApis/workspaces/workspace1/fhirServices/service1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.58.0 published on Saturday, Dec 2, 2023 by Pulumi