Microsoft Azure - API DnsManagementClient

Microsoft Azure / DnsManagementClient

DnsManagementClient

The DNS Management Client.

Resources

RecordSets

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/all

Lists all record sets in a DNS zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.
`$recordsetnamesuffix`	string	The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .
`$top`	integer	The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`RecordSetListResult`		The response to a record set List operation.

Properties


                        value

array [RecordSet]

Information about the record sets in the response.


                        RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties

`targetResource`	SubResource	A reference to an azure resource from where the dns resource value is taken.
`provisioningState`	string Read-only	provisioning State of the record set.
`metadata`	object	The metadata attached to the record set.
`fqdn`	string Read-only	Fully qualified domain name of the record set.
`caaRecords`	array [CaaRecord]	The list of CAA records in the record set.
`TXTRecords`	array [TxtRecord]	The list of TXT records in the record set.
`TTL`	long	The TTL (time-to-live) of the records in the record set.
`SRVRecords`	array [SrvRecord]	The list of SRV records in the record set.
`SOARecord`	SoaRecord	The SOA record in the record set.
`PTRRecords`	array [PtrRecord]	The list of PTR records in the record set.
`NSRecords`	array [NsRecord]	The list of NS records in the record set.
`MXRecords`	array [MxRecord]	The list of MX records in the record set.
`CNAMERecord`	CnameRecord	The CNAME record in the record set.
`ARecords`	array [ARecord]	The list of A records in the record set.
`AAAARecords`	array [AaaaRecord]	The list of AAAA records in the record set.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.


                        nextLink

string
Read-only

The continuation token for the next page of results.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/recordsets

Lists all record sets in a DNS zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.
`$recordsetnamesuffix`	string	The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .
`$top`	integer	The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`RecordSetListResult`		The response to a record set List operation.

Properties


                        value

array [RecordSet]

Information about the record sets in the response.


                        RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties

`targetResource`	SubResource	A reference to an azure resource from where the dns resource value is taken.
`provisioningState`	string Read-only	provisioning State of the record set.
`metadata`	object	The metadata attached to the record set.
`fqdn`	string Read-only	Fully qualified domain name of the record set.
`caaRecords`	array [CaaRecord]	The list of CAA records in the record set.
`TXTRecords`	array [TxtRecord]	The list of TXT records in the record set.
`TTL`	long	The TTL (time-to-live) of the records in the record set.
`SRVRecords`	array [SrvRecord]	The list of SRV records in the record set.
`SOARecord`	SoaRecord	The SOA record in the record set.
`PTRRecords`	array [PtrRecord]	The list of PTR records in the record set.
`NSRecords`	array [NsRecord]	The list of NS records in the record set.
`MXRecords`	array [MxRecord]	The list of MX records in the record set.
`CNAMERecord`	CnameRecord	The CNAME record in the record set.
`ARecords`	array [ARecord]	The list of A records in the record set.
`AAAARecords`	array [AaaaRecord]	The list of AAAA records in the record set.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.


                        nextLink

string
Read-only

The continuation token for the next page of results.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}

Deletes a record set from a DNS zone. This operation cannot be undone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`recordType`	string Allowed values: - `A` - `AAAA` - `CAA` - `CNAME` - `MX` - `NS` - `PTR` - `SOA` - `SRV` - `TXT`	The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the DNS zone is deleted).
`relativeRecordSetName`	string	The name of the record set, relative to the name of the zone.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-Match`	string	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.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The record set has been deleted.

204The record set was not found.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}

Gets a record set.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`recordType`	string Allowed values: - `A` - `AAAA` - `CAA` - `CNAME` - `MX` - `NS` - `PTR` - `SOA` - `SRV` - `TXT`	The type of DNS record in this record set.
`relativeRecordSetName`	string	The name of the record set, relative to the name of the zone.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}

Updates a record set within a DNS zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`recordType`	string Allowed values: - `A` - `AAAA` - `CAA` - `CNAME` - `MX` - `NS` - `PTR` - `SOA` - `SRV` - `TXT`	The type of DNS record in this record set.
`relativeRecordSetName`	string	The name of the record set, relative to the name of the zone.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-Match`	string	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 overwriting concurrent changes.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The record set has been updated.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}

