ZonesOperations Class

ZonesOperations 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

ZonesOperations

Constructor

ZonesOperations(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_delete	Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.
create_or_update	Creates or updates a DNS zone. Does not modify DNS records within the zone.
get	Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
list	Lists the DNS zones in all resource groups in a subscription.
list_by_resource_group	Lists the DNS zones within a resource group.
update	Updates a DNS zone. Does not modify DNS records within the zone.

begin_delete

Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

begin_delete(resource_group_name: str, zone_name: str, if_match: Optional[str] = None, **kwargs: Any) -> LROPoller[None]

Parameters

resource_group_name

str

Required

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

zone_name

str

Required

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

if_match

str

default value: None

The etag of the 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 PollingMethod

Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a 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 LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Exceptions

HttpResponseError

create_or_update

Creates or updates a DNS zone. Does not modify DNS records within the zone.

create_or_update(resource_group_name: str, zone_name: str, parameters: _models.Zone, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> _models.Zone

Parameters

resource_group_name

str

Required

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

zone_name

str

Required

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

parameters

Zone

Required

Parameters supplied to the CreateOrUpdate operation.

if_match

str

default value: None

The etag of the 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 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

Returns

Zone, or the result of cls(response)

Return type

Zone

Exceptions

HttpResponseError

get

Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

get(resource_group_name: str, zone_name: str, **kwargs: Any) -> _models.Zone

Parameters

resource_group_name

str

Required

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

zone_name

str

Required

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

cls

callable

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

Returns

Zone, or the result of cls(response)

Return type

Zone

Exceptions

HttpResponseError

list

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

list(top: Optional[int] = None, **kwargs: Any) -> Iterable[_models.ZoneListResult]

Parameters

top

int

default value: None

The maximum number of 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 ZoneListResult or the result of cls(response)

Return type

ItemPaged[ZoneListResult]

Exceptions

HttpResponseError

list_by_resource_group

Lists the DNS zones within a resource group.

list_by_resource_group(resource_group_name: str, top: Optional[int] = None, **kwargs: Any) -> Iterable[_models.ZoneListResult]

Parameters

resource_group_name

str

Required

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

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 ZoneListResult or the result of cls(response)

Return type

ItemPaged[ZoneListResult]

Exceptions

HttpResponseError

update

Updates a DNS zone. Does not modify DNS records within the zone.

update(resource_group_name: str, zone_name: str, parameters: _models.ZoneUpdate, if_match: Optional[str] = None, **kwargs: Any) -> _models.Zone

Parameters

resource_group_name

str

Required

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

zone_name

str

Required

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

parameters

ZoneUpdate

Required

Parameters supplied to the Update operation.

if_match

str

default value: None

The etag of the 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

Returns

Zone, or the result of cls(response)

Return type

Zone

Exceptions

HttpResponseError

Attributes

models

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