VirtualNetworkLinksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:virtual_network_links> attribute.

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.

begin_create_or_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: _models.VirtualNetworkLink, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> LROPoller[_models.VirtualNetworkLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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 VirtualNetworkLink or IO[bytes] Parameters supplied to the CreateOrUpdate operation. Is either a VirtualNetworkLink type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
LROPoller[VirtualNetworkLink]	An instance of LROPoller that returns VirtualNetworkLink. The VirtualNetworkLink is compatible with MutableMapping

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.

begin_delete(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_update

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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 VirtualNetworkLink or IO[bytes] Parameters supplied to the Update operation. Is either a VirtualNetworkLink type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name	Description
etag	str check if resource is changed. Set None to skip checking etag. Default value is None. Default value: None
match_condition	MatchConditions The match condition to use upon the etag. Default value is None. Default value: None

Returns

Type	Description
LROPoller[VirtualNetworkLink]	An instance of LROPoller that returns VirtualNetworkLink. The VirtualNetworkLink is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

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

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. The name is case insensitive. 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. The VirtualNetworkLink is compatible with MutableMapping

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) -> ItemPaged[VirtualNetworkLink]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
private_zone_name Required	str The name of the Private DNS zone (without a terminating dot). Required.

Keyword-Only Parameters

Name	Description
top	int The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[VirtualNetworkLink]	An iterator like instance of VirtualNetworkLink

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?