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

We recommend using Azure Native.

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

azure.healthcare.DicomService

Explore with Pulumi AI

Manages a Healthcare DICOM Service

Example Usage

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

const test = new azure.healthcare.Workspace("test", {
    name: "tfexworkspace",
    resourceGroupName: "tfex-resource_group",
    location: "east us",
});
const testDicomService = new azure.healthcare.DicomService("test", {
    name: "tfexDicom",
    workspaceId: test.id,
    location: "east us",
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        environment: "None",
    },
});
Copy
import pulumi
import pulumi_azure as azure

test = azure.healthcare.Workspace("test",
    name="tfexworkspace",
    resource_group_name="tfex-resource_group",
    location="east us")
test_dicom_service = azure.healthcare.DicomService("test",
    name="tfexDicom",
    workspace_id=test.id,
    location="east us",
    identity={
        "type": "SystemAssigned",
    },
    tags={
        "environment": "None",
    })
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 {
		test, err := healthcare.NewWorkspace(ctx, "test", &healthcare.WorkspaceArgs{
			Name:              pulumi.String("tfexworkspace"),
			ResourceGroupName: pulumi.String("tfex-resource_group"),
			Location:          pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		_, err = healthcare.NewDicomService(ctx, "test", &healthcare.DicomServiceArgs{
			Name:        pulumi.String("tfexDicom"),
			WorkspaceId: test.ID(),
			Location:    pulumi.String("east us"),
			Identity: &healthcare.DicomServiceIdentityArgs{
				Type: pulumi.String("SystemAssigned"),
			},
			Tags: pulumi.StringMap{
				"environment": pulumi.String("None"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var test = new Azure.Healthcare.Workspace("test", new()
    {
        Name = "tfexworkspace",
        ResourceGroupName = "tfex-resource_group",
        Location = "east us",
    });

    var testDicomService = new Azure.Healthcare.DicomService("test", new()
    {
        Name = "tfexDicom",
        WorkspaceId = test.Id,
        Location = "east us",
        Identity = new Azure.Healthcare.Inputs.DicomServiceIdentityArgs
        {
            Type = "SystemAssigned",
        },
        Tags = 
        {
            { "environment", "None" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.healthcare.Workspace;
import com.pulumi.azure.healthcare.WorkspaceArgs;
import com.pulumi.azure.healthcare.DicomService;
import com.pulumi.azure.healthcare.DicomServiceArgs;
import com.pulumi.azure.healthcare.inputs.DicomServiceIdentityArgs;
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 test = new Workspace("test", WorkspaceArgs.builder()
            .name("tfexworkspace")
            .resourceGroupName("tfex-resource_group")
            .location("east us")
            .build());

        var testDicomService = new DicomService("testDicomService", DicomServiceArgs.builder()
            .name("tfexDicom")
            .workspaceId(test.id())
            .location("east us")
            .identity(DicomServiceIdentityArgs.builder()
                .type("SystemAssigned")
                .build())
            .tags(Map.of("environment", "None"))
            .build());

    }
}
Copy
resources:
  test:
    type: azure:healthcare:Workspace
    properties:
      name: tfexworkspace
      resourceGroupName: tfex-resource_group
      location: east us
  testDicomService:
    type: azure:healthcare:DicomService
    name: test
    properties:
      name: tfexDicom
      workspaceId: ${test.id}
      location: east us
      identity:
        type: SystemAssigned
      tags:
        environment: None
Copy

Create DicomService Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DicomService(name: string, args: DicomServiceArgs, opts?: CustomResourceOptions);
@overload
def DicomService(resource_name: str,
                 args: DicomServiceArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def DicomService(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 workspace_id: Optional[str] = None,
                 cors: Optional[DicomServiceCorsArgs] = None,
                 data_partitions_enabled: Optional[bool] = None,
                 encryption_key_url: Optional[str] = None,
                 identity: Optional[DicomServiceIdentityArgs] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 public_network_access_enabled: Optional[bool] = None,
                 storage: Optional[DicomServiceStorageArgs] = None,
                 tags: Optional[Mapping[str, str]] = None)
func NewDicomService(ctx *Context, name string, args DicomServiceArgs, opts ...ResourceOption) (*DicomService, error)
public DicomService(string name, DicomServiceArgs args, CustomResourceOptions? opts = null)
public DicomService(String name, DicomServiceArgs args)
public DicomService(String name, DicomServiceArgs args, CustomResourceOptions options)
type: azure:healthcare:DicomService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DicomServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DicomServiceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DicomServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DicomServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DicomServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var dicomServiceResource = new Azure.Healthcare.DicomService("dicomServiceResource", new()
{
    WorkspaceId = "string",
    Cors = new Azure.Healthcare.Inputs.DicomServiceCorsArgs
    {
        AllowCredentials = false,
        AllowedHeaders = new[]
        {
            "string",
        },
        AllowedMethods = new[]
        {
            "string",
        },
        AllowedOrigins = new[]
        {
            "string",
        },
        MaxAgeInSeconds = 0,
    },
    DataPartitionsEnabled = false,
    EncryptionKeyUrl = "string",
    Identity = new Azure.Healthcare.Inputs.DicomServiceIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    PublicNetworkAccessEnabled = false,
    Storage = new Azure.Healthcare.Inputs.DicomServiceStorageArgs
    {
        FileSystemName = "string",
        StorageAccountId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := healthcare.NewDicomService(ctx, "dicomServiceResource", &healthcare.DicomServiceArgs{
	WorkspaceId: pulumi.String("string"),
	Cors: &healthcare.DicomServiceCorsArgs{
		AllowCredentials: pulumi.Bool(false),
		AllowedHeaders: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedMethods: pulumi.StringArray{
			pulumi.String("string"),
		},
		AllowedOrigins: pulumi.StringArray{
			pulumi.String("string"),
		},
		MaxAgeInSeconds: pulumi.Int(0),
	},
	DataPartitionsEnabled: pulumi.Bool(false),
	EncryptionKeyUrl:      pulumi.String("string"),
	Identity: &healthcare.DicomServiceIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:                   pulumi.String("string"),
	Name:                       pulumi.String("string"),
	PublicNetworkAccessEnabled: pulumi.Bool(false),
	Storage: &healthcare.DicomServiceStorageArgs{
		FileSystemName:   pulumi.String("string"),
		StorageAccountId: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var dicomServiceResource = new DicomService("dicomServiceResource", DicomServiceArgs.builder()
    .workspaceId("string")
    .cors(DicomServiceCorsArgs.builder()
        .allowCredentials(false)
        .allowedHeaders("string")
        .allowedMethods("string")
        .allowedOrigins("string")
        .maxAgeInSeconds(0)
        .build())
    .dataPartitionsEnabled(false)
    .encryptionKeyUrl("string")
    .identity(DicomServiceIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .publicNetworkAccessEnabled(false)
    .storage(DicomServiceStorageArgs.builder()
        .fileSystemName("string")
        .storageAccountId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());
Copy
dicom_service_resource = azure.healthcare.DicomService("dicomServiceResource",
    workspace_id="string",
    cors={
        "allow_credentials": False,
        "allowed_headers": ["string"],
        "allowed_methods": ["string"],
        "allowed_origins": ["string"],
        "max_age_in_seconds": 0,
    },
    data_partitions_enabled=False,
    encryption_key_url="string",
    identity={
        "type": "string",
        "identity_ids": ["string"],
        "principal_id": "string",
        "tenant_id": "string",
    },
    location="string",
    name="string",
    public_network_access_enabled=False,
    storage={
        "file_system_name": "string",
        "storage_account_id": "string",
    },
    tags={
        "string": "string",
    })
Copy
const dicomServiceResource = new azure.healthcare.DicomService("dicomServiceResource", {
    workspaceId: "string",
    cors: {
        allowCredentials: false,
        allowedHeaders: ["string"],
        allowedMethods: ["string"],
        allowedOrigins: ["string"],
        maxAgeInSeconds: 0,
    },
    dataPartitionsEnabled: false,
    encryptionKeyUrl: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    publicNetworkAccessEnabled: false,
    storage: {
        fileSystemName: "string",
        storageAccountId: "string",
    },
    tags: {
        string: "string",
    },
});
Copy
type: azure:healthcare:DicomService
properties:
    cors:
        allowCredentials: false
        allowedHeaders:
            - string
        allowedMethods:
            - string
        allowedOrigins:
            - string
        maxAgeInSeconds: 0
    dataPartitionsEnabled: false
    encryptionKeyUrl: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    publicNetworkAccessEnabled: false
    storage:
        fileSystemName: string
        storageAccountId: string
    tags:
        string: string
    workspaceId: string
Copy

DicomService Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DicomService resource accepts the following input properties:

WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
Cors DicomServiceCors
A cors block as defined below.
DataPartitionsEnabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
EncryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
Identity DicomServiceIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
PublicNetworkAccessEnabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
Storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
Tags Dictionary<string, string>
A mapping of tags to assign to the Healthcare DICOM Service.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
Cors DicomServiceCorsArgs
A cors block as defined below.
DataPartitionsEnabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
EncryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
Identity DicomServiceIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
PublicNetworkAccessEnabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
Storage Changes to this property will trigger replacement. DicomServiceStorageArgs
A storage block as defined below.
Tags map[string]string
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
cors DicomServiceCors
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. Boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl String
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
publicNetworkAccessEnabled Boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
tags Map<String,String>
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
cors DicomServiceCors
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
publicNetworkAccessEnabled boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
tags {[key: string]: string}
A mapping of tags to assign to the Healthcare DICOM Service.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
cors DicomServiceCorsArgs
A cors block as defined below.
data_partitions_enabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryption_key_url str
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
public_network_access_enabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
storage Changes to this property will trigger replacement. DicomServiceStorageArgs
A storage block as defined below.
tags Mapping[str, str]
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
cors Property Map
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. Boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl String
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
publicNetworkAccessEnabled Boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
storage Changes to this property will trigger replacement. Property Map
A storage block as defined below.
tags Map<String>
A mapping of tags to assign to the Healthcare DICOM Service.

Outputs

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

Authentications List<DicomServiceAuthentication>
The authentication block as defined below.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpoints List<DicomServicePrivateEndpoint>
ServiceUrl string
The url of the Healthcare DICOM Services.
Authentications []DicomServiceAuthentication
The authentication block as defined below.
Id string
The provider-assigned unique ID for this managed resource.
PrivateEndpoints []DicomServicePrivateEndpoint
ServiceUrl string
The url of the Healthcare DICOM Services.
authentications List<DicomServiceAuthentication>
The authentication block as defined below.
id String
The provider-assigned unique ID for this managed resource.
privateEndpoints List<DicomServicePrivateEndpoint>
serviceUrl String
The url of the Healthcare DICOM Services.
authentications DicomServiceAuthentication[]
The authentication block as defined below.
id string
The provider-assigned unique ID for this managed resource.
privateEndpoints DicomServicePrivateEndpoint[]
serviceUrl string
The url of the Healthcare DICOM Services.
authentications Sequence[DicomServiceAuthentication]
The authentication block as defined below.
id str
The provider-assigned unique ID for this managed resource.
private_endpoints Sequence[DicomServicePrivateEndpoint]
service_url str
The url of the Healthcare DICOM Services.
authentications List<Property Map>
The authentication block as defined below.
id String
The provider-assigned unique ID for this managed resource.
privateEndpoints List<Property Map>
serviceUrl String
The url of the Healthcare DICOM Services.

Look up Existing DicomService Resource

Get an existing DicomService 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?: DicomServiceState, opts?: CustomResourceOptions): DicomService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentications: Optional[Sequence[DicomServiceAuthenticationArgs]] = None,
        cors: Optional[DicomServiceCorsArgs] = None,
        data_partitions_enabled: Optional[bool] = None,
        encryption_key_url: Optional[str] = None,
        identity: Optional[DicomServiceIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        private_endpoints: Optional[Sequence[DicomServicePrivateEndpointArgs]] = None,
        public_network_access_enabled: Optional[bool] = None,
        service_url: Optional[str] = None,
        storage: Optional[DicomServiceStorageArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        workspace_id: Optional[str] = None) -> DicomService
func GetDicomService(ctx *Context, name string, id IDInput, state *DicomServiceState, opts ...ResourceOption) (*DicomService, error)
public static DicomService Get(string name, Input<string> id, DicomServiceState? state, CustomResourceOptions? opts = null)
public static DicomService get(String name, Output<String> id, DicomServiceState state, CustomResourceOptions options)
resources:  _:    type: azure:healthcare:DicomService    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Authentications List<DicomServiceAuthentication>
The authentication block as defined below.
Cors DicomServiceCors
A cors block as defined below.
DataPartitionsEnabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
EncryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
Identity DicomServiceIdentity
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
PrivateEndpoints List<DicomServicePrivateEndpoint>
PublicNetworkAccessEnabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
ServiceUrl string
The url of the Healthcare DICOM Services.
Storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
Tags Dictionary<string, string>
A mapping of tags to assign to the Healthcare DICOM Service.
WorkspaceId Changes to this property will trigger replacement. string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
Authentications []DicomServiceAuthenticationArgs
The authentication block as defined below.
Cors DicomServiceCorsArgs
A cors block as defined below.
DataPartitionsEnabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
EncryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
Identity DicomServiceIdentityArgs
An identity block as defined below.
Location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
Name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
PrivateEndpoints []DicomServicePrivateEndpointArgs
PublicNetworkAccessEnabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
ServiceUrl string
The url of the Healthcare DICOM Services.
Storage Changes to this property will trigger replacement. DicomServiceStorageArgs
A storage block as defined below.
Tags map[string]string
A mapping of tags to assign to the Healthcare DICOM Service.
WorkspaceId Changes to this property will trigger replacement. string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
authentications List<DicomServiceAuthentication>
The authentication block as defined below.
cors DicomServiceCors
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. Boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl String
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
privateEndpoints List<DicomServicePrivateEndpoint>
publicNetworkAccessEnabled Boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
serviceUrl String
The url of the Healthcare DICOM Services.
storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
tags Map<String,String>
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId Changes to this property will trigger replacement. String
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
authentications DicomServiceAuthentication[]
The authentication block as defined below.
cors DicomServiceCors
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl string
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentity
An identity block as defined below.
location Changes to this property will trigger replacement. string
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
privateEndpoints DicomServicePrivateEndpoint[]
publicNetworkAccessEnabled boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
serviceUrl string
The url of the Healthcare DICOM Services.
storage Changes to this property will trigger replacement. DicomServiceStorage
A storage block as defined below.
tags {[key: string]: string}
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId Changes to this property will trigger replacement. string
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
authentications Sequence[DicomServiceAuthenticationArgs]
The authentication block as defined below.
cors DicomServiceCorsArgs
A cors block as defined below.
data_partitions_enabled Changes to this property will trigger replacement. bool
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryption_key_url str
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity DicomServiceIdentityArgs
An identity block as defined below.
location Changes to this property will trigger replacement. str
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. str
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
private_endpoints Sequence[DicomServicePrivateEndpointArgs]
public_network_access_enabled bool
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
service_url str
The url of the Healthcare DICOM Services.
storage Changes to this property will trigger replacement. DicomServiceStorageArgs
A storage block as defined below.
tags Mapping[str, str]
A mapping of tags to assign to the Healthcare DICOM Service.
workspace_id Changes to this property will trigger replacement. str
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.
authentications List<Property Map>
The authentication block as defined below.
cors Property Map
A cors block as defined below.
dataPartitionsEnabled Changes to this property will trigger replacement. Boolean
If data partitions are enabled or not. Defaults to false. Changing this forces a new Healthcare DICOM Service to be created.
encryptionKeyUrl String
The URL of the key to use for encryption as part of the customer-managed key encryption settings. For more details, refer to the Azure Customer-Managed Keys Overview.
identity Property Map
An identity block as defined below.
location Changes to this property will trigger replacement. String
Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.
name Changes to this property will trigger replacement. String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
privateEndpoints List<Property Map>
publicNetworkAccessEnabled Boolean
Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.
serviceUrl String
The url of the Healthcare DICOM Services.
storage Changes to this property will trigger replacement. Property Map
A storage block as defined below.
tags Map<String>
A mapping of tags to assign to the Healthcare DICOM Service.
workspaceId Changes to this property will trigger replacement. String
Specifies the ID of the Healthcare Workspace where the Healthcare DICOM Service should exist. Changing this forces a new Healthcare DICOM Service to be created.

Supporting Types

DicomServiceAuthentication
, DicomServiceAuthenticationArgs

Audiences List<string>
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
Authority string
Audiences []string
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
Authority string
audiences List<String>
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
authority String
audiences string[]
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
authority string
audiences Sequence[str]
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
authority str
audiences List<String>
The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com
authority String

DicomServiceCors
, DicomServiceCorsArgs

AllowCredentials bool
Whether to allow credentials in CORS. Defaults to false.
AllowedHeaders List<string>
A list of allowed headers for CORS.
AllowedMethods List<string>
A list of allowed methods for CORS.
AllowedOrigins List<string>
A list of allowed origins for CORS.
MaxAgeInSeconds int
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).
AllowCredentials bool
Whether to allow credentials in CORS. Defaults to false.
AllowedHeaders []string
A list of allowed headers for CORS.
AllowedMethods []string
A list of allowed methods for CORS.
AllowedOrigins []string
A list of allowed origins for CORS.
MaxAgeInSeconds int
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).
allowCredentials Boolean
Whether to allow credentials in CORS. Defaults to false.
allowedHeaders List<String>
A list of allowed headers for CORS.
allowedMethods List<String>
A list of allowed methods for CORS.
allowedOrigins List<String>
A list of allowed origins for CORS.
maxAgeInSeconds Integer
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).
allowCredentials boolean
Whether to allow credentials in CORS. Defaults to false.
allowedHeaders string[]
A list of allowed headers for CORS.
allowedMethods string[]
A list of allowed methods for CORS.
allowedOrigins string[]
A list of allowed origins for CORS.
maxAgeInSeconds number
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).
allow_credentials bool
Whether to allow credentials in CORS. Defaults to false.
allowed_headers Sequence[str]
A list of allowed headers for CORS.
allowed_methods Sequence[str]
A list of allowed methods for CORS.
allowed_origins Sequence[str]
A list of allowed origins for CORS.
max_age_in_seconds int
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).
allowCredentials Boolean
Whether to allow credentials in CORS. Defaults to false.
allowedHeaders List<String>
A list of allowed headers for CORS.
allowedMethods List<String>
A list of allowed methods for CORS.
allowedOrigins List<String>
A list of allowed origins for CORS.
maxAgeInSeconds Number
The maximum age in seconds for the CORS configuration (must be between 0 and 99998 inclusive).

DicomServiceIdentity
, DicomServiceIdentityArgs

Type This property is required. string
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
IdentityIds List<string>
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
PrincipalId string
TenantId string
Type This property is required. string
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
IdentityIds []string
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
PrincipalId string
TenantId string
type This property is required. String
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
identityIds List<String>
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
principalId String
tenantId String
type This property is required. string
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
identityIds string[]
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
principalId string
tenantId string
type This property is required. str
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
identity_ids Sequence[str]
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
principal_id str
tenant_id str
type This property is required. String
The type of identity used for the Healthcare DICOM service. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. If UserAssigned is set, an identity_ids must be set as well.
identityIds List<String>
A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.
principalId String
tenantId String

DicomServicePrivateEndpoint
, DicomServicePrivateEndpointArgs

Id string
The ID of the Healthcare DICOM Service.
Name string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
Id string
The ID of the Healthcare DICOM Service.
Name string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
id String
The ID of the Healthcare DICOM Service.
name String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
id string
The ID of the Healthcare DICOM Service.
name string
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
id str
The ID of the Healthcare DICOM Service.
name str
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.
id String
The ID of the Healthcare DICOM Service.
name String
Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.

DicomServiceStorage
, DicomServiceStorageArgs

FileSystemName
This property is required.
Changes to this property will trigger replacement.
string
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
StorageAccountId
This property is required.
Changes to this property will trigger replacement.
string

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

FileSystemName
This property is required.
Changes to this property will trigger replacement.
string
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
StorageAccountId
This property is required.
Changes to this property will trigger replacement.
string

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

fileSystemName
This property is required.
Changes to this property will trigger replacement.
String
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
String

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

fileSystemName
This property is required.
Changes to this property will trigger replacement.
string
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
string

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

file_system_name
This property is required.
Changes to this property will trigger replacement.
str
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
storage_account_id
This property is required.
Changes to this property will trigger replacement.
str

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

fileSystemName
This property is required.
Changes to this property will trigger replacement.
String
The filesystem name of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
String

The resource ID of connected storage account. Changing this forces a new Healthcare DICOM Service to be created.

Note: The is_hns_enabled needs to be set to true for the storage account to be used with the Healthcare DICOM Service.

Import

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

$ pulumi import azure:healthcare/dicomService:DicomService example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomServices/service1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.