Get-AzEmailServiceSenderUsername

  • Reference
Module:
Az.Communication

Get a valid sender username for a domains resource.

Syntax

Get-AzEmailServiceSenderUsername
   -DomainName <String>
   -EmailServiceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEmailServiceSenderUsername
   -DomainName <String>
   -SenderUsername <String>
   -EmailServiceInputObject <IEmailServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEmailServiceSenderUsername
   -DomainName <String>
   -EmailServiceName <String>
   -ResourceGroupName <String>
   -SenderUsername <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEmailServiceSenderUsername
   -SenderUsername <String>
   -DomainInputObject <IEmailServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]
Get-AzEmailServiceSenderUsername
   -InputObject <IEmailServiceIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get a valid sender username for a domains resource.

Examples

Example 1: Get infomation on specified Azure Email services senderusername resource.

Get-AzEmailServiceSenderUsername -SenderUsername donotreply -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1

DataLocation                 :
DisplayName                  : DoNotReply
Id                           : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourcegroups/ContosoResourceProvider1/providers/microsoft.communication/emailservices/
                               ContosoAcsResource1/domains/azuremanageddomain/senderusernames/donotreply
Name                         : donotreply
ProvisioningState            :
ResourceGroupName            : ContosoResourceProvider1
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         : emailservices/domains/senderusernames
Username                     : donotreply

Returns the information on senderusername resource.

Example 2: List existing Email Service sender usernames.

Get-AzEmailServiceSenderUsername -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1

Name       SystemData SystemData SystemData    SystemData     SystemData     SystemData         ResourceGroup
           CreatedAt  CreatedBy  CreatedByType LastModifiedAt LastModifiedBy LastModifiedByType                                                                                                                                        Name
----       ---------- ---------- ------------- -------------- -------------- ------------------ ------------- 
donotreply                                                                                      ContosoResourceProvider1
test                                                                                            ContosoResourceProvider1

Returns the information on existing Email Service sender usernames.

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

-DomainInputObject

Identity Parameter

Type:IEmailServiceIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DomainName

The name of the Domains resource.

Type:String
Position:Named
Default value:None
Required:True
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

-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

-SenderUsername

The valid sender Username.

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

ISenderUsernameResource