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 emailServices/domains 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/emailServices/domains resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Communication/emailServices/domains@2021-10-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
domainManagement: 'string'
userEngagementTracking: 'string'
validSenderUsernames: {
{customized property}: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Communication/emailServices/domains
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 253 (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: emailServices |
| properties | The properties of a Domains resource. | DomainProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DomainProperties
| Name | Description | Value |
|---|---|---|
| domainManagement | Describes how a Domains resource is being managed. | 'AzureManaged' 'CustomerManaged' 'CustomerManagedInExchangeOnline' (required) |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | 'Disabled' 'Enabled' |
| validSenderUsernames | Collection of valid sender usernames. This is a key-value pair where key=username and value=display name. | ValidSenderUsernameCollection |
TrackedResourceTags
| Name | Description | Value |
|---|
ValidSenderUsernameCollection
| Name | Description | Value |
|---|
ARM template resource definition
The emailServices/domains 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/emailServices/domains resource, add the following JSON to your template.
{
"type": "Microsoft.Communication/emailServices/domains",
"apiVersion": "2021-10-01-preview",
"name": "string",
"location": "string",
"properties": {
"domainManagement": "string",
"userEngagementTracking": "string",
"validSenderUsernames": {
"{customized property}": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Communication/emailServices/domains
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-10-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 253 (required) |
| properties | The properties of a Domains resource. | DomainProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Communication/emailServices/domains' |
DomainProperties
| Name | Description | Value |
|---|---|---|
| domainManagement | Describes how a Domains resource is being managed. | 'AzureManaged' 'CustomerManaged' 'CustomerManagedInExchangeOnline' (required) |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | 'Disabled' 'Enabled' |
| validSenderUsernames | Collection of valid sender usernames. This is a key-value pair where key=username and value=display name. | ValidSenderUsernameCollection |
TrackedResourceTags
| Name | Description | Value |
|---|
ValidSenderUsernameCollection
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The emailServices/domains 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/emailServices/domains resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Communication/emailServices/domains@2021-10-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
domainManagement = "string"
userEngagementTracking = "string"
validSenderUsernames = {
{customized property} = "string"
}
}
}
}
Property Values
Microsoft.Communication/emailServices/domains
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 253 (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: emailServices |
| properties | The properties of a Domains resource. | DomainProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Communication/emailServices/domains@2021-10-01-preview" |
DomainProperties
| Name | Description | Value |
|---|---|---|
| domainManagement | Describes how a Domains resource is being managed. | 'AzureManaged' 'CustomerManaged' 'CustomerManagedInExchangeOnline' (required) |
| userEngagementTracking | Describes whether user engagement tracking is enabled or disabled. | 'Disabled' 'Enabled' |
| validSenderUsernames | Collection of valid sender usernames. This is a key-value pair where key=username and value=display name. | ValidSenderUsernameCollection |
TrackedResourceTags
| Name | Description | Value |
|---|
ValidSenderUsernameCollection
| Name | Description | Value |
|---|