Update-AzEmailServiceSenderUsername
Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
Syntax
UpdateExpanded (Default)
Update-AzEmailServiceSenderUsername
-DomainName <String>
-EmailServiceName <String>
-ResourceGroupName <String>
-SenderUsername <String>
[-SubscriptionId <String>]
[-DisplayName <String>]
[-Username <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityEmailServiceExpanded
Update-AzEmailServiceSenderUsername
-DomainName <String>
-SenderUsername <String>
-EmailServiceInputObject <IEmailServiceIdentity>
[-DisplayName <String>]
[-Username <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityEmailService
Update-AzEmailServiceSenderUsername
-DomainName <String>
-SenderUsername <String>
-EmailServiceInputObject <IEmailServiceIdentity>
-Parameter <ISenderUsernameResource>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityDomainExpanded
Update-AzEmailServiceSenderUsername
-SenderUsername <String>
-DomainInputObject <IEmailServiceIdentity>
[-DisplayName <String>]
[-Username <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityDomain
Update-AzEmailServiceSenderUsername
-SenderUsername <String>
-DomainInputObject <IEmailServiceIdentity>
-Parameter <ISenderUsernameResource>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzEmailServiceSenderUsername
-InputObject <IEmailServiceIdentity>
[-DisplayName <String>]
[-Username <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
Examples
Example 1: Updates custom domain sender username resource.
Update-AzEmailServiceSenderUsername -SenderUsername test -Username test -DisplayName testdisplayname -DomainName testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1
DataLocation :
DisplayName : testdisplayname
Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/
ContosoAcsResource1/domains/testcustomdomain2.net/senderUsernames/test
Name : test
ProvisioningState : Succeeded
ResourceGroupName : ContosoResourceProvider1
SystemDataCreatedAt : 21-02-2024 09:17:38
SystemDataCreatedBy : test@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 21-02-2024 09:17:38
SystemDataLastModifiedBy : test@microsoft.com
SystemDataLastModifiedByType : User
Type : microsoft.communication/emailservices/domains/senderusernames
Username : test
Updates custom sender username resource with provided parameters.
Example 2: Updates azure managed domain sender username resource.
Update-AzEmailServiceSenderUsername -SenderUsername test -Username test -DisplayName testAzureDomaindisplayname -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1
DataLocation :
DisplayName : testAzureDomaindisplayname
Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/
ContosoAcsResource1/domains/AzureManagedDomain/senderUsernames/test
Name : test
ProvisioningState : Succeeded
ResourceGroupName : ContosoResourceProvider1
SystemDataCreatedAt : 21-02-2024 09:34:29
SystemDataCreatedBy : test@microsoft.com
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 21-02-2024 09:34:29
SystemDataLastModifiedBy : test@microsoft.com
SystemDataLastModifiedByType : User
Type : microsoft.communication/emailservices/domains/senderusernames
Username : test
Updates azure managed sender username resource with provided parameters.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DisplayName
The display name for the senderUsername.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailServiceExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomainExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DomainInputObject
Identity Parameter
Parameter properties
Parameter sets
UpdateViaIdentityDomainExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomain
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-DomainName
The name of the Domains resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailServiceExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailService
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityEmailServiceExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailService
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-EmailServiceName
The name of the EmailService resource.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Parameter
A class representing a SenderUsername resource.
Parameter properties
Parameter sets
UpdateViaIdentityEmailService
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomain
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SenderUsername
The valid sender Username.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailServiceExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailService
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomainExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomain
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Username
A sender senderUsername to be used when sending emails.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityEmailServiceExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityDomainExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
UpdateViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
