PrivateZonesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

PrivateDnsManagementClient's

<xref:private_zones> attribute.

Constructor

PrivateZonesOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.
begin_delete

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.
begin_update

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.
get

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.
list

Lists the Private DNS zones in all resource groups in a subscription.
list_by_resource_group

Lists the Private DNS zones within a resource group.

begin_create_or_update

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.

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

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.
parameters
Required
PrivateZone or PrivateZone or IO[bytes]

Parameters supplied to the CreateOrUpdate operation. Is either a PrivateZone 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
AsyncLROPoller[PrivateZone]

An instance of AsyncLROPoller that returns PrivateZone. The PrivateZone is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

begin_delete

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.

async begin_delete(resource_group_name: str, private_zone_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> AsyncLROPoller[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.

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
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns None

Exceptions

Type Description
HttpResponseError

begin_update

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

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

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.
parameters
Required
PrivateZone or PrivateZone or IO[bytes]

Parameters supplied to the Update operation. Is either a PrivateZone 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
AsyncLROPoller[PrivateZone]

An instance of AsyncLROPoller that returns PrivateZone. The PrivateZone is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

get

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

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

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.

Returns

Type Description
PrivateZone

PrivateZone. The PrivateZone is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

Lists the Private DNS zones in all resource groups in a subscription.

list(*, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[PrivateZone]

Keyword-Only Parameters

Name Description
top
int

The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[PrivateZone]

An iterator like instance of PrivateZone

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Lists the Private DNS zones within a resource group.

list_by_resource_group(resource_group_name: str, *, top: int | None = None, **kwargs: Any) -> AsyncItemPaged[PrivateZone]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Keyword-Only Parameters

Name Description
top
int

The maximum number of record sets to return. If not specified, returns up to 100 record sets. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[PrivateZone]

An iterator like instance of PrivateZone

Exceptions

Type Description
HttpResponseError