New-AzEmailServiceDomain
Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
Syntax
New-AzEmailServiceDomain
-Name <String>
-EmailServiceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Location <String>]
[-DomainManagement <String>]
[-Tag <Hashtable>]
[-UserEngagementTracking <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEmailServiceDomain
-Name <String>
-EmailServiceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonString <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEmailServiceDomain
-Name <String>
-EmailServiceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEmailServiceDomain
-Name <String>
-EmailServiceInputObject <IEmailServiceIdentity>
[-Location <String>]
[-DomainManagement <String>]
[-Tag <Hashtable>]
[-UserEngagementTracking <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzEmailServiceDomain
-Name <String>
-EmailServiceInputObject <IEmailServiceIdentity>
-Parameter <IDomainResource>
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
Examples
Example 1: Create a custom domain resource.
New-AzEmailServiceDomain -Name testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -DomainManagement CustomerManaged
DataLocation : unitedstates
Dkim2ErrorCode :
Dkim2Status : NotStarted
DkimErrorCode :
DkimStatus : NotStarted
DmarcErrorCode :
DmarcStatus : NotStarted
DomainErrorCode :
DomainManagement : CustomerManaged
DomainStatus : NotStarted
FromSenderDomain : testcustomdomain2.net
Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/
ContosoAcsResource1/domains/testcustomdomain2.net
Location : global
MailFromSenderDomain : testcustomdomain2.net
Name : testcustomdomain2.net
ProvisioningState : Succeeded
ResourceGroupName : ContosoResourceProvider1
SpfErrorCode :
SpfStatus : NotStarted
SystemDataCreatedAt : 21-02-2024 07:30:12
SystemDataCreatedBy : test@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 21-02-2024 07:30:12
SystemDataLastModifiedBy : test@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
}
Type : microsoft.communication/emailservices/domains
UserEngagementTracking : Disabled
VerificationRecord : {
"Domain": {
"type": "TXT",
"name": "testcustomdomain2.net",
"value": "ms-domain-verification=1ff18540-e0c0-422b-b956-5b4cfa13613b",
"ttl": 3600
},
"SPF": {
"type": "TXT",
"name": "testcustomdomain2.net",
"value": "v=spf1 include:spf.protection.outlook.com -all",
"ttl": 3600
},
"DKIM": {
"type": "CNAME",
"name": "selector1-azurecomm-prod-net._domainkey",
"value": "selector1-azurecomm-prod-net._domainkey.azurecomm.net",
"ttl": 3600
},
"DKIM2": {
"type": "CNAME",
"name": "selector2-azurecomm-prod-net._domainkey",
"value": "selector2-azurecomm-prod-net._domainkey.azurecomm.net",
"ttl": 3600
}
}
Create a Azure managed domain resource with the provided parameters.
Example 2: Create a Azure managed domain resource.
New-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -DomainManagement AzureManaged
DataLocation : unitedstates
Dkim2ErrorCode :
Dkim2Status : Verified
DkimErrorCode :
DkimStatus : Verified
DmarcErrorCode :
DmarcStatus : Verified
DomainErrorCode :
DomainManagement : AzureManaged
DomainStatus : Verified
FromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net
Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/
ContosoAcsResource1/domains/AzureManagedDomain
Location : global
MailFromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net
Name : AzureManagedDomain
ProvisioningState : Succeeded
ResourceGroupName : ContosoResourceProvider1
SpfErrorCode :
SpfStatus : Verified
SystemDataCreatedAt :
SystemDataCreatedBy :
SystemDataCreatedByType :
SystemDataLastModifiedAt : 21-02-2024 07:34:12
SystemDataLastModifiedBy : test@microsoft.com
SystemDataLastModifiedByType : User
Tag : {
}
Type : microsoft.communication/emailservices/domains
UserEngagementTracking : Disabled
VerificationRecord : {
}
Create a Azure managed domain resource with the provided parameters.
Parameters
-AsJob
Run the command as a job
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DomainManagement
Describes how a Domains resource is being managed.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EmailServiceInputObject
Identity Parameter
Type: | IEmailServiceIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-EmailServiceName
The name of the EmailService resource.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonFilePath
Path of Json file supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JsonString
Json string supplied to the Create operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
The geo-location where the resource lives
Type: | String |
Position: | Named |
Default value: | "global" |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the Domains resource.
Type: | String |
Aliases: | DomainName |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoWait
Run the command asynchronously
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameter
A class representing a Domains resource.
Type: | IDomainResource |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
Resource tags.
Type: | Hashtable |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserEngagementTracking
Describes whether user engagement tracking is enabled or disabled.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |