Share via

az communication smtp-username

Note

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

Manage smtp-username with communication.

Commands

Name Description Type Status
az communication smtp-username create

Create an SmtpUsernameResource.

 Extension GA
az communication smtp-username delete

Delete to delete a single SmtpUsername resource.

 Extension GA
az communication smtp-username list

List all SmtpUsernameResources for a Communication resource.

 Extension GA
az communication smtp-username show

Get a SmtpUsernameResource.

 Extension GA
az communication smtp-username update

Update an SmtpUsernameResource.

 Extension GA

az communication smtp-username create

Create an SmtpUsernameResource.

az communication smtp-username create --comm-service-name
                                      --name --smtp-username
                                      --resource-group
                                      [--entra-application-id]
                                      [--tenant-id]
                                      [--username]

Examples

CreateOrUpdate SmtpUsername resource

az communication smtp-username create --resource-group contosoResourceGroup --comm-service-name contosoACSService --smtp-username smtpusername --username newuser@contoso.com --entra-application-id aaaa1111-bbbb-2222-3333-aaaa111122bb --tenant-id aaaa1111-bbbb-2222-3333-aaaa11112222

Required Parameters

--comm-service-name

The name of the CommunicationService resource.

--name --smtp-username -n

The name of the SmtpUsernameResource.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--entra-application-id

The application Id for the linked Entra Application.

Property Value
Parameter group: Properties Arguments
--tenant-id

The tenant of the linked Entra Application.

Property Value
Parameter group: Properties Arguments
--username

The SMTP username. Could be free form or in the email address format.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az communication smtp-username delete

Delete to delete a single SmtpUsername resource.

az communication smtp-username delete [--comm-service-name]
                                      [--ids]
                                      [--name --smtp-username]
                                      [--resource-group]
                                      [--subscription]
                                      [--yes]

Examples

Delete a SmtpUsername resource.

az communication smtp-username delete --resource-group contosoResourceGroup --comm-service-name contosoACSService --smtp-username smtpusername

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--comm-service-name

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name --smtp-username -n

The name of the SmtpUsernameResource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az communication smtp-username list

List all SmtpUsernameResources for a Communication resource.

az communication smtp-username list --comm-service-name
                                    --resource-group
                                    [--max-items]
                                    [--next-token]

Examples

Get all SmtpUsername resources for a CommunicationService resource.

az communication smtp-username list --resource-group contosoResourceGroup --comm-service-name contosoACSService

Required Parameters

--comm-service-name

The name of the CommunicationService resource.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az communication smtp-username show

Get a SmtpUsernameResource.

az communication smtp-username show [--comm-service-name]
                                    [--ids]
                                    [--name --smtp-username]
                                    [--resource-group]
                                    [--subscription]

Examples

Get a SmtpUsername resource.

az communication smtp-username show --resource-group contosoResourceGroup --comm-service-name contosoACSService --smtp-username smtpusername

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--comm-service-name

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--name --smtp-username -n

The name of the SmtpUsernameResource.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False

az communication smtp-username update

Update an SmtpUsernameResource.

az communication smtp-username update [--add]
                                      [--comm-service-name]
                                      [--entra-application-id]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--name --smtp-username]
                                      [--remove]
                                      [--resource-group]
                                      [--set]
                                      [--subscription]
                                      [--tenant-id]
                                      [--username]

Examples

Update SmtpUsername resource

az communication smtp-username update--resource-group contosoResourceGroup --comm-service-name contosoACSService --smtp-username smtpusername --entra-application-id aaaa1111-bbbb-2222-3333-aaaa111122bb

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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>.

Property Value
Parameter group: Generic Update Arguments
--comm-service-name

The name of the CommunicationService resource.

Property Value
Parameter group: Resource Id Arguments
--entra-application-id

The application Id for the linked Entra Application.

Property Value
Parameter group: Properties Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--name --smtp-username -n

The name of the SmtpUsernameResource.

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tenant-id

The tenant of the linked Entra Application.

Property Value
Parameter group: Properties Arguments
--username

The SMTP username. Could be free form or in the email address format.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False