Creates or updates a record set within a DNS zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`recordType`	string Allowed values: - `A` - `AAAA` - `CAA` - `CNAME` - `MX` - `NS` - `PTR` - `SOA` - `SRV` - `TXT`	The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created).
`relativeRecordSetName`	string	The name of the record set, relative to the name of the zone.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-None-Match`	string	Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.
`If-Match`	string	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 overwriting any concurrent changes.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The record set has been updated.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

201The record set has been created.

Body

Name	Data Type	Description
`RecordSet`		Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}

Lists the record sets of a specified type in a DNS zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`recordType`	string Allowed values: - `A` - `AAAA` - `CAA` - `CNAME` - `MX` - `NS` - `PTR` - `SOA` - `SRV` - `TXT`	The type of record sets to enumerate.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.
`$recordsetnamesuffix`	string	The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .
`$top`	integer	The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`RecordSetListResult`		The response to a record set List operation.

Properties


                        value

array [RecordSet]

Information about the record sets in the response.


                        RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties

`targetResource`	SubResource	A reference to an azure resource from where the dns resource value is taken.
`provisioningState`	string Read-only	provisioning State of the record set.
`metadata`	object	The metadata attached to the record set.
`fqdn`	string Read-only	Fully qualified domain name of the record set.
`caaRecords`	array [CaaRecord]	The list of CAA records in the record set.
`TXTRecords`	array [TxtRecord]	The list of TXT records in the record set.
`TTL`	long	The TTL (time-to-live) of the records in the record set.
`SRVRecords`	array [SrvRecord]	The list of SRV records in the record set.
`SOARecord`	SoaRecord	The SOA record in the record set.
`PTRRecords`	array [PtrRecord]	The list of PTR records in the record set.
`NSRecords`	array [NsRecord]	The list of NS records in the record set.
`MXRecords`	array [MxRecord]	The list of MX records in the record set.
`CNAMERecord`	CnameRecord	The CNAME record in the record set.
`ARecords`	array [ARecord]	The list of A records in the record set.
`AAAARecords`	array [AaaaRecord]	The list of AAAA records in the record set.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.


                        nextLink

string
Read-only

The continuation token for the next page of results.

Zones

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones

Lists the DNS zones in all resource groups in a subscription.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.
`$top`	integer	The maximum number of DNS zones to return. If not specified, returns up to 100 zones.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`ZoneListResult`		The response to a Zone List or ListAll operation.

Properties


                        value

array [Zone]

Information about the DNS zones.


                        Zone

Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties

`zoneType`	string Default value: `Public` Allowed values: - `Public` - `Private`	The type of this DNS zone (Public or Private).
`resolutionVirtualNetworks`	array [SubResource]	A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
`registrationVirtualNetworks`	array [SubResource]	A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
`numberOfRecordSets`	long Read-only	The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
`nameServers`	array [string]	The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
`maxNumberOfRecordSets`	long Read-only	The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.


                        nextLink

string
Read-only

The continuation token for the next page of results.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-Match`	string	The etag of the DNS zone. Omit this value to always delete the current zone. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The DNS zone has been deleted.

202The DNS zone delete operation has been accepted and will complete asynchronously.

204The DNS zone was not found.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`Zone`		Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}

