azure.mgmt.dns.v2018_03_01_preview.operations module

class azure.mgmt.dns.v2018_03_01_preview.operations.RecordSetsOperations(client, config, serializer, deserializer)[source]

Bases: object

RecordSetsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2018-03-01-preview”.

create_or_update(resource_group_name, zone_name, relative_record_set_name, record_type, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a record set within a DNS zone.

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

  • relative_record_set_name (str) – The name of the record set, relative to the name of the zone.

  • record_type (str or RecordType) – The type of DNS record in this record set. Record sets of type SOA can be updated but not created (they are created when the DNS zone is created). Possible values include: ‘A’, ‘AAAA’, ‘CAA’, ‘CNAME’, ‘MX’, ‘NS’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

  • parameters (RecordSet) – Parameters supplied to the CreateOrUpdate operation.

  • if_match (str) – The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes.

  • if_none_match (str) – Set to ‘*’ to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

delete(resource_group_name, zone_name, relative_record_set_name, record_type, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

Deletes a record set from a DNS zone. This operation cannot be undone.

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

  • relative_record_set_name (str) – The name of the record set, relative to the name of the zone.

  • record_type (str or RecordType) – The type of DNS record in this record set. Record sets of type SOA cannot be deleted (they are deleted when the DNS zone is deleted). Possible values include: ‘A’, ‘AAAA’, ‘CAA’, ‘CNAME’, ‘MX’, ‘NS’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

  • if_match (str) – The etag of the record set. Omit this value to always delete the current record set. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, zone_name, relative_record_set_name, record_type, custom_headers=None, raw=False, **operation_config)[source]

Gets a record set.

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

  • relative_record_set_name (str) – The name of the record set, relative to the name of the zone.

  • record_type (str or RecordType) – The type of DNS record in this record set. Possible values include: ‘A’, ‘AAAA’, ‘CAA’, ‘CNAME’, ‘MX’, ‘NS’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

list_all_by_dns_zone(resource_group_name, zone_name, top=None, record_set_name_suffix=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all record sets in a DNS zone.

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

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets.

  • record_set_name_suffix (str) – The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix>

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecordSet

Return type

RecordSetPaged[RecordSet]

Raises

CloudError

list_by_dns_zone(resource_group_name, zone_name, top=None, recordsetnamesuffix=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all record sets in a DNS zone.

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

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets.

  • recordsetnamesuffix (str) – The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix>

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecordSet

Return type

RecordSetPaged[RecordSet]

Raises

CloudError

list_by_type(resource_group_name, zone_name, record_type, top=None, recordsetnamesuffix=None, custom_headers=None, raw=False, **operation_config)[source]

Lists the record sets of a specified type in a DNS zone.

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

  • record_type (str or RecordType) – The type of record sets to enumerate. Possible values include: ‘A’, ‘AAAA’, ‘CAA’, ‘CNAME’, ‘MX’, ‘NS’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets.

  • recordsetnamesuffix (str) – The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with .<recordSetNameSuffix>

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecordSet

Return type

RecordSetPaged[RecordSet]

Raises

CloudError

update(resource_group_name, zone_name, relative_record_set_name, record_type, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

Updates a record set within a DNS zone.

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

  • relative_record_set_name (str) – The name of the record set, relative to the name of the zone.

  • record_type (str or RecordType) – The type of DNS record in this record set. Possible values include: ‘A’, ‘AAAA’, ‘CAA’, ‘CNAME’, ‘MX’, ‘NS’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

  • parameters (RecordSet) – Parameters supplied to the Update operation.

  • if_match (str) – The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.dns.v2018_03_01_preview.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-dns/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/dns/v2018_03_01_preview/models/__init__.py'>
class azure.mgmt.dns.v2018_03_01_preview.operations.ZonesOperations(client, config, serializer, deserializer)[source]

Bases: object

ZonesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2018-03-01-preview”.

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

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

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 overwriting any concurrent changes.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Zone or ClientRawResponse

Raises

CloudError

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

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

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.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

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

Returns

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

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

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

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

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

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Zone or ClientRawResponse

Raises

CloudError

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

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

Parameters

  • top (int) – The maximum number of DNS zones to return. If not specified, returns up to 100 zones.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Zone

Return type

ZonePaged[Zone]

Raises

CloudError

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

Lists the DNS zones within a resource group.

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.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of Zone

Return type

ZonePaged[Zone]

Raises

CloudError

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

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

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 overwriting any concurrent changes.

  • tags (dict[str, str]) – Resource tags.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Zone or ClientRawResponse if raw=true

Return type

Zone or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.dns.v2018_03_01_preview.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-dns/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/dns/v2018_03_01_preview/models/__init__.py'>