Microsoft.Communication (preview:2024-09-01)

2025/02/13 • 41 new methods

Operations_List (new)
Description :  Lists all of the available REST API operations of the Microsoft.Communication provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Communication/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_CheckNameAvailability (new)
Description :  Checks that the CommunicationService name is valid and is not already in use.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/checkNameAvailability
{
nameAvailabilityParameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_LinkNotificationHub (new)
Description :  Links an Azure Notification Hub to this communication service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/linkNotificationHub
{
linkNotificationHubParameters:
{
Description: Parameters supplied to the operation. ,
Required: False ,
}
{
resourceId:
{
Description: The resource ID of the notification hub ,
Required: True ,
}
string ,
connectionString:
{
Description: Connection string for the notification hub ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: The resource ID of the notification hub ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_ListBySubscription (new)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/communicationServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CommunicationService ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_ListByResourceGroup (new)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of CommunicationService ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_Update (new)
Description :  Operation to update an existing CommunicationService.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_Get (new)
Description :  Get the CommunicationService and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_CreateOrUpdate (new)
Description :  Create a new CommunicationService or update an existing CommunicationService.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: A class representing a CommunicationService resource. ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
hostName:
{
Description: FQDN of the CommunicationService instance. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the communication service stores its data at rest. ,
Required: True ,
}
string ,
notificationHubId:
{
Description: Resource ID of an Azure Notification Hub linked to this resource. ,
Required: False ,
}
string ,
version:
{
Description: Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs. ,
Required: False ,
}
string ,
immutableResourceId:
{
Description: The immutable resource Id of the communication service. ,
Required: False ,
}
string ,
linkedDomains:
{
Description: List of email Domain resource Ids. ,
Required: False ,
}
[
string ,
]
,
}
,
identity:
{
Description: Managed service identity (system assigned and/or user assigned identities) ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_Delete (new)
Description :  Operation to delete a CommunicationService.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_ListKeys (new)
Description :  Get the access keys of the CommunicationService resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/listKeys
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: CommunicationService connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: CommunicationService connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CommunicationServices_RegenerateKey (new)
Description :  Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/regenerateKey
{
parameters:
{
Description: Parameter that describes the Regenerate Key Operation. ,
Required: True ,
}
{
keyType:
{
Description: The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). ,
Enum:
{
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: The primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: The secondary access key. ,
Required: False ,
}
string ,
primaryConnectionString:
{
Description: CommunicationService connection string constructed via the primaryKey ,
Required: False ,
}
string ,
secondaryConnectionString:
{
Description: CommunicationService connection string constructed via the secondaryKey ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_Get (new)
Description :  Get the Domains resource and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_CreateOrUpdate (new)
Description :  Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: A class representing a Domains resource. ,
}
{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_Delete (new)
Description :  Operation to delete a Domains resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_Update (new)
Description :  Operation to update an existing Domains resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
{
properties:
{
Description: A class that describes the updatable properties of a Domains resource. ,
Required: False ,
}
{
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: A class representing a Domains resource. ,
}
{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_ListByEmailServiceResource (new)
Description :  Handles requests to list all Domains resources under the parent EmailServices resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Domains resource ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a Domains resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the Domains resource data is stored at rest. ,
Required: False ,
}
string ,
fromSenderDomain:
{
Description: P2 sender domain that is displayed to the email recipients [RFC 5322]. ,
Required: False ,
}
string ,
mailFromSenderDomain:
{
Description: P1 sender domain that is present on the email envelope [RFC 5321]. ,
Required: False ,
}
string ,
domainManagement:
{
Description: Describes how a Domains resource is being managed. ,
Enum:
{
AzureManaged: No description available. ,
CustomerManaged: No description available. ,
CustomerManagedInExchangeOnline: No description available. ,
}
,
Required: True ,
}
enum ,
verificationStates:
{
Description: List of VerificationStatusRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
status:
{
Description: Status of the verification operation. ,
Enum:
{
NotStarted: No description available. ,
VerificationRequested: No description available. ,
VerificationInProgress: No description available. ,
VerificationFailed: No description available. ,
Verified: No description available. ,
CancellationRequested: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Error code. This property will only be present if the status is UnableToVerify. ,
Required: False ,
}
string ,
}
,
}
,
verificationRecords:
{
Description: List of DnsRecord ,
Required: False ,
}
{
Domain:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
SPF:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DKIM2:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
DMARC:
{
Description: A class that represents a VerificationStatus record. ,
Required: False ,
}
{
type:
{
Description: Type of the DNS record. Example: TXT ,
Required: False ,
}
string ,
name:
{
Description: Name of the DNS record. ,
Required: False ,
}
string ,
value:
{
Description: Value of the DNS record. ,
Required: False ,
}
string ,
ttl:
{
Description: Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
userEngagementTracking:
{
Description: Describes whether user engagement tracking is enabled or disabled. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_InitiateVerification (new)
Description :  Initiate verification of DNS record.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/initiateVerification
{
parameters:
{
Description: Type of verification to be initiated. ,
Required: True ,
}
{
verificationType:
{
Description: Type of verification. ,
Enum:
{
Domain: No description available. ,
SPF: No description available. ,
DKIM: No description available. ,
DKIM2: No description available. ,
DMARC: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Domains_CancelVerification (new)
Description :  Cancel verification of DNS record.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/cancelVerification
{
parameters:
{
Description: Type of verification to be canceled. ,
Required: True ,
}
{
verificationType:
{
Description: Type of verification. ,
Enum:
{
Domain: No description available. ,
SPF: No description available. ,
DKIM: No description available. ,
DKIM2: No description available. ,
DMARC: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_Get (new)
Description :  Get the EmailService and its properties.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_CreateOrUpdate (new)
Description :  Create a new EmailService or update an existing EmailService.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: A class representing an EmailService resource. ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_Delete (new)
Description :  Operation to delete a EmailService.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_Update (new)
Description :  Operation to update an existing EmailService.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}
{
parameters:
{
Description: Parameters for the update operation ,
Required: True ,
}
object ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}
,
$schema:
{
Description: A class representing an EmailService resource. ,
}
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_ListBySubscription (new)
Description :  Handles requests to list all resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/emailServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of EmailService ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_ListByResourceGroup (new)
Description :  Handles requests to list all resources in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of EmailService ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the service. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
dataLocation:
{
Description: The location where the email service stores its data at rest. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). It's null for now, added for future use. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EmailServices_ListVerifiedExchangeOnlineDomains (new)
Description :  Get a list of domains that are fully verified in Exchange Online.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Communication/listVerifiedExchangeOnlineDomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: List of FQDNs of verified domains in Exchange Online. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SenderUsernames_ListByDomains (new)
Description :  List all valid sender usernames for a domains resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SenderUsernames ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a SenderUsername resource. ,
Required: False ,
}
{
dataLocation:
{
Description: The location where the SenderUsername resource data is stored at rest. ,
Required: False ,
}
string ,
username:
{
Description: A sender senderUsername to be used when sending emails. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the senderUsername. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. Unknown is the default state for Communication Services. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SenderUsernames_Get (new)
Description :  Get a valid sender username for a domains resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
senderUsername:
{
Description: The valid sender Username. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SenderUsername resource. ,
Required: False ,
}
{
dataLocation:
{
Description: The location where the SenderUsername resource data is stored at rest. ,
Required: False ,
}
string ,
username:
{
Description: A sender senderUsername to be used when sending emails. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the senderUsername. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. Unknown is the default state for Communication Services. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SenderUsernames_CreateOrUpdate (new)
Description :  Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}
{
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a SenderUsername resource. ,
Required: False ,
}
{
dataLocation:
{
Description: The location where the SenderUsername resource data is stored at rest. ,
Required: False ,
}
string ,
username:
{
Description: A sender senderUsername to be used when sending emails. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the senderUsername. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. Unknown is the default state for Communication Services. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
senderUsername:
{
Description: The valid sender Username. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SenderUsername resource. ,
Required: False ,
}
{
dataLocation:
{
Description: The location where the SenderUsername resource data is stored at rest. ,
Required: False ,
}
string ,
username:
{
Description: A sender senderUsername to be used when sending emails. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the senderUsername. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. Unknown is the default state for Communication Services. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a SenderUsername resource. ,
Required: False ,
}
{
dataLocation:
{
Description: The location where the SenderUsername resource data is stored at rest. ,
Required: False ,
}
string ,
username:
{
Description: A sender senderUsername to be used when sending emails. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the senderUsername. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. Unknown is the default state for Communication Services. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Running: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SenderUsernames_Delete (new)
Description :  Operation to delete a SenderUsernames resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
senderUsername:
{
Description: The valid sender Username. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SmtpUsernames_List (new)
Description :  Get all SmtpUsernameResources for a Communication resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/smtpUsernames
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SmtpUsername resources. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a SmtpUsername resource. ,
Required: False ,
}
{
username:
{
Description: The SMTP username. Could be free form or in the email address format. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: The application Id for the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant of the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SmtpUsernames_Get (new)
Description :  Get a SmtpUsernameResource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/smtpUsernames/{smtpUsername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
smtpUsername:
{
Description: The name of the SmtpUsernameResource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SmtpUsername resource. ,
Required: False ,
}
{
username:
{
Description: The SMTP username. Could be free form or in the email address format. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: The application Id for the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant of the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SmtpUsernames_CreateOrUpdate (new)
Description :  Create or update an SmtpUsernameResource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/smtpUsernames/{smtpUsername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
smtpUsername:
{
Description: The name of the SmtpUsernameResource. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a SmtpUsername resource. ,
Required: False ,
}
{
username:
{
Description: The SMTP username. Could be free form or in the email address format. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: The application Id for the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant of the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SmtpUsername resource. ,
Required: False ,
}
{
username:
{
Description: The SMTP username. Could be free form or in the email address format. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: The application Id for the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant of the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a SmtpUsername resource. ,
Required: False ,
}
{
username:
{
Description: The SMTP username. Could be free form or in the email address format. ,
Required: True ,
}
string ,
entraApplicationId:
{
Description: The application Id for the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant of the linked Entra Application. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SmtpUsernames_Delete (new)
Description :  Operation to delete a single SmtpUsername resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/communicationServices/{communicationServiceName}/smtpUsernames/{smtpUsername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
communicationServiceName:
{
Description: The name of the CommunicationService resource. ,
Required: True ,
}
string ,
smtpUsername:
{
Description: The name of the SmtpUsernameResource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionLists_ListByDomain (new)
Description :  List all suppression lists for a domains resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SuppressionListResource ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a SuppressionList resource. ,
Required: False ,
}
{
listName:
{
Description: The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain. ,
Required: False ,
}
string ,
lastUpdatedTimeStamp:
{
Description: The date the resource was last updated. ,
Required: False ,
}
string ,
createdTimeStamp:
{
Description: The date the resource was created. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionLists_Get (new)
Description :  Get a SuppressionList resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SuppressionList resource. ,
Required: False ,
}
{
listName:
{
Description: The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain. ,
Required: False ,
}
string ,
lastUpdatedTimeStamp:
{
Description: The date the resource was last updated. ,
Required: False ,
}
string ,
createdTimeStamp:
{
Description: The date the resource was created. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionLists_CreateOrUpdate (new)
Description :  Add a new SuppressionList resource under the parent Domains resource or update an existing SuppressionList resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a SuppressionList resource. ,
Required: False ,
}
{
listName:
{
Description: The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain. ,
Required: False ,
}
string ,
lastUpdatedTimeStamp:
{
Description: The date the resource was last updated. ,
Required: False ,
}
string ,
createdTimeStamp:
{
Description: The date the resource was created. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SuppressionList resource. ,
Required: False ,
}
{
listName:
{
Description: The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain. ,
Required: False ,
}
string ,
lastUpdatedTimeStamp:
{
Description: The date the resource was last updated. ,
Required: False ,
}
string ,
createdTimeStamp:
{
Description: The date the resource was created. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a SuppressionList resource. ,
Required: False ,
}
{
listName:
{
Description: The the name of the suppression list. This value must match one of the valid sender usernames of the sending domain. ,
Required: False ,
}
string ,
lastUpdatedTimeStamp:
{
Description: The date the resource was last updated. ,
Required: False ,
}
string ,
createdTimeStamp:
{
Description: The date the resource was created. ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionLists_Delete (new)
Description :  Delete a SuppressionList.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionListAddresses_List (new)
Description :  Get all the addresses in a suppression list.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of suppressed email addresses. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of a SuppressionListAddress resource. ,
Required: False ,
}
{
email:
{
Description: Email address of the recipient. ,
Required: True ,
}
string ,
firstName:
{
Description: The first name of the email recipient. ,
Required: False ,
}
string ,
lastName:
{
Description: The last name of the email recipient. ,
Required: False ,
}
string ,
notes:
{
Description: An optional property to provide contextual notes or a description for an address. ,
Required: False ,
}
string ,
lastModified:
{
Description: The date the address was last updated in a suppression list. ,
Format: date-time ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL the client should use to fetch the next page (per server side paging). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionListAddresses_Get (new)
Description :  Get a SuppressionListAddress.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses/{addressId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
addressId:
{
Description: The id of the address in a suppression list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SuppressionListAddress resource. ,
Required: False ,
}
{
email:
{
Description: Email address of the recipient. ,
Required: True ,
}
string ,
firstName:
{
Description: The first name of the email recipient. ,
Required: False ,
}
string ,
lastName:
{
Description: The last name of the email recipient. ,
Required: False ,
}
string ,
notes:
{
Description: An optional property to provide contextual notes or a description for an address. ,
Required: False ,
}
string ,
lastModified:
{
Description: The date the address was last updated in a suppression list. ,
Format: date-time ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionListAddresses_CreateOrUpdate (new)
Description :  Create or update a SuppressionListAddress.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses/{addressId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
addressId:
{
Description: The id of the address in a suppression list. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for the create or update operation ,
Required: True ,
}
{
properties:
{
Description: The properties of a SuppressionListAddress resource. ,
Required: False ,
}
{
email:
{
Description: Email address of the recipient. ,
Required: True ,
}
string ,
firstName:
{
Description: The first name of the email recipient. ,
Required: False ,
}
string ,
lastName:
{
Description: The last name of the email recipient. ,
Required: False ,
}
string ,
notes:
{
Description: An optional property to provide contextual notes or a description for an address. ,
Required: False ,
}
string ,
lastModified:
{
Description: The date the address was last updated in a suppression list. ,
Format: date-time ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of a SuppressionListAddress resource. ,
Required: False ,
}
{
email:
{
Description: Email address of the recipient. ,
Required: True ,
}
string ,
firstName:
{
Description: The first name of the email recipient. ,
Required: False ,
}
string ,
lastName:
{
Description: The last name of the email recipient. ,
Required: False ,
}
string ,
notes:
{
Description: An optional property to provide contextual notes or a description for an address. ,
Required: False ,
}
string ,
lastModified:
{
Description: The date the address was last updated in a suppression list. ,
Format: date-time ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of a SuppressionListAddress resource. ,
Required: False ,
}
{
email:
{
Description: Email address of the recipient. ,
Required: True ,
}
string ,
firstName:
{
Description: The first name of the email recipient. ,
Required: False ,
}
string ,
lastName:
{
Description: The last name of the email recipient. ,
Required: False ,
}
string ,
notes:
{
Description: An optional property to provide contextual notes or a description for an address. ,
Required: False ,
}
string ,
lastModified:
{
Description: The date the address was last updated in a suppression list. ,
Format: date-time ,
Required: False ,
}
string ,
dataLocation:
{
Description: The location where the SuppressionListAddress data is stored at rest. This value is inherited from the parent Domains resource. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SuppressionListAddresses_Delete (new)
Description :  Operation to delete a single address from a suppression list.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/suppressionLists/{suppressionListName}/suppressionListAddresses/{addressId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
emailServiceName:
{
Description: The name of the EmailService resource. ,
Required: True ,
}
string ,
domainName:
{
Description: The name of the Domains resource. ,
Required: True ,
}
string ,
suppressionListName:
{
Description: The name of the suppression list. ,
Required: True ,
}
string ,
addressId:
{
Description: The id of the address in a suppression list. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}