Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/dicomservices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/dicomservices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HealthcareApis/workspaces/dicomservices@2023-12-01' = {
parent: resourceSymbolicName
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
authenticationConfiguration: {}
corsConfiguration: {
allowCredentials: bool
headers: [
'string'
]
maxAge: int
methods: [
'string'
]
origins: [
'string'
]
}
encryption: {
customerManagedKeyEncryption: {
keyEncryptionKeyUrl: 'string'
}
}
publicNetworkAccess: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HealthcareApis/workspaces/dicomservices
| Name | Description | Value |
|---|---|---|
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: workspaces |
| properties | Dicom Service configuration. | DicomServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CorsConfiguration
| Name | Description | Value |
|---|---|---|
| allowCredentials | If credentials are allowed via CORS. | bool |
| headers | The headers to be allowed via CORS. | string[] |
| maxAge | The max age to be allowed via CORS. | int Constraints: Min value = 0 Max value = 99999 |
| methods | The methods to be allowed via CORS. | string[] |
| origins | The origins to be allowed via CORS. | string Constraints: Pattern = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[] |
DicomServiceAuthenticationConfiguration
| Name | Description | Value |
|---|
DicomServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationConfiguration | Dicom Service authentication configuration. | DicomServiceAuthenticationConfiguration |
| corsConfiguration | Dicom Service Cors configuration. | CorsConfiguration |
| encryption | The encryption settings of the DICOM service | Encryption |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | 'Disabled' 'Enabled' |
Encryption
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | The encryption settings for the customer-managed key | EncryptionCustomerManagedKeyEncryption |
EncryptionCustomerManagedKeyEncryption
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyUrl | The URL of the key to use for encryption | string |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
ARM template resource definition
The workspaces/dicomservices resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/dicomservices resource, add the following JSON to your template.
{
"type": "Microsoft.HealthcareApis/workspaces/dicomservices",
"apiVersion": "2023-12-01",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"authenticationConfiguration": {
},
"corsConfiguration": {
"allowCredentials": "bool",
"headers": [ "string" ],
"maxAge": "int",
"methods": [ "string" ],
"origins": [ "string" ]
},
"encryption": {
"customerManagedKeyEncryption": {
"keyEncryptionKeyUrl": "string"
}
},
"publicNetworkAccess": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HealthcareApis/workspaces/dicomservices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-12-01' |
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| properties | Dicom Service configuration. | DicomServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HealthcareApis/workspaces/dicomservices' |
CorsConfiguration
| Name | Description | Value |
|---|---|---|
| allowCredentials | If credentials are allowed via CORS. | bool |
| headers | The headers to be allowed via CORS. | string[] |
| maxAge | The max age to be allowed via CORS. | int Constraints: Min value = 0 Max value = 99999 |
| methods | The methods to be allowed via CORS. | string[] |
| origins | The origins to be allowed via CORS. | string Constraints: Pattern = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[] |
DicomServiceAuthenticationConfiguration
| Name | Description | Value |
|---|
DicomServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationConfiguration | Dicom Service authentication configuration. | DicomServiceAuthenticationConfiguration |
| corsConfiguration | Dicom Service Cors configuration. | CorsConfiguration |
| encryption | The encryption settings of the DICOM service | Encryption |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | 'Disabled' 'Enabled' |
Encryption
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | The encryption settings for the customer-managed key | EncryptionCustomerManagedKeyEncryption |
EncryptionCustomerManagedKeyEncryption
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyUrl | The URL of the key to use for encryption | string |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/dicomservices resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HealthcareApis/workspaces/dicomservices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HealthcareApis/workspaces/dicomservices@2023-12-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = "string"
properties = {
authenticationConfiguration = {
}
corsConfiguration = {
allowCredentials = bool
headers = [
"string"
]
maxAge = int
methods = [
"string"
]
origins = [
"string"
]
}
encryption = {
customerManagedKeyEncryption = {
keyEncryptionKeyUrl = "string"
}
}
publicNetworkAccess = "string"
}
}
}
Property Values
Microsoft.HealthcareApis/workspaces/dicomservices
| Name | Description | Value |
|---|---|---|
| etag | An etag associated with the resource, used for optimistic concurrency when editing it. | string |
| identity | Setting indicating whether the service has a managed identity associated with it. | ServiceManagedIdentityIdentity |
| location | The resource location. | string |
| name | The resource name | string Constraints: Min length = 3 Max length = 24 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | Dicom Service configuration. | DicomServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HealthcareApis/workspaces/dicomservices@2023-12-01" |
CorsConfiguration
| Name | Description | Value |
|---|---|---|
| allowCredentials | If credentials are allowed via CORS. | bool |
| headers | The headers to be allowed via CORS. | string[] |
| maxAge | The max age to be allowed via CORS. | int Constraints: Min value = 0 Max value = 99999 |
| methods | The methods to be allowed via CORS. | string[] |
| origins | The origins to be allowed via CORS. | string Constraints: Pattern = ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$[] |
DicomServiceAuthenticationConfiguration
| Name | Description | Value |
|---|
DicomServiceProperties
| Name | Description | Value |
|---|---|---|
| authenticationConfiguration | Dicom Service authentication configuration. | DicomServiceAuthenticationConfiguration |
| corsConfiguration | Dicom Service Cors configuration. | CorsConfiguration |
| encryption | The encryption settings of the DICOM service | Encryption |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | 'Disabled' 'Enabled' |
Encryption
| Name | Description | Value |
|---|---|---|
| customerManagedKeyEncryption | The encryption settings for the customer-managed key | EncryptionCustomerManagedKeyEncryption |
EncryptionCustomerManagedKeyEncryption
| Name | Description | Value |
|---|---|---|
| keyEncryptionKeyUrl | The URL of the key to use for encryption | string |
ResourceTags
| Name | Description | Value |
|---|
ServiceManagedIdentityIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of identity being specified, currently SystemAssigned and None are allowed. | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|