PrivateZonesOperations Class

PrivateZonesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

PrivateZonesOperations

Constructor

PrivateZonesOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.privatedns.models._models_py3.PrivateZone, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.privatedns.models._models_py3.PrivateZone]

Parameters

resource_group_name

str

Required

The name of the resource group.

private_zone_name

str

Required

The name of the Private DNS zone (without a terminating dot).

parameters

PrivateZone

Required

Parameters supplied to the CreateOrUpdate operation.

if_match

str

default value: None

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

str

default value: None

Set to '*' to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either PrivateZone or the result of cls(response)

Return type

AsyncLROPoller[PrivateZone]

Exceptions

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, if_match: Optional[str] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

private_zone_name

str

Required

The name of the Private DNS zone (without a terminating dot).

if_match

str

default value: None

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.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

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: azure.mgmt.privatedns.models._models_py3.PrivateZone, if_match: Optional[str] = None, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.privatedns.models._models_py3.PrivateZone]

Parameters

resource_group_name

str

Required

The name of the resource group.

private_zone_name

str

Required

The name of the Private DNS zone (without a terminating dot).

parameters

PrivateZone

Required

Parameters supplied to the Update operation.

if_match

str

default value: None

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.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either PrivateZone or the result of cls(response)

Return type

AsyncLROPoller[PrivateZone]

Exceptions

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) -> azure.mgmt.privatedns.models._models_py3.PrivateZone

Parameters

resource_group_name

str

Required

The name of the resource group.

private_zone_name

str

Required

The name of the Private DNS zone (without a terminating dot).

cls

callable

A custom type or function that will be passed the direct response

Returns

PrivateZone, or the result of cls(response)

Return type

PrivateZone

Exceptions

HttpResponseError

list

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

list(top: Optional[int] = None, **kwargs) -> AsyncIterable[azure.mgmt.privatedns.models._models_py3.PrivateZoneListResult]

Parameters

top

int

default value: None

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateZoneListResult or the result of cls(response)

Return type

AsyncItemPaged[PrivateZoneListResult]

Exceptions

HttpResponseError

list_by_resource_group

Lists the Private DNS zones within a resource group.

list_by_resource_group(resource_group_name: str, top: Optional[int] = None, **kwargs) -> AsyncIterable[azure.mgmt.privatedns.models._models_py3.PrivateZoneListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

top

int

default value: None

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

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateZoneListResult or the result of cls(response)

Return type

AsyncItemPaged[PrivateZoneListResult]

Exceptions

HttpResponseError

Attributes

models

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