{"files":{"SKILL.md":"---\nname: privatednsmanagementclient\ndescription: \"PrivateDnsManagementClient API skill. Use when working with PrivateDnsManagementClient for subscriptions. Covers 17 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# PrivateDnsManagementClient\nAPI version: 2018-09-01\n\n## Auth\nOAuth2\n\n## Base URL\nhttps://management.azure.com\n\n## Setup\n1. Configure auth: OAuth2\n2. GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName} -- gets a private dns zone. retrieves the zone properties, but not the virtual networks links or the record sets within the zone.\n3. Explore available endpoints below\n\n## Endpoints\n17 endpoints across 1 group. See references/api-spec.lap for full details.\n\n### Subscriptions\n| Method | Path | Description |\n|--------|------|-------------|\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName} | Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName} | Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName} | Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName} | Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone. |\n| GET | /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones | Lists the Private DNS zones in all resource groups in a subscription. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones | Lists the Private DNS zones within a resource group. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName} | Creates or updates a virtual network link to the specified Private DNS zone. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName} | Updates a virtual network link to the specified Private DNS zone. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName} | Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName} | Gets a virtual network link to the specified Private DNS zone. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks | Lists the virtual network links to the specified Private DNS zone. |\n| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName} | Creates or updates a record set within a Private DNS zone. |\n| PATCH | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName} | Updates a record set within a Private DNS zone. |\n| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName} | Deletes a record set from a Private DNS zone. This operation cannot be undone. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName} | Gets a record set. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType} | Lists the record sets of a specified type in a Private DNS zone. |\n| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL | Lists all record sets in a Private DNS zone. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"Update a privateDnsZone?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n- \"Partially update a privateDnsZone?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n- \"Delete a privateDnsZone?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n- \"Get privateDnsZone details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n- \"List all privateDnsZones?\" -> GET /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones\n- \"Update a virtualNetworkLink?\" -> PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n- \"Partially update a virtualNetworkLink?\" -> PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n- \"Delete a virtualNetworkLink?\" -> DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n- \"Get virtualNetworkLink details?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n- \"List all virtualNetworkLinks?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks\n- \"List all ALL?\" -> GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Create/update endpoints return the modified resource on success\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api PrivateDnsManagementClient\n@base https://management.azure.com\n@version 2018-09-01\n@auth OAuth2\n@common_fields {api-version: any # Client Api Version., subscriptionId: any # Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.}\n@endpoints 17\n@toc subscriptions(17)\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n@desc Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., parameters: any # Parameters supplied to the CreateOrUpdate operation.}\n@optional {If-Match: any # The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes., If-None-Match: any # Set to '*' to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.}\n@returns(200) The Private DNS zone has been updated.\n@returns(201) The Private DNS zone has been created.\n@returns(202) The Private DNS zone upsert operation has been accepted and will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n@desc Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., parameters: any # Parameters supplied to the Update operation.}\n@optional {If-Match: any # The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.}\n@returns(200) The Private DNS zone has been updated.\n@returns(202) The Private DNS zone update operation has been accepted and will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n@desc Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot).}\n@optional {If-Match: any # The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.}\n@returns(200) The Private DNS zone has been deleted.\n@returns(202) The Private DNS zone delete operation has been accepted and will complete asynchronously.\n@returns(204) The Private DNS zone was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}\n@desc Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot).}\n@returns(200) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Network/privateDnsZones\n@desc Lists the Private DNS zones in all resource groups in a subscription.\n@optional {$top: any # The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones.}\n@returns(200) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones\n@desc Lists the Private DNS zones within a resource group.\n@required {resourceGroupName: any # The name of the resource group.}\n@optional {$top: any # The maximum number of record sets to return. If not specified, returns up to 100 record sets.}\n@returns(200) Success.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n@desc Creates or updates a virtual network link to the specified Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., virtualNetworkLinkName: any # The name of the virtual network link., parameters: any # Parameters supplied to the CreateOrUpdate operation.}\n@optional {If-Match: any # The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes., If-None-Match: any # Set to '*' to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored.}\n@returns(200) The virtual network link to the Private DNS zone has been updated.\n@returns(201) The virtual network link to the Private DNS zone has been created.\n@returns(202) The operation to upsert virtual network link to the Private DNS zone has been accepted and will complete asynchronously.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n@desc Updates a virtual network link to the specified Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., virtualNetworkLinkName: any # The name of the virtual network link., parameters: any # Parameters supplied to the Update operation.}\n@optional {If-Match: any # The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.}\n@returns(200) The virtual network link to the Private DNS zone has been updated.\n@returns(202) The operation to link virtual network link to Private DNS zone has been accepted and will complete asynchronously.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n@desc Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., virtualNetworkLinkName: any # The name of the virtual network link.}\n@optional {If-Match: any # The ETag of the virtual network link to the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.}\n@returns(200) The virtual network link to the Private DNS zone has been deleted.\n@returns(202) The operation to delete virtual network link to the Private DNS zone has been accepted and will complete asynchronously.\n@returns(204) The virtual network link to the Private DNS zone was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName}\n@desc Gets a virtual network link to the specified Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., virtualNetworkLinkName: any # The name of the virtual network link.}\n@returns(200) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks\n@desc Lists the virtual network links to the specified Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot).}\n@optional {$top: any # The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.}\n@returns(200) Success.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}\n@desc Creates or updates a record set within a Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., recordType: any # The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the Private DNS zone is created)., relativeRecordSetName: any # The name of the record set, relative to the name of the zone., parameters: any # Parameters supplied to the CreateOrUpdate operation.}\n@optional {If-Match: any # 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., If-None-Match: any # Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.}\n@returns(200) The record set has been updated.\n@returns(201) The record set has been created.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}\n@desc Updates a record set within a Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., recordType: any # The type of DNS record in this record set., relativeRecordSetName: any # The name of the record set, relative to the name of the zone., parameters: any # Parameters supplied to the Update operation.}\n@optional {If-Match: any # 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.}\n@returns(200) The record set has been updated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}\n@desc Deletes a record set from a Private DNS zone. This operation cannot be undone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., recordType: any # The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the Private DNS zone is deleted)., relativeRecordSetName: any # The name of the record set, relative to the name of the zone.}\n@optional {If-Match: any # The ETag of the record set. Omit this value to always delete the current record set. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.}\n@returns(200) The record set has been deleted.\n@returns(204) The record set was not found.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}/{relativeRecordSetName}\n@desc Gets a record set.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., recordType: any # The type of DNS record in this record set., relativeRecordSetName: any # The name of the record set, relative to the name of the zone.}\n@returns(200) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/{recordType}\n@desc Lists the record sets of a specified type in a Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot)., recordType: any # The type of record sets to enumerate.}\n@optional {$top: any # The maximum number of record sets to return. If not specified, returns up to 100 record sets., $recordsetnamesuffix: any # The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\".}\n@returns(200) Success.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/ALL\n@desc Lists all record sets in a Private DNS zone.\n@required {resourceGroupName: any # The name of the resource group., privateZoneName: any # The name of the Private DNS zone (without a terminating dot).}\n@optional {$top: any # The maximum number of record sets to return. If not specified, returns up to 100 record sets., $recordsetnamesuffix: any # The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with \".\".}\n@returns(200) Success.\n\n@end\n"}}