Skip to content

azurermHealthcareDicomService

Manages a Healthcare DICOM Service

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
const azurermHealthcareWorkspaceTest =
  new azurerm.healthcareWorkspace.HealthcareWorkspace(this, "test", {
    location: "east us",
    name: "tfexworkspace",
    resource_group_name: "tfex-resource_group",
  });
const azurermHealthcareDicomServiceTest =
  new azurerm.healthcareDicomService.HealthcareDicomService(this, "test_1", {
    identity: [
      {
        type: "SystemAssigned",
      },
    ],
    location: "east us",
    name: "tfexDicom",
    tags: {
      environment: "None",
    },
    workspace_id: azurermHealthcareWorkspaceTest.id,
  });
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
azurermHealthcareDicomServiceTest.overrideLogicalId("test");

Argument Reference

The following arguments are supported:

  • name - (Required) Specifies the name of the Healthcare DICOM Service. Changing this forces a new Healthcare DICOM Service to be created.

  • workspaceId - (Required) 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.

  • location - (Required) Specifies the Azure Region where the Healthcare DICOM Service should be created. Changing this forces a new Healthcare DICOM Service to be created.

  • identity - (Optional) An identity block as defined below.

  • publicNetworkAccessEnabled - (Optional) Whether to enabled public networks when data plane traffic coming from public networks while private endpoint is enabled. Defaults to true.

  • tags - (Optional) A mapping of tags to assign to the Healthcare DICOM Service.

An identity block supports the following:

  • type - (Required) The type of identity used for the Healthcare DICOM service. Possible values are userAssigned, systemAssigned and systemAssigned,UserAssigned. If userAssigned is set, an identityIds must be set as well.

  • identityIds - (Optional) A list of User Assigned Identity IDs which should be assigned to this Healthcare DICOM service.

Attributes Reference

The following attributes are exported:

  • id - The ID of the Healthcare DICOM Service.

  • authentication - The authentication block as defined below.

  • serviceUrl - The url of the Healthcare DICOM Services.

An authentication block supports the following:

  • authority - The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running Terraform. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.

  • audience - The intended audience to receive authentication tokens for the service. The default value is https://dicom.azurehealthcareapis.azure.com

Timeouts

The timeouts block allows you to specify timeouts for certain actions:

  • create - (Defaults to 90 minutes) Used when creating the Healthcare DICOM Service.
  • update - (Defaults to 90 minutes) Used when updating the Healthcare DICOM Service.
  • read - (Defaults to 5 minutes) Used when retrieving the Healthcare DICOM Service.
  • delete - (Defaults to 30 minutes) Used when deleting the Healthcare DICOM Service.

Import

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

terraform import azurerm_healthcare_dicom_service.example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/group1/providers/Microsoft.HealthcareApis/workspaces/workspace1/dicomServices/service1