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 communicationServices 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.Communication/communicationServices resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Communication/communicationServices@2023-04-01-preview' = {
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
dataLocation: 'string'
linkedDomains: [
'string'
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Communication/communicationServices
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[-\w]+$ (required) |
| properties | The properties of the service. | CommunicationServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
CommunicationServiceProperties
| Name | Description | Value |
|---|---|---|
| dataLocation | The location where the communication service stores its data at rest. | string (required) |
| linkedDomains | List of email Domain resource Ids. | string[] |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Communication Service | AVM Resource Module for Communication Service |
ARM template resource definition
The communicationServices 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.Communication/communicationServices resource, add the following JSON to your template.
{
"type": "Microsoft.Communication/communicationServices",
"apiVersion": "2023-04-01-preview",
"name": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"dataLocation": "string",
"linkedDomains": [ "string" ]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Communication/communicationServices
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-04-01-preview' |
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[-\w]+$ (required) |
| properties | The properties of the service. | CommunicationServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Communication/communicationServices' |
CommunicationServiceProperties
| Name | Description | Value |
|---|---|---|
| dataLocation | The location where the communication service stores its data at rest. | string (required) |
| linkedDomains | List of email Domain resource Ids. | string[] |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The communicationServices 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.Communication/communicationServices resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Communication/communicationServices@2023-04-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
dataLocation = "string"
linkedDomains = [
"string"
]
}
}
}
Property Values
Microsoft.Communication/communicationServices
| Name | Description | Value |
|---|---|---|
| identity | Managed service identity (system assigned and/or user assigned identities) | ManagedServiceIdentity |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 63 Pattern = ^[-\w]+$ (required) |
| properties | The properties of the service. | CommunicationServiceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Communication/communicationServices@2023-04-01-preview" |
CommunicationServiceProperties
| Name | Description | Value |
|---|---|---|
| dataLocation | The location where the communication service stores its data at rest. | string (required) |
| linkedDomains | List of email Domain resource Ids. | string[] |
ManagedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|