Updates a DNS zone. Does not modify DNS records within the zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-Match`	string	The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.

Body

Name	Data Type	Description
`ZoneUpdate`		Describes a request to update a DNS zone.

Properties


                        tags

object

Resource tags.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The DNS zone has been updated.

Body

Name	Data Type	Description
`Zone`		Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}

Creates or updates a DNS zone. Does not modify DNS records within the zone.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`zoneName`	string	The name of the DNS zone (without a terminating dot).
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Header

Name	Data Type	Description
`If-None-Match`	string	Set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.
`If-Match`	string	The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.

Body

Name	Data Type	Description
`Zone`		Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200The DNS zone has been updated.

Body

Name	Data Type	Description
`Zone`		Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

201The DNS zone has been created.

Body

Name	Data Type	Description
`Zone`		Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones

Lists the DNS zones within a resource group.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.
`resourceGroupName`	string	The name of the resource group.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.
`$top`	integer	The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`ZoneListResult`		The response to a Zone List or ListAll operation.

Properties


                        value

array [Zone]

Information about the DNS zones.


                        Zone

Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties

`zoneType`	string Default value: `Public` Allowed values: - `Public` - `Private`	The type of this DNS zone (Public or Private).
`resolutionVirtualNetworks`	array [SubResource]	A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.
`registrationVirtualNetworks`	array [SubResource]	A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
`numberOfRecordSets`	long Read-only	The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
`nameServers`	array [string]	The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
`maxNumberOfRecordSets`	long Read-only	The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.


                        nextLink

string
Read-only

The continuation token for the next page of results.

default

POST

/subscriptions/{subscriptionId}/providers/Microsoft.Network/getDnsResourceReference

Returns the DNS records specified by the referencing targetResourceIds.

Request

Path

Name	Data Type	Description
`subscriptionId`	string	Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription.

Query

Name	Data Type	Description
`api-version`	string	Specifies the API version.

Body

Name	Data Type	Description
`DnsResourceReferenceRequest`		Represents the properties of the Dns Resource Reference Request.

Properties


                        properties

DnsResourceReferenceRequestProperties

The properties of the Resource Reference Request.


                        DnsResourceReferenceRequestProperties

Represents the properties of the Dns Resource Reference Request.

Properties


                        targetResources

array [SubResource]

A list of references to azure resources for which referencing dns records need to be queried.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.

Responses

200Default response. It will be deserialized as per the Error definition.

Body

Name	Data Type	Description
`CloudError`	object	An error message

Properties


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code

200Success.

Body

Name	Data Type	Description
`DnsResourceReferenceResult`		Represents the properties of the Dns Resource Reference Result.

Properties


                        properties

DnsResourceReferenceResultProperties

The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.


                        DnsResourceReferenceResultProperties

The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.

Properties


                        dnsResourceReferences

array [DnsResourceReference]

The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request


                        DnsResourceReference

Represents a single Azure resource and its referencing DNS records.

Properties

`targetResource`	SubResource	A reference to an azure resource from where the dns resource value is taken.
`dnsResources`	array [SubResource]	A list of dns Records

Models

ARecord

AaaaRecord

CaaRecord

CloudError

An error message

Properties

Name Data Type Description


                        error

CloudErrorBody

The error message body


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code


                        code

string

The error code

CloudErrorBody

The body of an error message

Properties

Name Data Type Description


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties


                        target

string

The target resource of the error message


                        message

string

A description of what caused the error


                        details

array [CloudErrorBody]

Extra error information


                        CloudErrorBody

object

The body of an error message

Properties

`target`	string	The target resource of the error message
`message`	string	A description of what caused the error
`details`	array [CloudErrorBody]	Extra error information
`code`	string	The error code


                        code

string

The error code


                        code

string

The error code


                        code

string

The error code

CnameRecord

DnsResourceReference

Represents a single Azure resource and its referencing DNS records.

Properties

Name Data Type Description


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        dnsResources

array [SubResource]

A list of dns Records


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.

DnsResourceReferenceRequest

Represents the properties of the Dns Resource Reference Request.

Properties

Name Data Type Description


                        properties

DnsResourceReferenceRequestProperties

The properties of the Resource Reference Request.


                        DnsResourceReferenceRequestProperties

Represents the properties of the Dns Resource Reference Request.

Properties


                        targetResources

array [SubResource]

A list of references to azure resources for which referencing dns records need to be queried.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.

DnsResourceReferenceRequestProperties

DnsResourceReferenceResult

Represents the properties of the Dns Resource Reference Result.

Properties

Name Data Type Description


                        properties

DnsResourceReferenceResultProperties

The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.


                        DnsResourceReferenceResultProperties

The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.

Properties


                        dnsResourceReferences

array [DnsResourceReference]

The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request


                        DnsResourceReference

Represents a single Azure resource and its referencing DNS records.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        dnsResources

array [SubResource]

A list of dns Records


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.

DnsResourceReferenceResultProperties

The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.

Properties

Name Data Type Description


                        dnsResourceReferences

array [DnsResourceReference]

The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request


                        DnsResourceReference

Represents a single Azure resource and its referencing DNS records.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        dnsResources

array [SubResource]

A list of dns Records


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.

MxRecord

NsRecord

PtrRecord

RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties

Name Data Type Description


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

RecordSetListResult

The response to a record set List operation.

Properties

Name Data Type Description


                        value

array [RecordSet]

Information about the record sets in the response.


                        RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.


                        nextLink

string
Read-only

The continuation token for the next page of results.

RecordSetProperties

Represents the properties of the records in the record set.

Properties

Name Data Type Description


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.

RecordSetUpdateParameters

Parameters supplied to update a record set.

Properties

Name Data Type Description


                        RecordSet

RecordSet

Specifies information about the record set being updated.


                        RecordSet

Describes a DNS record set (a collection of DNS records with the same name and type).

Properties


                        type

string
Read-only

The type of the record set.


                        properties

RecordSetProperties

The properties of the record set.


                        RecordSetProperties

Represents the properties of the records in the record set.

Properties


                        targetResource

SubResource

A reference to an azure resource from where the dns resource value is taken.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        provisioningState

string
Read-only

provisioning State of the record set.


                        metadata

object

The metadata attached to the record set.


                        fqdn

string
Read-only

Fully qualified domain name of the record set.


                        caaRecords

array [CaaRecord]

The list of CAA records in the record set.


                        CaaRecord

A CAA record.

Properties

`value`	string	The value for this CAA record.
`tag`	string	The tag for this CAA record.
`flags`	integer	The flags for this CAA record as an integer between 0 and 255.


                        TXTRecords

array [TxtRecord]

The list of TXT records in the record set.


                        TxtRecord

A TXT record.

Properties


                        value

array [string]

The text value of this TXT record.

TTL

long

The TTL (time-to-live) of the records in the record set.


                        SRVRecords

array [SrvRecord]

The list of SRV records in the record set.


                        SrvRecord

An SRV record.

Properties

`weight`	integer	The weight value for this SRV record.
`target`	string	The target domain name for this SRV record.
`priority`	integer	The priority value for this SRV record.
`port`	integer	The port value for this SRV record.


                        SOARecord

SoaRecord

The SOA record in the record set.


                        SoaRecord

An SOA record.

Properties

`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.


                        PTRRecords

