RecordSetsOperations class

Definition

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.

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

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, relative_record_set_name, record_type, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)

Creates or updates a record set within a DNS zone.

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

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

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

Gets a record set.

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

Lists all record sets in a DNS zone.

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

Lists all record sets in a DNS zone.

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

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

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

Updates a record set within a DNS zone.

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)

Creates or updates a record set within a DNS zone.

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)

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.

default value: None
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.

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

RecordSet or ClientRawResponse if raw=true

Return type

Exceptions

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

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

delete(resource_group_name, zone_name, relative_record_set_name, record_type, if_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).

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.

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

None or ClientRawResponse if raw=true

Return type

Exceptions

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

Gets a record set.

get(resource_group_name, zone_name, relative_record_set_name, record_type, 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).

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

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

Exceptions

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

Lists all record sets in a DNS zone.

list_all_by_dns_zone(resource_group_name, zone_name, top=None, record_set_name_suffix=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).

top
int

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

default value: None
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 .

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 RecordSet

Return type

Exceptions

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

Lists all record sets in a DNS zone.

list_by_dns_zone(resource_group_name, zone_name, top=None, recordsetnamesuffix=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).

top
int

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

default value: None
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 .

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 RecordSet

Return type

Exceptions

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

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

list_by_type(resource_group_name, zone_name, record_type, top=None, recordsetnamesuffix=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).

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.

default value: None
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 .

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 RecordSet

Return type

Exceptions

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

Updates a record set within a DNS zone.

update(resource_group_name, zone_name, relative_record_set_name, record_type, parameters, if_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).

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.

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

RecordSet 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'>