swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector VirtualNetworkLinks API schemes: - https tags: - name: VirtualNetworkLinks paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks/{virtualNetworkLinkName} : put: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksCreateorupdate description: Creates or updates a virtual network link to a DNS forwarding ruleset. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DnsForwardingRulesetNameParameter' - $ref: '#/parameters/VirtualNetworkLinkNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/VirtualNetworkLink' description: Parameters supplied to the CreateOrUpdate operation. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/IfMatchParameter' - $ref: '#/parameters/IfNoneMatchParameter' responses: '200': description: The virtual network link to the DNS forwarding ruleset has been updated. schema: $ref: '#/definitions/VirtualNetworkLink' '201': description: The virtual network link to the DNS forwarding ruleset has been created. schema: $ref: '#/definitions/VirtualNetworkLink' '202': description: The operation to upsert virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Upsert virtual network link to a DNS forwarding ruleset: $ref: ./examples/VirtualNetworkLink_Put.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Virtualnetworklinks Virtualnetworklinkname patch: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksUpdate description: Updates a virtual network link to a DNS forwarding ruleset. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DnsForwardingRulesetNameParameter' - $ref: '#/parameters/VirtualNetworkLinkNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/VirtualNetworkLinkPatch' description: Parameters supplied to the Update operation. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/IfMatchParameter' responses: '200': description: The virtual network link to the DNS forwarding ruleset has been updated. schema: $ref: '#/definitions/VirtualNetworkLink' '202': description: The operation to update virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Update virtual network link to a DNS forwarding ruleset: $ref: ./examples/VirtualNetworkLink_Patch.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Virtualnetworklinks Virtualnetworklinkname delete: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksDelete description: 'Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.' parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DnsForwardingRulesetNameParameter' - $ref: '#/parameters/VirtualNetworkLinkNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/IfMatchParameter' responses: '200': description: The virtual network link to the DNS forwarding ruleset has been deleted. '202': description: The operation to delete virtual network link to the DNS forwarding ruleset has been accepted and will complete asynchronously. '204': description: The virtual network link to the DNS forwarding ruleset was not found. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-long-running-operation: true x-ms-examples: Delete virtual network link to a DNS forwarding ruleset: $ref: ./examples/VirtualNetworkLink_Delete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Virtualnetworklinks Virtualnetworklinkname get: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksGet description: Gets properties of a virtual network link to a DNS forwarding ruleset. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DnsForwardingRulesetNameParameter' - $ref: '#/parameters/VirtualNetworkLinkNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The virtual network link to DNS forwarding ruleset was found. schema: $ref: '#/definitions/VirtualNetworkLink' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-examples: Retrieve virtual network link to a DNS forwarding ruleset: $ref: ./examples/VirtualNetworkLink_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Virtualnetworklinks Virtualnetworklinkname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/dnsForwardingRulesets/{dnsForwardingRulesetName}/virtualNetworkLinks : get: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksList description: Lists virtual network links to a DNS forwarding ruleset. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DnsForwardingRulesetNameParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/TopParameter' responses: '200': description: List of virtual network links to a DNS forwarding ruleset. schema: $ref: '#/definitions/VirtualNetworkLinkListResult' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List virtual network links to a DNS forwarding ruleset: $ref: ./examples/VirtualNetworkLink_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Dnsforwardingrulesets Dnsforwardingrulesetname Virtualnetworklinks ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks/{virtualNetworkLinkName} : put: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksCreateorupdate description: Creates or updates a virtual network link to the specified Private DNS zone. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: privateZoneName in: path required: true type: string description: The name of the Private DNS zone (without a terminating dot). - name: virtualNetworkLinkName in: path required: true type: string description: The name of the virtual network link. - name: parameters in: body required: true schema: $ref: '#/definitions/VirtualNetworkLink_2' description: Parameters supplied to the CreateOrUpdate operation. - name: If-Match in: header required: false type: string x-ms-client-name: IfMatch description: 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. - name: If-None-Match in: header required: false type: string x-ms-client-name: IfNoneMatch description: 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. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: The virtual network link to the Private DNS zone has been updated. schema: $ref: '#/definitions/VirtualNetworkLink_2' '201': description: The virtual network link to the Private DNS zone has been created. schema: $ref: '#/definitions/VirtualNetworkLink_2' '202': description: The operation to upsert virtual network link to the Private DNS zone has been accepted and will complete asynchronously. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_2' x-ms-long-running-operation: true x-ms-examples: PUT Private DNS Zone Virtual Network Link: $ref: ./examples/VirtualNetworkLinkPut.json summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename Virtualnetworklinks Virtualnetworklinkname patch: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksUpdate description: Updates a virtual network link to the specified Private DNS zone. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: privateZoneName in: path required: true type: string description: The name of the Private DNS zone (without a terminating dot). - name: virtualNetworkLinkName in: path required: true type: string description: The name of the virtual network link. - name: parameters in: body required: true schema: $ref: '#/definitions/VirtualNetworkLink_2' description: Parameters supplied to the Update operation. - name: If-Match in: header required: false type: string x-ms-client-name: IfMatch description: 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. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: The virtual network link to the Private DNS zone has been updated. schema: $ref: '#/definitions/VirtualNetworkLink_2' '202': description: The operation to link virtual network link to Private DNS zone has been accepted and will complete asynchronously. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_2' x-ms-long-running-operation: true x-ms-examples: PATCH Private DNS Zone Virtual Network Link: $ref: ./examples/VirtualNetworkLinkPatch.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename Virtualnetworklinks Virtualnetworklinkname delete: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksDelete description: '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.' parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: privateZoneName in: path required: true type: string description: The name of the Private DNS zone (without a terminating dot). - name: virtualNetworkLinkName in: path required: true type: string description: The name of the virtual network link. - name: If-Match in: header required: false type: string x-ms-client-name: IfMatch description: 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. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: The virtual network link to the Private DNS zone has been deleted. '202': description: The operation to delete virtual network link to the Private DNS zone has been accepted and will complete asynchronously. '204': description: The virtual network link to the Private DNS zone was not found. default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_2' x-ms-long-running-operation: true x-ms-examples: DELETE Private DNS Zone Virtual Network Link: $ref: ./examples/VirtualNetworkLinkDelete.json summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename Virtualnetworklinks Virtualnetworklinkname get: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksGet description: Gets a virtual network link to the specified Private DNS zone. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: privateZoneName in: path required: true type: string description: The name of the Private DNS zone (without a terminating dot). - name: virtualNetworkLinkName in: path required: true type: string description: The name of the virtual network link. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Success. schema: $ref: '#/definitions/VirtualNetworkLink_2' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_2' x-ms-examples: GET Private DNS Zone Virtual Network Link: $ref: ./examples/VirtualNetworkLinkGet.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename Virtualnetworklinks Virtualnetworklinkname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateZoneName}/virtualNetworkLinks : get: tags: - VirtualNetworkLinks operationId: microsoftAzureVirtualnetworklinksList description: Lists the virtual network links to the specified Private DNS zone. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: privateZoneName in: path required: true type: string description: The name of the Private DNS zone (without a terminating dot). - name: $top in: query required: false type: integer format: int32 description: The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: Success. schema: $ref: '#/definitions/VirtualNetworkLinkListResult_2' default: description: Default response. It will be deserialized as per the Error definition. schema: $ref: '#/definitions/CloudError_2' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get Private DNS Zone Virtual Network Links: $ref: ./examples/VirtualNetworkLinkList.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Privatednszones Privatezonename Virtualnetworklinks definitions: VirtualNetworkLink: description: Describes a virtual network link. type: object properties: etag: description: ETag of the virtual network link. type: string readOnly: true properties: description: Properties of the virtual network link. $ref: '#/definitions/VirtualNetworkLinkProperties' x-ms-client-flatten: true systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: Metadata pertaining to creation and last modification of the resource. readOnly: true allOf: - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource VirtualNetworkLinkListResult: description: The response to an enumeration operation on virtual network links. type: object properties: value: description: Enumeration of the virtual network links. type: array items: $ref: '#/definitions/VirtualNetworkLink' nextLink: description: The continuation token for the next page of results. type: string readOnly: true CloudErrorBody: description: The body of an error message type: object properties: code: description: The error code type: string message: description: A description of what caused the error type: string target: description: The target resource of the error message type: string details: description: Extra error information type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-identifiers: [] x-ms-external: true VirtualNetworkLinkListResult_2: properties: value: type: array items: $ref: '#/definitions/VirtualNetworkLink_2' description: Information about the virtual network links to the Private DNS zones. nextLink: type: string description: The continuation token for the next page of results. readOnly: true description: The response to a list virtual network link to Private DNS zone operation. VirtualNetworkLinkPatch: description: Describes a virtual network link for PATCH operation. type: object properties: properties: description: Updatable properties of the virtual network link. $ref: '#/definitions/VirtualNetworkLinkPatchProperties' x-ms-client-flatten: true VirtualNetworkLinkProperties: description: Represents the properties of a virtual network link. type: object properties: virtualNetwork: description: The reference to the virtual network. This cannot be changed after creation. $ref: '#/definitions/SubResource' metadata: description: Metadata attached to the virtual network link. type: object additionalProperties: type: string provisioningState: description: The current provisioning state of the virtual network link. This is a read-only property and any attempt to set this value will be ignored. $ref: '#/definitions/ProvisioningState' readOnly: true Resource: description: The core properties of ARM resources properties: id: type: string readOnly: true description: Fully qualified resource Id for the resource. Example - '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}'. name: type: string readOnly: true description: The name of the resource type: type: string readOnly: true description: The type of the resource. Example - 'Microsoft.Network/privateDnsZones'. x-ms-azure-resource: true TrackedResource: description: The resource model definition for a ARM tracked top level resource properties: tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags. location: type: string x-ms-mutability: - read - create description: The Azure Region where the resource lives allOf: - $ref: '#/definitions/Resource' VirtualNetworkLinkProperties_2: properties: virtualNetwork: $ref: '#/definitions/SubResource_2' description: The reference of the virtual network. registrationEnabled: type: boolean description: Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled? virtualNetworkLinkState: type: string description: The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. enum: - InProgress - Completed x-ms-enum: name: VirtualNetworkLinkState modelAsString: true readOnly: true provisioningState: type: string enum: - Creating - Updating - Deleting - Succeeded - Failed - Canceled x-ms-enum: name: ProvisioningState modelAsString: true description: The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. readOnly: true description: Represents the properties of the Private DNS zone. SubResource_2: properties: id: type: string description: Resource ID. description: Reference to another subresource. x-ms-azure-resource: true SubResource: description: Reference to another ARM resource. type: object properties: id: type: string description: Resource ID. x-ms-azure-resource: true VirtualNetworkLinkPatchProperties: description: Represents the updatable properties of the virtual network link. type: object properties: metadata: description: Metadata attached to the virtual network link. type: object additionalProperties: type: string CloudErrorBody_2: type: object x-ms-external: true properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array items: $ref: '#/definitions/CloudErrorBody_2' description: A list of additional details about the error. description: An error response from the service. CloudError: description: An error message type: object properties: error: description: The error message body $ref: '#/definitions/CloudErrorBody' x-ms-external: true ProvisioningState: description: The current provisioning state of the resource. type: string enum: - Creating - Updating - Deleting - Succeeded - Failed - Canceled x-ms-enum: name: ProvisioningState modelAsString: true VirtualNetworkLink_2: properties: etag: type: string description: The ETag of the virtual network link. properties: x-ms-client-flatten: true $ref: '#/definitions/VirtualNetworkLinkProperties_2' description: Properties of the virtual network link to the Private DNS zone. allOf: - $ref: '#/definitions/TrackedResource' description: Describes a link to virtual network for a Private DNS zone. CloudError_2: type: object x-ms-external: true properties: error: $ref: '#/definitions/CloudErrorBody_2' description: Cloud error body. description: An error response from the service. parameters: IfMatchParameter: name: If-Match in: header required: false type: string x-ms-client-name: IfMatch description: ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes. x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. DnsForwardingRulesetNameParameter: name: dnsForwardingRulesetName in: path required: true type: string description: The name of the DNS forwarding ruleset. x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. IfNoneMatchParameter: name: If-None-Match in: header required: false type: string x-ms-client-name: IfNoneMatch description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored. x-ms-parameter-location: method TopParameter: name: $top in: query required: false type: integer format: int32 description: The maximum number of results to return. If not specified, returns up to 100 results. x-ms-parameter-location: method VirtualNetworkLinkNameParameter: name: virtualNetworkLinkName in: path required: true type: string description: The name of the virtual network link. x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'