array [PtrRecord]

The list of PTR records in the record set.


                        PtrRecord

A PTR record.

Properties


                        ptrdname

string

The PTR target domain name for this PTR record.


                        NSRecords

array [NsRecord]

The list of NS records in the record set.


                        NsRecord

An NS record.

Properties


                        nsdname

string

The name server name for this NS record.


                        MXRecords

array [MxRecord]

The list of MX records in the record set.


                        MxRecord

An MX record.

Properties

`preference`	integer	The preference value for this MX record.
`exchange`	string	The domain name of the mail host for this MX record.


                        CNAMERecord

CnameRecord

The CNAME record in the record set.


                        CnameRecord

A CNAME record.

Properties


                        cname

string

The canonical name for this CNAME record.


                        ARecords

array [ARecord]

The list of A records in the record set.


                        ARecord

An A record.

Properties


                        ipv4Address

string

The IPv4 address of this A record.


                        AAAARecords

array [AaaaRecord]

The list of AAAA records in the record set.


                        AaaaRecord

An AAAA record.

Properties


                        ipv6Address

string

The IPv6 address of this AAAA record.


                        name

string
Read-only

The name of the record set.

id

string
Read-only

The ID of the record set.


                        etag

string

The etag of the record set.

Resource

SoaRecord

An SOA record.

Properties

Name	Data Type	Description
`serialNumber`	long	The serial number for this SOA record.
`retryTime`	long	The retry time for this SOA record.
`refreshTime`	long	The refresh value for this SOA record.
`minimumTTL`	long	The minimum value for this SOA record. By convention this is used to determine the negative caching duration.
`host`	string	The domain name of the authoritative name server for this SOA record.
`expireTime`	long	The expire time for this SOA record.
`email`	string	The email contact for this SOA record.

SrvRecord

SubResource

TxtRecord

Zone

Describes a DNS zone.

Properties

Name Data Type Description


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.

ZoneListResult

The response to a Zone List or ListAll operation.

Properties

Name Data Type Description


                        value

array [Zone]

Information about the DNS zones.


                        Zone

Describes a DNS zone.

Properties


                        type

string
Read-only

Resource type.


                        tags

object

Resource tags.


                        name

string
Read-only

Resource name.


                        location

string

Resource location.

id

string
Read-only

Resource ID.


                        properties

ZoneProperties

The properties of the zone.


                        ZoneProperties

Represents the properties of the zone.

Properties


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        etag

string

The etag of the zone.

Extends

Resource

Common properties of an Azure Resource Manager resource

Properties

Name	Data Type	Description
`type`	string Read-only	Resource type.
`tags`	object	Resource tags.
`name`	string Read-only	Resource name.
`location`	string	Resource location.
`id`	string Read-only	Resource ID.


                        nextLink

string
Read-only

The continuation token for the next page of results.

ZoneProperties

Represents the properties of the zone.

Properties

Name Data Type Description


                        zoneType

string
Default value: Public
Allowed values:
- Public
- Private

The type of this DNS zone (Public or Private).


                        resolutionVirtualNetworks

array [SubResource]

A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        registrationVirtualNetworks

array [SubResource]

A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.


                        SubResource

A reference to a another resource

Properties

id

string

Resource Id.


                        numberOfRecordSets

long
Read-only

The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        nameServers

array [string]

The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.


                        maxNumberOfRecordSets

long
Read-only

The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.

ZoneUpdate

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Azure Active Directory OAuth2 Flow

Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Scopes:

user_impersonation: impersonate your user account

Metadata (Technical Details)

Origin - Format	`swagger`
Origin - Url	`https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json`
Origin - Version	`2.0`
Preferred	`Yes`
Provider Name	`azure.com`
Service Name	`dns`
API Version	`2018-05-01`

Comments

Loading comments ...