The DNS Management Client.
Lists all record sets in a DNS zone.
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. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSetListResult
|
The response to a record set List operation. |
value
|
array [RecordSet] |
Information about the record sets in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Lists all record sets in a DNS zone.
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. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSetListResult
|
The response to a record set List operation. |
value
|
array [RecordSet] |
Information about the record sets in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Deletes a record set from a DNS zone. This operation cannot be undone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Gets a record set.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Updates a record set within a DNS zone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Creates or updates a record set within a DNS zone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Name | Data Type | Description |
---|---|---|
RecordSet
|
Describes a DNS record set (a collection of DNS records with the same name and type). |
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
Lists the record sets of a specified type in a DNS zone.
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. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
RecordSetListResult
|
The response to a record set List operation. |
value
|
array [RecordSet] |
Information about the record sets in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Lists the DNS zones in all resource groups in a subscription.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ZoneListResult
|
The response to a Zone List or ListAll operation. |
value
|
array [Zone] |
Information about the DNS zones. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
Common properties of an Azure Resource Manager resource Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Zone
|
Describes a DNS zone. |
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
Updates a DNS zone. Does not modify DNS records within the zone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
ZoneUpdate
|
Describes a request to update a DNS zone. |
tags
|
object |
Resource tags. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Zone
|
Describes a DNS zone. |
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
Creates or updates a DNS zone. Does not modify DNS records within the zone.
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. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
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. |
Name | Data Type | Description |
---|---|---|
Zone
|
Describes a DNS zone. |
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Zone
|
Describes a DNS zone. |
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
Name | Data Type | Description |
---|---|---|
Zone
|
Describes a DNS zone. |
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
Lists the DNS zones within a resource group.
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. |
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. |
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ZoneListResult
|
The response to a Zone List or ListAll operation. |
value
|
array [Zone] |
Information about the DNS zones. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
Common properties of an Azure Resource Manager resource Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Returns the DNS records specified by the referencing targetResourceIds.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Specifies the Azure subscription ID, which uniquely identifies the Microsoft Azure subscription. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Specifies the API version. |
Name | Data Type | Description |
---|---|---|
DnsResourceReferenceRequest
|
Represents the properties of the Dns Resource Reference Request. |
properties
|
DnsResourceReferenceRequestProperties |
The properties of the Resource Reference Request. |
|||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
CloudError
|
object |
An error message |
error
|
CloudErrorBody |
The error message body |
|||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
DnsResourceReferenceResult
|
Represents the properties of the Dns Resource Reference Result. |
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. |
||||||||||||||||||||
Properties
|
An A record.
Name | Data Type | Description |
---|---|---|
ipv4Address
|
string |
The IPv4 address of this A record. |
An AAAA record.
Name | Data Type | Description |
---|---|---|
ipv6Address
|
string |
The IPv6 address of this AAAA record. |
A CAA record.
Name | Data Type | Description |
---|---|---|
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. |
An error message
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
error
|
CloudErrorBody |
The error message body |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
The body of an error message
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 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
code
|
string |
The error code |
A CNAME record.
Name | Data Type | Description |
---|---|---|
cname
|
string |
The canonical name for this CNAME record. |
Represents a single Azure resource and its referencing DNS records.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
targetResource
|
SubResource |
A reference to an azure resource from where the dns resource value is taken. |
|||||||
Properties
|
|||||||||
dnsResources
|
array [SubResource] |
A list of dns Records |
|||||||
Properties
|
Represents the properties of the Dns Resource Reference Request.
Name | Data Type | Description | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
properties
|
DnsResourceReferenceRequestProperties |
The properties of the Resource Reference Request. |
|||||||||||||||||
Properties
|
Represents the properties of the Dns Resource Reference Request.
Name | Data Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|
targetResources
|
array [SubResource] |
A list of references to azure resources for which referencing dns records need to be queried. |
|||||||
Properties
|
Represents the properties of the Dns Resource Reference Result.
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. |
||||||||||||||||||||||||||||||||||||||||
Properties
|
The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request.
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 |
||||||||||||||||||||||||||||||
Properties
|
An MX record.
Name | Data Type | Description |
---|---|---|
preference
|
integer |
The preference value for this MX record. |
exchange
|
string |
The domain name of the mail host for this MX record. |
An NS record.
Name | Data Type | Description |
---|---|---|
nsdname
|
string |
The name server name for this NS record. |
A PTR record.
Name | Data Type | Description |
---|---|---|
ptrdname
|
string |
The PTR target domain name for this PTR record. |
Describes a DNS record set (a collection of DNS records with the same name and type).
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
type
|
string Read-only |
The type of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
properties
|
RecordSetProperties |
The properties of the record set. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
The response to a record set List operation.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [RecordSet] |
Information about the record sets in the response. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Represents the properties of the records in the record set.
Name | Data Type | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
targetResource
|
SubResource |
A reference to an azure resource from where the dns resource value is taken. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
TXTRecords
|
array [TxtRecord] |
The list of TXT records in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
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. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
SOARecord
|
SoaRecord |
The SOA record in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
PTRRecords
|
array [PtrRecord] |
The list of PTR records in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
NSRecords
|
array [NsRecord] |
The list of NS records in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
MXRecords
|
array [MxRecord] |
The list of MX records in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
CNAMERecord
|
CnameRecord |
The CNAME record in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
ARecords
|
array [ARecord] |
The list of A records in the record set. |
|||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||
AAAARecords
|
array [AaaaRecord] |
The list of AAAA records in the record set. |
|||||||||||||||||||||||||
Properties
|
Parameters supplied to update a record set.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RecordSet
|
RecordSet |
Specifies information about the record set being updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Common properties of an Azure Resource Manager resource
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. |
An SOA record.
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. |
An SRV record.
Name | Data Type | Description |
---|---|---|
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. |
A reference to a another resource
Name | Data Type | Description |
---|---|---|
id
|
string |
Resource Id. |
A TXT record.
Name | Data Type | Description |
---|---|---|
value
|
array [string] |
The text value of this TXT record. |
Describes a DNS zone.
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. |
||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||
etag
|
string |
The etag of the zone. |
Common properties of an Azure Resource Manager resource
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. |
The response to a Zone List or ListAll operation.
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
value
|
array [Zone] |
Information about the DNS zones. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
Resource
Common properties of an Azure Resource Manager resource Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
The continuation token for the next page of results. |
Represents the properties of the zone.
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. |
|||||||
Properties
|
|||||||||
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. |
|||||||
Properties
|
|||||||||
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. |
Describes a request to update a DNS zone.
Name | Data Type | Description |
---|---|---|
tags
|
object |
Resource tags. |
'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1
Azure Active Directory OAuth2 Flow
Flow:implicit
https://login.microsoftonline.com/common/oauth2/authorize
user_impersonation
: impersonate your user accountOrigin - 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 |