Azure Classic

v5.25.0 published on Thursday, Nov 24, 2022 by Pulumi

DicomService

Manages a Healthcare DICOM Service

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

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

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

});
package main

import (
	"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 {
		testWorkspace, err := healthcare.NewWorkspace(ctx, "testWorkspace", &healthcare.WorkspaceArgs{
			ResourceGroupName: pulumi.String("tfex-resource_group"),
			Location:          pulumi.String("east us"),
		})
		if err != nil {
			return err
		}
		_, err = healthcare.NewDicomService(ctx, "testDicomService", &healthcare.DicomServiceArgs{
			WorkspaceId: testWorkspace.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
	})
}
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 testWorkspace = new Workspace("testWorkspace", WorkspaceArgs.builder()        
            .resourceGroupName("tfex-resource_group")
            .location("east us")
            .build());

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

    }
}
import pulumi
import pulumi_azure as azure

test_workspace = azure.healthcare.Workspace("testWorkspace",
    resource_group_name="tfex-resource_group",
    location="east us")
test_dicom_service = azure.healthcare.DicomService("testDicomService",
    workspace_id=test_workspace.id,
    location="east us",
    identity=azure.healthcare.DicomServiceIdentityArgs(
        type="SystemAssigned",
    ),
    tags={
        "environment": "None",
    })
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const testWorkspace = new azure.healthcare.Workspace("testWorkspace", {
    resourceGroupName: "tfex-resource_group",
    location: "east us",
});
const testDicomService = new azure.healthcare.DicomService("testDicomService", {
    workspaceId: testWorkspace.id,
    location: "east us",
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        environment: "None",
    },
});
resources:
  testWorkspace:
    type: azure:healthcare:Workspace
    properties:
      resourceGroupName: tfex-resource_group
      location: east us
  testDicomService:
    type: azure:healthcare:DicomService
    properties:
      workspaceId: ${testWorkspace.id}
      location: east us
      identity:
        type: SystemAssigned
      tags:
        environment: None

Create DicomService Resource

new DicomService(name: string, args: DicomServiceArgs, opts?: CustomResourceOptions);
@overload
def DicomService(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 identity: Optional[DicomServiceIdentityArgs] = None,
                 location: Optional[str] = None,
                 name: Optional[str] = None,
                 public_network_access_enabled: Optional[bool] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 workspace_id: Optional[str] = None)
@overload
def DicomService(resource_name: str,
                 args: DicomServiceArgs,
                 opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args DicomServiceArgs
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 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 string
The unique name of the resource.
args DicomServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DicomServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DicomServiceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The DicomService resource accepts the following input properties:

WorkspaceId string

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

Identity DicomServiceIdentityArgs

An identity block as defined below.

Location 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 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.

Tags Dictionary<string, string>
WorkspaceId string

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

Identity DicomServiceIdentityArgs

An identity block as defined below.

Location 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 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.

Tags map[string]string
workspaceId String

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

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 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.

tags Map<String,String>
workspaceId string

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

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 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.

tags {[key: string]: string}
workspace_id str

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

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 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.

tags Mapping[str, str]
workspaceId String

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

identity Property Map

An identity block as defined below.

location 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 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.

tags Map<String>

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,
        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,
        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)
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:
Authentications List<DicomServiceAuthenticationArgs>

The authentication block as defined below.

Identity DicomServiceIdentityArgs

An identity block as defined below.

Location 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 string

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

PrivateEndpoints List<DicomServicePrivateEndpointArgs>
PublicNetworkAccessEnabled bool

Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled.

ServiceUrl string

The url of the Healthcare DICOM Services.

Tags Dictionary<string, string>
WorkspaceId string

Specifies the name 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.

Identity DicomServiceIdentityArgs

An identity block as defined below.

Location 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 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.

ServiceUrl string

The url of the Healthcare DICOM Services.

Tags map[string]string
WorkspaceId string

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

authentications List<DicomServiceAuthenticationArgs>

The authentication block as defined below.

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 String

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

privateEndpoints List<DicomServicePrivateEndpointArgs>
publicNetworkAccessEnabled Boolean

Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled.

serviceUrl String

The url of the Healthcare DICOM Services.

tags Map<String,String>
workspaceId String

Specifies the name 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.

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 string

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

privateEndpoints DicomServicePrivateEndpointArgs[]
publicNetworkAccessEnabled boolean

Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled.

serviceUrl string

The url of the Healthcare DICOM Services.

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

Specifies the name 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.

identity DicomServiceIdentityArgs

An identity block as defined below.

location 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 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.

service_url str

The url of the Healthcare DICOM Services.

tags Mapping[str, str]
workspace_id str

Specifies the name 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.

identity Property Map

An identity block as defined below.

location 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 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.

serviceUrl String

The url of the Healthcare DICOM Services.

tags Map<String>
workspaceId String

Specifies the name 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

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

DicomServiceIdentity

Type 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 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 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 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 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 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

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.

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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.