Microsoft.Network (preview:2023-07-01)

2025/07/07 • 17 updated methods

Zones_List (updated)
Description :  Lists the DNS zones in all resource groups in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_List",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Zone list operation.",
        "old": "The response to a Zone List or ListAll operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Zone items on this page",
            "old": "Information about the DNS zones."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_d5c89669ea284b18b531d393823fa57e": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/dnszones
{
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 ,
$top:
{
Description: The maximum number of DNS zones to return. If not specified, returns up to 100 zones. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Zone items on this page ,
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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
DnsResourceReference_GetByTargetResources (updated)
Description :  Returns the DNS records specified by the referencing targetResourceIds.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DnsResourceReference_GetByTargetResources",
  "$parameters": [
    {
      "#name": "parameters",
      "Description": {
        "new": "The request body",
        "old": "Properties for dns resource reference request."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dnsResourceReferences": {
              "$properties": [
                {
                  "#name": "dnsResources",
                  "Description": {
                    "new": "A list of dns Records",
                    "old": "A list of dns Records "
                  }
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Network/getDnsResourceReference
{
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 ,
parameters:
{
Description: The request body ,
Required: True ,
}
{
properties:
{
Description: The properties of the Resource Reference Request. ,
Required: False ,
}
{
targetResources:
{
Description: A list of references to azure resources for which referencing dns records need to be queried. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The result of dns resource reference request. Returns a list of dns resource references for each of the azure resource in the request. ,
Required: False ,
}
{
dnsResourceReferences:
{
Description: The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request ,
Required: False ,
}
[
{
dnsResources:
{
Description: A list of dns Records ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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_ListByResourceGroup (updated)
Description :  Lists the DNS zones within a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_ListByResourceGroup",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a Zone list operation.",
        "old": "The response to a Zone List or ListAll operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Zone items on this page",
            "old": "Information about the DNS zones."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_b28d771a07764c2da7b3b37f7cac54de": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The Zone items on this page ,
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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_Get (updated)
Description :  Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_b7ab1dc43e9e4765b4461f4e9fdeff6f": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
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 ,
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 ,
}

⚐ 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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ 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 (updated)
Description :  Creates or updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@removed_f99b5fe8eab4462eb2dd7b969c3d7918": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_0577ac36d52a401cbe9832550d33ae79": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_6f4d067599834b15988a21e5510743ec": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
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 ,
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 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 ,
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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}

⚐ 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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ 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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ 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 (updated)
Description :  Updates a DNS zone. Does not modify DNS records within the zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_Update",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_ee528bddbfbe4d688262cfc4b28c977b": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
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 ,
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 overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. ,
Required: False ,
}
string ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ 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 ,
registrationVirtualNetworks:
{
Description: A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
resolutionVirtualNetworks:
{
Description: A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
]
,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ 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 (updated)
Description :  Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Zones_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Location URI to poll for result"
        }
      },
      {
        "@added_67593ae690914ff992084bf2e6976918": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}
{
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 ,
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 ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 (updated)
Description :  Lists the record sets of a specified type in a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_ListByType",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a RecordSet list operation.",
        "old": "The response to a record set List operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RecordSet items on this page",
            "old": "Information about the record sets in the response."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_4c4bd7be4a394d59a0ddb446d943cb1c": {
                "#name": "id",
                "Description": "The ID of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_8898a85a8ff9494b9f643147d8afc61c": {
                "#name": "name",
                "Description": "The name of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_7b4cd61260694faba9015636f5faf4e7": {
                "#name": "type",
                "Description": "The type of the record set.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}
{
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 ,
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 DNS record in this record set. ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The RecordSet items on this page ,
Required: True ,
}
[
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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_Get (updated)
Description :  Gets a record set.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_ef19371cd74e4f288c18f829159c80bc": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_06415fbe0ae54b5590e06851fbe40d82": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_a707076d1c0249c380de6f19db0b0d21": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
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 ,
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 ,
}

⚐ Response (200)

{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
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 (updated)
Description :  Creates or updates a record set within a DNS zone. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created).
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@removed_89681d316b5c452ab76a71a3c57215a8": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_1743817de94f407fb3550fad757ffd43": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_8c7af6630dd44ff3b16c69425266910e": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_2353db112ec34aac980618f8c96ab4f1": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_32cb63b7ede34721b6345c57925b0ffd": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_06689795e1ad46c093eb975ba9182673": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_df64feb24da44fb28b4517bed4b027c5": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0e2112581f7d4c829f233259e5912949": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_839eea56137c4f6bb20113374dd2bd41": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
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 ,
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 ,
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 ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Describes a DNS record set (a collection of DNS records with the same name and type). ,
}
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
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 (updated)
Description :  Updates a record set within a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_Update",
  "$parameters": {
    "parameters": {
      "$properties": {
        "@removed_450510435a5748fd84f7b40e0f9d92be": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_94deaa03f9a94858b286c1bdbddd288c": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_c6d7c5519bc44c83936ad755f7edab60": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@removed_ebcd1bb9b041439a9d922ac48ff8a5ee": {
          "#name": "id",
          "Description": "The ID of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_f991db6771e74822a0bc08a9218e36f9": {
          "#name": "name",
          "Description": "The name of the record set.",
          "Required": false,
          "Type": "string"
        },
        "@removed_567303fe2cdb4fa7bb66db6be799d084": {
          "#name": "type",
          "Description": "The type of the record set.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/{recordType}/{relativeRecordSetName}
{
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 ,
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 ,
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 ,
parameters:
{
Description: Parameters supplied to the Update operation. ,
Required: True ,
}
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
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 (updated)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_ListAllByDnsZone",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a RecordSet list operation.",
        "old": "The response to a record set List operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RecordSet items on this page",
            "old": "Information about the record sets in the response."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_fdc4fae1fd6a4f2fb2d6f210ba3bd9e9": {
                "#name": "id",
                "Description": "The ID of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_578a7a47c6864eca8926dfd82a48ffb0": {
                "#name": "name",
                "Description": "The name of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_b8e5d43ec1054fd6bb20d8ea94dc956f": {
                "#name": "type",
                "Description": "The type of the record set.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/all
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The RecordSet items on this page ,
Required: True ,
}
[
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
DnssecConfigs_ListByDnsZone (updated)
Description :  Lists the DNSSEC configurations in a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DnssecConfigs_ListByDnsZone",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a DnssecConfig list operation.",
        "old": "The response to a List DNSSEC configurations operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The DnssecConfig items on this page",
            "old": "Information about the DNSSEC configurations in the response."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_50213bc4f7094431840fab0d6d9644c6": {
                "#name": "id",
                "Description": "The ID of the DNSSEC configuration.",
                "Required": false,
                "Type": "string"
              },
              "@removed_f1574e8fab1b41658640da0f920a7008": {
                "#name": "name",
                "Description": "The name of the DNSSEC configuration.",
                "Required": false,
                "Type": "string"
              },
              "@removed_bc87a0f3b052445a9c15bbeed62c4b1e": {
                "#name": "type",
                "Description": "The type of the DNSSEC configuration.",
                "Required": false,
                "Type": "string"
              },
              "@removed_6d1019a7ed0a4fd39d3add1c601312e7": {
                "#name": "systemData",
                "Description": "Metadata pertaining to creation and last modification of the resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "createdAt",
                    "Description": "The timestamp of resource creation (UTC).",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "lastModifiedAt",
                    "Description": "The timestamp of resource last modification (UTC)",
                    "Format": "date-time",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The DnssecConfig items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The DNSSEC properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State of the DNSSEC configuration. ,
Required: False ,
}
string ,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
etag:
{
Description: The etag of the DNSSEC configuration. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}
DnssecConfigs_Get (updated)
Description :  Gets the DNSSEC configuration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DnssecConfigs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_77e9f54e8ff54e27b9fc1ade6056a475": {
          "#name": "id",
          "Description": "The ID of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_af6c6f5fa7294346937ec703f9c02c9e": {
          "#name": "name",
          "Description": "The name of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_bdb14ccdcb244af38cd05064e9f9a380": {
          "#name": "type",
          "Description": "The type of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_a12ef13b50ca4c73952afbdd44baccb9": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs/default
{
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 ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The DNSSEC properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State of the DNSSEC configuration. ,
Required: False ,
}
string ,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
etag:
{
Description: The etag of the DNSSEC configuration. ,
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 ,
]
,
}
,
}
DnssecConfigs_CreateOrUpdate (updated)
Description :  Creates or updates the DNSSEC configuration on a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DnssecConfigs_CreateOrUpdate",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_792a443ae7bb47948a704343c8c8eb2b": {
          "#name": "id",
          "Description": "The ID of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_0e455f0fd32b461d8529b5478ce48743": {
          "#name": "name",
          "Description": "The name of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_175bef4ee2194b278d4b2ef0e45a7a33": {
          "#name": "type",
          "Description": "The type of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_599bee12fb714039a351a3c01c612272": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_dee7e431e912461d9661127f9d042287": {
          "#name": "id",
          "Description": "The ID of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_d28b224c9ee94844bdd54cf3d3351692": {
          "#name": "name",
          "Description": "The name of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_e9314e7d948d41b3be5eb1704d5aec21": {
          "#name": "type",
          "Description": "The type of the DNSSEC configuration.",
          "Required": false,
          "Type": "string"
        },
        "@removed_fdfdb0830704499e8b4d3a919e167c9d": {
          "#name": "systemData",
          "Description": "Metadata pertaining to creation and last modification of the resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "createdBy",
              "Description": "The identity that created the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdByType",
              "Description": "The type of identity that created the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "createdAt",
              "Description": "The timestamp of resource creation (UTC).",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedBy",
              "Description": "The identity that last modified the resource.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedByType",
              "Description": "The type of identity that last modified the resource.",
              "Enum": [
                [
                  "User",
                  ""
                ],
                [
                  "Application",
                  ""
                ],
                [
                  "ManagedIdentity",
                  ""
                ],
                [
                  "Key",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "lastModifiedAt",
              "Description": "The timestamp of resource last modification (UTC)",
              "Format": "date-time",
              "Required": false,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs/default
{
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 ,
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 DNSSEC configuration. Omit this value to always overwrite the DNSSEC configuration. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Set to '*' to allow this DNSSEC configuration to be created, but to prevent updating existing DNSSEC configuration. Other values will be ignored. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The DNSSEC properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State of the DNSSEC configuration. ,
Required: False ,
}
string ,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
etag:
{
Description: The etag of the DNSSEC configuration. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Represents the DNSSEC configuration. ,
}
{
properties:
{
Description: The DNSSEC properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State of the DNSSEC configuration. ,
Required: False ,
}
string ,
signingKeys:
{
Description: The list of signing keys. ,
Required: False ,
}
[
{
delegationSignerInfo:
{
Description: The delegation signer information. ,
Required: False ,
}
[
{
digestAlgorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digestValue:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
record:
{
Description: The record represents a delegation signer (DS) record. ,
Required: False ,
}
string ,
}
,
]
,
flags:
{
Description: The flags specifies how the key is used. ,
Format: int32 ,
Required: False ,
}
integer ,
keyTag:
{
Description: The key tag value of the DNSKEY Resource Record. ,
Format: int32 ,
Required: False ,
}
integer ,
protocol:
{
Description: The protocol value. The value is always 3. ,
Format: int32 ,
Required: False ,
}
integer ,
publicKey:
{
Description: The public key, represented as a Base64 encoding. ,
Required: False ,
}
string ,
securityAlgorithmType:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
etag:
{
Description: The etag of the DNSSEC configuration. ,
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 ,
]
,
}
,
}
DnssecConfigs_Delete (updated)
Description :  Deletes the DNSSEC configuration on a DNS zone. This operation cannot be undone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DnssecConfigs_Delete",
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "Location URI to poll for result"
        }
      },
      {
        "@added_853c643d694b4e50a2fa1318a51d81d3": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ]
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/dnssecConfigs/default
{
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 ,
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 this DNSSEC configuration. Omit this value to always delete the DNSSEC configuration. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ 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 (updated)
Description :  Lists all record sets in a DNS zone.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecordSets_ListByDnsZone",
  "$responses": {
    "200": {
      "Description": {
        "new": "The response of a RecordSet list operation.",
        "old": "The response to a record set List operation."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The RecordSet items on this page",
            "old": "Information about the record sets in the response."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "@removed_fc8c53c162a14553866726219c88f0aa": {
                "#name": "id",
                "Description": "The ID of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_cf75763acc7d4dd389a35ae58ecdcac2": {
                "#name": "name",
                "Description": "The name of the record set.",
                "Required": false,
                "Type": "string"
              },
              "@removed_32c91f754d6143d5a8ee5de68cb3ec7a": {
                "#name": "type",
                "Description": "The type of the record set.",
                "Required": false,
                "Type": "string"
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "The continuation token for the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsZones/{zoneName}/recordsets
{
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 ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The RecordSet items on this page ,
Required: True ,
}
[
{
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 ,
provisioningState:
{
Description: provisioning State of the record set. ,
Required: False ,
}
string ,
targetResource:
{
Description: A reference to an azure resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
}
,
trafficManagementProfile:
{
Description: A reference to an azure traffic manager profile resource from where the dns resource value is taken. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
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 ,
}
,
]
,
DSRecords:
{
Description: The list of DS records in the record set. ,
Required: False ,
}
[
{
keyTag:
{
Description: The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. ,
Format: int32 ,
Required: False ,
}
integer ,
algorithm:
{
Description: The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
digest:
{
Description: The digest entity. ,
Required: False ,
}
{
algorithmType:
{
Description: The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml ,
Format: int32 ,
Required: False ,
}
integer ,
value:
{
Description: The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. ,
Required: False ,
}
string ,
}
,
}
,
]
,
TLSARecords:
{
Description: The list of TLSA records in the record set. ,
Required: False ,
}
[
{
usage:
{
Description: The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. ,
Format: int32 ,
Required: False ,
}
integer ,
selector:
{
Description: The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. ,
Format: int32 ,
Required: False ,
}
integer ,
matchingType:
{
Description: The matching type specifies how the certificate association is presented. ,
Format: int32 ,
Required: False ,
}
integer ,
certAssociationData:
{
Description: This specifies the certificate association data to be matched. ,
Required: False ,
}
string ,
}
,
]
,
NAPTRRecords:
{
Description: The list of NAPTR records in the record set. ,
Required: False ,
}
[
{
order:
{
Description: The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
preference:
{
Description: The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. ,
Format: int32 ,
Required: False ,
}
integer ,
flags:
{
Description: The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. ,
Required: False ,
}
string ,
services:
{
Description: The services specific to DDDS applications. Enclose Services in quotation marks. ,
Required: False ,
}
string ,
regexp:
{
Description: The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. ,
Required: False ,
}
string ,
replacement:
{
Description: The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
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 ,
]
,
}
,
}