VirtualNetworkLinksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

PrivateDnsManagementClient's

<xref:virtual_network_links> attribute.

Inheritance

builtins.object

VirtualNetworkLinksOperations

Constructor

VirtualNetworkLinksOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a virtual network link to the specified Private DNS zone.
begin_delete	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.
begin_update	Updates a virtual network link to the specified Private DNS zone.
get	Gets a virtual network link to the specified Private DNS zone.
list	Lists the virtual network links to the specified Private DNS zone.

begin_create_or_update

Creates or updates a virtual network link to the specified Private DNS zone.

async begin_create_or_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: _models.VirtualNetworkLink, if_match: str | None = None, if_none_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualNetworkLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.
virtual_network_link_name Required	str The name of the virtual network link. Required.
parameters Required	VirtualNetworkLink or IO[bytes] Parameters supplied to the CreateOrUpdate operation. Is either a VirtualNetworkLink type or a IO[bytes] type. Required.
if_match Required	str 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. Default value is None.
if_none_match Required	str 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. Default value is None.

Returns

Type	Description
AsyncLROPoller[VirtualNetworkLink]	An instance of AsyncLROPoller that returns either VirtualNetworkLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

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.

async begin_delete(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, if_match: str | None = None, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.
virtual_network_link_name Required	str The name of the virtual network link. Required.
if_match Required	str 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. Default value is None.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates a virtual network link to the specified Private DNS zone.

async begin_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: _models.VirtualNetworkLink, if_match: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.VirtualNetworkLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.
virtual_network_link_name Required	str The name of the virtual network link. Required.
parameters Required	VirtualNetworkLink or IO[bytes] Parameters supplied to the Update operation. Is either a VirtualNetworkLink type or a IO[bytes] type. Required.
if_match Required	str 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. Default value is None.

Returns

Type	Description
AsyncLROPoller[VirtualNetworkLink]	An instance of AsyncLROPoller that returns either VirtualNetworkLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a virtual network link to the specified Private DNS zone.

async get(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, **kwargs: Any) -> VirtualNetworkLink

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.
virtual_network_link_name Required	str The name of the virtual network link. Required.

Returns

Type	Description
VirtualNetworkLink	VirtualNetworkLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists the virtual network links to the specified Private DNS zone.

list(resource_group_name: str, private_zone_name: str, top: int | None = None, **kwargs: Any) -> AsyncIterable[VirtualNetworkLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.
top Required	int The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links. Default value is None.

Returns

Type	Description
AsyncItemPaged[VirtualNetworkLink]	An iterator like instance of either VirtualNetworkLink or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.privatedns.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\privatedns\\models\\__init__.py'>