Microsoft.Network (stable:2017-10-01)

2025/09/05 • 13 new, 13 deleted methods

RecordSets_Update (new)
Description :  Updates a record set within a DNS zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_CreateOrUpdate (new)
Description :  Creates or updates a record set within a DNS zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: 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). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Delete (new)
Description :  Deletes a record set from a DNS zone. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: 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). ,
Required: True ,
}
string ,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Get (new)
Description :  Gets a record set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByType (new)
Description :  Lists the record sets of a specified type in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of record sets to enumerate. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByDnsZone (new)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/recordsets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListAllByDnsZone (new)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/all
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_CreateOrUpdate (new)
Description :  Creates or updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Delete (new)
Description :  Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Get (new)
Description :  Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Update (new)
Description :  Updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_ListByResourceGroup (new)
Description :  Lists the DNS zones within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_List (new)
Description :  Lists the DNS zones in all resource groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones
{
$top:
{
Description: The maximum number of DNS zones to return. If not specified, returns up to 100 zones. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Update (removed)
Description :  Updates a record set within a DNS zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_CreateOrUpdate (removed)
Description :  Creates or updates a record set within a DNS zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: 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). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Delete (removed)
Description :  Deletes a record set from a DNS zone. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: 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). ,
Required: True ,
}
string ,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_Get (removed)
Description :  Gets a record set.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
relativeRecordSetName:
{
Description: The name of the record set, relative to the name of the zone. ,
Required: True ,
}
string ,
recordType:
{
Description: The type of DNS record in this record set. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByType (removed)
Description :  Lists the record sets of a specified type in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
recordType:
{
Description: The type of record sets to enumerate. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListByDnsZone (removed)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/recordsets
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RecordSets_ListAllByDnsZone (removed)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/all
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
$recordsetnamesuffix:
{
Description: 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 . ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the record sets in the response. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the record set. ,
Required: False ,
}
string ,
name:
{
Description: The name of the record set. ,
Required: False ,
}
string ,
type:
{
Description: The type of the record set. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the record set. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the record set. ,
Required: False ,
}
{
metadata:
{
Description: The metadata attached to the record set. ,
Required: False ,
}
object ,
TTL:
{
Description: The TTL (time-to-live) of the records in the record set. ,
Format: int64 ,
Required: False ,
}
integer ,
fqdn:
{
Description: Fully qualified domain name of the record set. ,
Required: False ,
}
string ,
ARecords:
{
Description: The list of A records in the record set. ,
Required: False ,
}
[
{
ipv4Address:
{
Description: The IPv4 address of this A record. ,
Required: False ,
}
string ,
}
,
]
,
AAAARecords:
{
Description: The list of AAAA records in the record set. ,
Required: False ,
}
[
{
ipv6Address:
{
Description: The IPv6 address of this AAAA record. ,
Required: False ,
}
string ,
}
,
]
,
MXRecords:
{
Description: The list of MX records in the record set. ,
Required: False ,
}
[
{
preference:
{
Description: The preference value for this MX record. ,
Format: int32 ,
Required: False ,
}
integer ,
exchange:
{
Description: The domain name of the mail host for this MX record. ,
Required: False ,
}
string ,
}
,
]
,
NSRecords:
{
Description: The list of NS records in the record set. ,
Required: False ,
}
[
{
nsdname:
{
Description: The name server name for this NS record. ,
Required: False ,
}
string ,
}
,
]
,
PTRRecords:
{
Description: The list of PTR records in the record set. ,
Required: False ,
}
[
{
ptrdname:
{
Description: The PTR target domain name for this PTR record. ,
Required: False ,
}
string ,
}
,
]
,
SRVRecords:
{
Description: The list of SRV records in the record set. ,
Required: False ,
}
[
{
priority:
{
Description: The priority value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
weight:
{
Description: The weight value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: The port value for this SRV record. ,
Format: int32 ,
Required: False ,
}
integer ,
target:
{
Description: The target domain name for this SRV record. ,
Required: False ,
}
string ,
}
,
]
,
TXTRecords:
{
Description: The list of TXT records in the record set. ,
Required: False ,
}
[
{
value:
{
Description: The text value of this TXT record. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
CNAMERecord:
{
Description: The CNAME record in the record set. ,
Required: False ,
}
{
cname:
{
Description: The canonical name for this CNAME record. ,
Required: False ,
}
string ,
}
,
SOARecord:
{
Description: The SOA record in the record set. ,
Required: False ,
}
{
host:
{
Description: The domain name of the authoritative name server for this SOA record. ,
Required: False ,
}
string ,
email:
{
Description: The email contact for this SOA record. ,
Required: False ,
}
string ,
serialNumber:
{
Description: The serial number for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
refreshTime:
{
Description: The refresh value for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
retryTime:
{
Description: The retry time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
expireTime:
{
Description: The expire time for this SOA record. ,
Format: int64 ,
Required: False ,
}
integer ,
minimumTTL:
{
Description: The minimum value for this SOA record. By convention this is used to determine the negative caching duration. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
caaRecords:
{
Description: The list of CAA records in the record set. ,
Required: False ,
}
[
{
flags:
{
Description: The flags for this CAA record as an integer between 0 and 255. ,
Format: int32 ,
Required: False ,
}
integer ,
tag:
{
Description: The tag for this CAA record. ,
Required: False ,
}
string ,
value:
{
Description: The value for this CAA record. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_CreateOrUpdate (removed)
Description :  Creates or updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow a new DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Delete (removed)
Description :  Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Get (removed)
Description :  Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_Update (removed)
Description :  Updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
zoneName:
{
Description: The name of the DNS zone (without a terminating dot). ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
If-Match:
{
Description: 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. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_ListByResourceGroup (removed)
Description :  Lists the DNS zones within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
$top:
{
Description: The maximum number of record sets to return. If not specified, returns up to 100 record sets. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Zones_List (removed)
Description :  Lists the DNS zones in all resource groups in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones
{
$top:
{
Description: The maximum number of DNS zones to return. If not specified, returns up to 100 zones. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Information about the DNS zones. ,
Required: False ,
}
[
{
etag:
{
Description: The etag of the zone. ,
Required: False ,
}
string ,
properties:
{
Description: The properties of the zone. ,
Required: False ,
}
{
maxNumberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
maxNumberOfRecordsPerRecordSet:
{
Description: The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Format: int64 ,
Required: False ,
}
integer ,
numberOfRecordSets:
{
Description: 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. ,
Format: int64 ,
Required: False ,
}
integer ,
nameServers:
{
Description: The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored. ,
Required: False ,
}
[
string ,
]
,
zoneType:
{
Description: The type of this DNS zone (Public or Private). ,
Enum:
{
Public: No description available. ,
Private: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The continuation token for the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}