az network private-dns record-set mx

Manage Private DNS MX records.

Commands

az network private-dns record-set mx add-record

Add an MX record.

az network private-dns record-set mx create

Create an empty MX record set.

az network private-dns record-set mx delete

Delete an MX record set and all associated records.

az network private-dns record-set mx list

List all MX record sets in a zone.

az network private-dns record-set mx remove-record

Remove an MX record from its record set.

az network private-dns record-set mx show

Get the details of an MX record set.

az network private-dns record-set mx update

Update an MX record set.

az network private-dns record-set mx add-record

Add an MX record.

az network private-dns record-set mx add-record --exchange
                                                --preference
                                                --record-set-name
                                                --resource-group
                                                --zone-name

Examples

Add an MX record.

az network private-dns record-set mx add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -e mail.mysite.com -p 10

Required Parameters

--exchange -e

Exchange metric.

--preference -p

Preference metric.

--record-set-name -n

The name of the record set relative to the zone. Creates a new record set if one does not exist.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

az network private-dns record-set mx create

Create an empty MX record set.

az network private-dns record-set mx create --name
                                            --resource-group
                                            --zone-name
                                            [--metadata]
                                            [--ttl]

Examples

Create an empty MX record set.

az network private-dns record-set mx create -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS zone.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

Optional Parameters

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--ttl

Record set TTL (time-to-live).

default value: 3600

az network private-dns record-set mx delete

Delete an MX record set and all associated records.

az network private-dns record-set mx delete --name
                                            --resource-group
                                            --zone-name
                                            [--if-match]
                                            [--yes]

Examples

Delete an MX record set and all associated records.

az network private-dns record-set mx delete -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS zone.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

Optional Parameters

--if-match

The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.

--yes -y

Do not prompt for confirmation.

az network private-dns record-set mx list

List all MX record sets in a zone.

az network private-dns record-set mx list --resource-group
                                          --zone-name

Examples

List all MX record sets in a zone.

az network private-dns record-set mx list -g MyResourceGroup -z www.mysite.com

Required Parameters

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

az network private-dns record-set mx remove-record

Remove an MX record from its record set.

By default, if the last record in a set is removed, the record set is deleted. To retain the empty record set, include --keep-empty-record-set.

az network private-dns record-set mx remove-record --exchange
                                                   --preference
                                                   --record-set-name
                                                   --resource-group
                                                   --zone-name
                                                   [--keep-empty-record-set]

Examples

Remove an MX record from its record set.

az network private-dns record-set mx remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -e mail.mysite.com -p 10

Required Parameters

--exchange -e

Exchange metric.

--preference -p

Preference metric.

--record-set-name -n

The name of the record set relative to the zone.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

Optional Parameters

--keep-empty-record-set

Keep the empty record set if the last record is removed.

az network private-dns record-set mx show

Get the details of an MX record set.

az network private-dns record-set mx show --name
                                          --resource-group
                                          --zone-name

Examples

Get the details of an MX record set.

az network private-dns record-set mx show -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS zone.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

az network private-dns record-set mx update

Update an MX record set.

az network private-dns record-set mx update --name
                                            --resource-group
                                            --zone-name
                                            [--add]
                                            [--force-string]
                                            [--if-match]
                                            [--metadata]
                                            [--remove]
                                            [--set]

Examples

Update an MX record set.

az network private-dns record-set mx update -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet --metadata owner=WebTeam

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS zone.

--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

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

--force-string

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

--if-match

The ETag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes.

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--remove

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

--set

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