Share via

az communication email domain sender-username

  • Preview
  • Reference

Note

This reference is part of the communication extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az communication email domain sender-username command. Learn more about extensions.

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Communication Email Domain Sender-Username.

Commands

Name Description Type Status
az communication email domain sender-username create

Create a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.

 Extension Preview
az communication email domain sender-username delete

Delete to delete a SenderUsernames resource.

 Extension Preview
az communication email domain sender-username list

List all valid sender usernames for a domains resource.

 Extension Preview
az communication email domain sender-username show

Get a valid sender username for a domains resource.

 Extension Preview
az communication email domain sender-username update

Update a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.

 Extension Preview

az communication email domain sender-username create

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.

az communication email domain sender-username create --domain-name
                                                     --email-service-name
                                                     --name
                                                     --resource-group
                                                     [--display-name]
                                                     [--username]

Examples

Create a sender username (--sender-username and --username values should be the same)

az communication email domain sender-username create --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --sender-username Username --username Username --display-name DisplayName

Required Parameters

--domain-name

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--name --sender-username -n

The valid sender Username.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--display-name

The display name for the senderUsername.

--username

A sender senderUsername to be used when sending emails.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az communication email domain sender-username delete

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete to delete a SenderUsernames resource.

az communication email domain sender-username delete [--domain-name]
                                                     [--email-service-name]
                                                     [--ids]
                                                     [--name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--yes]

Examples

Delete a sender username resource

az communication email domain sender-username delete --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --sender-username SenderUsername

Optional Parameters

--domain-name

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sender-username -n

The valid sender Username.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az communication email domain sender-username list

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all valid sender usernames for a domains resource.

az communication email domain sender-username list --domain-name
                                                   --email-service-name
                                                   --resource-group
                                                   [--max-items]
                                                   [--next-token]

Examples

Get all sender usernames from a domain resource

az communication email domain sender-username list --domain-name DomainName --email-service-name ResourceName -g ResourceGroup

Required Parameters

--domain-name

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az communication email domain sender-username show

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a valid sender username for a domains resource.

az communication email domain sender-username show [--domain-name]
                                                   [--email-service-name]
                                                   [--ids]
                                                   [--name]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Get a sender username's properties

az communication email domain sender-username show --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --sender-username SenderUsername

Optional Parameters

--domain-name

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sender-username -n

The valid sender Username.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az communication email domain sender-username update

Preview

Command group 'communication email' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.

az communication email domain sender-username update [--add]
                                                     [--display-name]
                                                     [--domain-name]
                                                     [--email-service-name]
                                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--ids]
                                                     [--name]
                                                     [--remove]
                                                     [--resource-group]
                                                     [--set]
                                                     [--subscription]
                                                     [--username]

Examples

Update a sender username with display name

az communication email domain sender-username update --domain-name DomainName --email-service-name ResourceName -g ResourceGroup --sender-username SenderUsername --display-name DisplayName

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--display-name

The display name for the senderUsername.

--domain-name

The name of the Domains resource.

--email-service-name

The name of the EmailService resource.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --sender-username -n

The valid sender Username.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--username

A sender senderUsername to be used when sending emails.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.