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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.healthcare.getService

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

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);
Copy
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)
Copy
package main

import (
	"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 {
		example, err := healthcare.LookupService(ctx, &healthcare.LookupServiceArgs{
			Name:              "example-healthcare_service",
			ResourceGroupName: "example-resources",
			Location:          "westus2",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("healthcareServiceId", example.Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Healthcare.GetService.Invoke(new()
    {
        Name = "example-healthcare_service",
        ResourceGroupName = "example-resources",
        Location = "westus2",
    });

    return new Dictionary<string, object?>
    {
        ["healthcareServiceId"] = example.Apply(getServiceResult => getServiceResult.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.healthcare.HealthcareFunctions;
import com.pulumi.azure.healthcare.inputs.GetServiceArgs;
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 example = HealthcareFunctions.getService(GetServiceArgs.builder()
            .name("example-healthcare_service")
            .resourceGroupName("example-resources")
            .location("westus2")
            .build());

        ctx.export("healthcareServiceId", example.applyValue(getServiceResult -> getServiceResult.id()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:healthcare:getService
      arguments:
        name: example-healthcare_service
        resourceGroupName: example-resources
        location: westus2
outputs:
  healthcareServiceId: ${example.id}
Copy

Using getService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
Copy
def get_service(location: Optional[str] = None,
                name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(location: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
Copy
func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput
Copy

> Note: This function is named LookupService in the Go SDK.

public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:healthcare/getService:getService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location
This property is required.
Changes to this property will trigger replacement.
string
The Azure Region where the Service is located.
Name This property is required. string
Specifies the name of the Healthcare Service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Healthcare Service exists.
Location
This property is required.
Changes to this property will trigger replacement.
string
The Azure Region where the Service is located.
Name This property is required. string
Specifies the name of the Healthcare Service.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Healthcare Service exists.
location
This property is required.
Changes to this property will trigger replacement.
String
The Azure Region where the Service is located.
name This property is required. String
Specifies the name of the Healthcare Service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Healthcare Service exists.
location
This property is required.
Changes to this property will trigger replacement.
string
The Azure Region where the Service is located.
name This property is required. string
Specifies the name of the Healthcare Service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the Healthcare Service exists.
location
This property is required.
Changes to this property will trigger replacement.
str
The Azure Region where the Service is located.
name This property is required. str
Specifies the name of the Healthcare Service.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which the Healthcare Service exists.
location
This property is required.
Changes to this property will trigger replacement.
String
The Azure Region where the Service is located.
name This property is required. String
Specifies the name of the Healthcare Service.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the Healthcare Service exists.

getService Result

The following output properties are available:

AccessPolicyObjectIds List<string>
AuthenticationConfigurations List<GetServiceAuthenticationConfiguration>
An authentication_configuration block as defined below.
CorsConfigurations List<GetServiceCorsConfiguration>
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId string
The versionless Key Vault Key ID for CMK encryption of the backing database.
CosmosdbThroughput int
The provisioned throughput for the backing database.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
The type of the service.
Location string
The Azure Region where the Service is located.
Name string
ResourceGroupName string
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
AccessPolicyObjectIds []string
AuthenticationConfigurations []GetServiceAuthenticationConfiguration
An authentication_configuration block as defined below.
CorsConfigurations []GetServiceCorsConfiguration
A cors_configuration block as defined below.
CosmosdbKeyVaultKeyVersionlessId string
The versionless Key Vault Key ID for CMK encryption of the backing database.
CosmosdbThroughput int
The provisioned throughput for the backing database.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
The type of the service.
Location string
The Azure Region where the Service is located.
Name string
ResourceGroupName string
Tags map[string]string
A mapping of tags to assign to the resource.
accessPolicyObjectIds List<String>
authenticationConfigurations List<GetServiceAuthenticationConfiguration>
An authentication_configuration block as defined below.
corsConfigurations List<GetServiceCorsConfiguration>
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId String
The versionless Key Vault Key ID for CMK encryption of the backing database.
cosmosdbThroughput Integer
The provisioned throughput for the backing database.
id String
The provider-assigned unique ID for this managed resource.
kind String
The type of the service.
location String
The Azure Region where the Service is located.
name String
resourceGroupName String
tags Map<String,String>
A mapping of tags to assign to the resource.
accessPolicyObjectIds string[]
authenticationConfigurations GetServiceAuthenticationConfiguration[]
An authentication_configuration block as defined below.
corsConfigurations GetServiceCorsConfiguration[]
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId string
The versionless Key Vault Key ID for CMK encryption of the backing database.
cosmosdbThroughput number
The provisioned throughput for the backing database.
id string
The provider-assigned unique ID for this managed resource.
kind string
The type of the service.
location string
The Azure Region where the Service is located.
name string
resourceGroupName string
tags {[key: string]: string}
A mapping of tags to assign to the resource.
access_policy_object_ids Sequence[str]
authentication_configurations Sequence[GetServiceAuthenticationConfiguration]
An authentication_configuration block as defined below.
cors_configurations Sequence[GetServiceCorsConfiguration]
A cors_configuration block as defined below.
cosmosdb_key_vault_key_versionless_id str
The versionless Key Vault Key ID for CMK encryption of the backing database.
cosmosdb_throughput int
The provisioned throughput for the backing database.
id str
The provider-assigned unique ID for this managed resource.
kind str
The type of the service.
location str
The Azure Region where the Service is located.
name str
resource_group_name str
tags Mapping[str, str]
A mapping of tags to assign to the resource.
accessPolicyObjectIds List<String>
authenticationConfigurations List<Property Map>
An authentication_configuration block as defined below.
corsConfigurations List<Property Map>
A cors_configuration block as defined below.
cosmosdbKeyVaultKeyVersionlessId String
The versionless Key Vault Key ID for CMK encryption of the backing database.
cosmosdbThroughput Number
The provisioned throughput for the backing database.
id String
The provider-assigned unique ID for this managed resource.
kind String
The type of the service.
location String
The Azure Region where the Service is located.
name String
resourceGroupName String
tags Map<String>
A mapping of tags to assign to the resource.

Supporting Types

GetServiceAuthenticationConfiguration

Audience This property is required. string
The intended audience to receive authentication tokens for the service.
Authority This property is required. string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
SmartProxyEnabled This property is required. bool
Is the 'SMART on FHIR' option for mobile and web implementations enabled?
Audience This property is required. string
The intended audience to receive authentication tokens for the service.
Authority This property is required. string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
SmartProxyEnabled This property is required. bool
Is the 'SMART on FHIR' option for mobile and web implementations enabled?
audience This property is required. String
The intended audience to receive authentication tokens for the service.
authority This property is required. String
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
smartProxyEnabled This property is required. Boolean
Is the 'SMART on FHIR' option for mobile and web implementations enabled?
audience This property is required. string
The intended audience to receive authentication tokens for the service.
authority This property is required. string
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
smartProxyEnabled This property is required. boolean
Is the 'SMART on FHIR' option for mobile and web implementations enabled?
audience This property is required. str
The intended audience to receive authentication tokens for the service.
authority This property is required. str
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
smart_proxy_enabled This property is required. bool
Is the 'SMART on FHIR' option for mobile and web implementations enabled?
audience This property is required. String
The intended audience to receive authentication tokens for the service.
authority This property is required. String
The Azure Active Directory (tenant) that serves as the authentication authority to access the service.
smartProxyEnabled This property is required. Boolean
Is the 'SMART on FHIR' option for mobile and web implementations enabled?

GetServiceCorsConfiguration

AllowCredentials This property is required. bool
Are credentials are allowed via CORS?
AllowedHeaders This property is required. List<string>
The set of headers to be allowed via CORS.
AllowedMethods This property is required. List<string>
The methods to be allowed via CORS.
AllowedOrigins This property is required. List<string>
The set of origins to be allowed via CORS.
MaxAgeInSeconds This property is required. int
The max age to be allowed via CORS.
AllowCredentials This property is required. bool
Are credentials are allowed via CORS?
AllowedHeaders This property is required. []string
The set of headers to be allowed via CORS.
AllowedMethods This property is required. []string
The methods to be allowed via CORS.
AllowedOrigins This property is required. []string
The set of origins to be allowed via CORS.
MaxAgeInSeconds This property is required. int
The max age to be allowed via CORS.
allowCredentials This property is required. Boolean
Are credentials are allowed via CORS?
allowedHeaders This property is required. List<String>
The set of headers to be allowed via CORS.
allowedMethods This property is required. List<String>
The methods to be allowed via CORS.
allowedOrigins This property is required. List<String>
The set of origins to be allowed via CORS.
maxAgeInSeconds This property is required. Integer
The max age to be allowed via CORS.
allowCredentials This property is required. boolean
Are credentials are allowed via CORS?
allowedHeaders This property is required. string[]
The set of headers to be allowed via CORS.
allowedMethods This property is required. string[]
The methods to be allowed via CORS.
allowedOrigins This property is required. string[]
The set of origins to be allowed via CORS.
maxAgeInSeconds This property is required. number
The max age to be allowed via CORS.
allow_credentials This property is required. bool
Are credentials are allowed via CORS?
allowed_headers This property is required. Sequence[str]
The set of headers to be allowed via CORS.
allowed_methods This property is required. Sequence[str]
The methods to be allowed via CORS.
allowed_origins This property is required. Sequence[str]
The set of origins to be allowed via CORS.
max_age_in_seconds This property is required. int
The max age to be allowed via CORS.
allowCredentials This property is required. Boolean
Are credentials are allowed via CORS?
allowedHeaders This property is required. List<String>
The set of headers to be allowed via CORS.
allowedMethods This property is required. List<String>
The methods to be allowed via CORS.
allowedOrigins This property is required. List<String>
The set of origins to be allowed via CORS.
maxAgeInSeconds This property is required. Number
The max age to be allowed via CORS.

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