ZonesOperations class

Definition

ZonesOperations operations.

ZonesOperations(client, config, serializer, deserializer)
Inheritance
builtins.object
ZonesOperations

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

api_version
class
The API version to use for this operation. Constant value: "2018-03-01-preview".

Methods

create_or_update(resource_group_name, zone_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)

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

delete(resource_group_name, zone_name, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)

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

get(resource_group_name, zone_name, custom_headers=None, raw=False, **operation_config)

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

list(top=None, custom_headers=None, raw=False, **operation_config)

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

list_by_resource_group(resource_group_name, top=None, custom_headers=None, raw=False, **operation_config)

Lists the DNS zones within a resource group.

update(resource_group_name, zone_name, if_match=None, tags=None, custom_headers=None, raw=False, **operation_config)

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

create_or_update(resource_group_name, zone_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)

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

create_or_update(resource_group_name, zone_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

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

zone_name
str

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

parameters
Zone

Parameters supplied to the CreateOrUpdate operation.

if_match
str

The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes.

default value: None
if_none_match
str

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

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Exceptions

delete(resource_group_name, zone_name, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)

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

delete(resource_group_name, zone_name, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

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

zone_name
str

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

if_match
str

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.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

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

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

get(resource_group_name, zone_name, custom_headers=None, raw=False, **operation_config)

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

get(resource_group_name, zone_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

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

zone_name
str

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

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Exceptions

list(top=None, custom_headers=None, raw=False, **operation_config)

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

list(top=None, custom_headers=None, raw=False, **operation_config)

Parameters

top
int

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

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of Zone

Return type

Exceptions

list_by_resource_group(resource_group_name, top=None, custom_headers=None, raw=False, **operation_config)

Lists the DNS zones within a resource group.

list_by_resource_group(resource_group_name, top=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

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

top
int

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

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of Zone

Return type

Exceptions

update(resource_group_name, zone_name, if_match=None, tags=None, custom_headers=None, raw=False, **operation_config)

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

update(resource_group_name, zone_name, if_match=None, tags=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

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

zone_name
str

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

if_match
str

The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes.

default value: None
tags
dict[str or str]

Resource tags.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.dns.v2018_03_01_preview.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\dns\\v2018_03_01_preview\\models\\__init__.py'>