Get-AzEmailServiceDomain

Reference

Module:: Az.Communication

Get the Domains resource and its properties.

Syntax

Get-AzEmailServiceDomain
   -EmailServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEmailServiceDomain
   -EmailServiceName <String>
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEmailServiceDomain
   -Name <String>
   -EmailServiceInputObject <IEmailServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEmailServiceDomain
   -InputObject <IEmailServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the Domains resource and its properties.

Examples

Example 1: List existing Email Service domains for a Subscription

Get-AzEmailServiceDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1

Location Name                                           SystemDataCreatedAt SystemDataCreatedBy        SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastM
                                                                                                                                                        odifiedBy
-------- ----                                           ------------------- -------------------        ----------------------- ------------------------ ---------------
global   AzureManagedDomain                             08-12-2023 05:34:31 test@microsoft.com         User                    28-01-2024 13:58:25      test@microsoft.com
global   customdomain.net                               07-02-2024 06:11:24 test@microsoft.com         User                    14-02-2024 06:25:26      test@microsoft.com

Returns a list of all domain resources under that email services.

Example 2: Get infomation on specified Azure Email services resource

Get-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1

DataLocation                 : unitedstates
Dkim2ErrorCode               :
Dkim2Status                  : Verified
DkimErrorCode                :
DkimStatus                   : Verified
DmarcErrorCode               :
DmarcStatus                  : Verified
DomainErrorCode              :
DomainManagement             : AzureManaged
DomainStatus                 : Verified
FromSenderDomain             : a3d08608-7f9d-4d33-9c79-8b635d9220ab.azurecomm.net
Id                           : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers
                               /Microsoft.Communication/emailServices/ContosoAcsResource1/domains/AzureManaged
                               Domain
Location                     : global
MailFromSenderDomain         : a3d08608-7f9d-4d33-9c79-8b635d9220ab.azurecomm.net
Name                         : AzureManagedDomain
ProvisioningState            : Succeeded
ResourceGroupName            : ContosoResourceProvider1
SpfErrorCode                 :
SpfStatus                    : Verified
SystemDataCreatedAt          : 08-12-2023 05:34:31
SystemDataCreatedBy          : test@microsoft.com
SystemDataCreatedByType      : User
SystemDataLastModifiedAt     : 28-01-2024 13:58:25
SystemDataLastModifiedBy     : test@microsoft.com
SystemDataLastModifiedByType : User
Tag                          : {
                                 "ExampleKey1": "ExampleValue1"
                               }
Type                         : microsoft.communication/emailservices/domains
UserEngagementTracking       : Disabled
VerificationRecord           : {
                               }

Returns the information on an domain resource, if one matching provided parameters is found.

Parameters

-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

-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

-InputObject

Identity Parameter

Type:	IEmailServiceIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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

-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

Inputs

IEmailServiceIdentity

Outputs

IDomainResource

Share via