RecordSetsOperations Class

RecordSetsOperations 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
RecordSetsOperations

Constructor

RecordSetsOperations(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

create_or_update

Creates or updates a record set within a DNS zone.

delete

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

get

Gets a record set.

list_by_dns_zone

Lists all record sets in a DNS zone.

list_by_type

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

update

Updates a record set within a DNS zone.

create_or_update

Creates or updates a record set within a DNS zone.

create_or_update(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], parameters: _models.RecordSet, if_match: Optional[str] = None, if_none_match: Optional[str] = None, **kwargs: Any) -> _models.RecordSet

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

relative_record_set_name
str
Required

The name of the record set, relative to the name of the zone.

record_type
str or RecordType
Required

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

parameters
RecordSet
Required

Parameters supplied to the CreateOrUpdate operation.

if_match
str
default value: None

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

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

cls
callable

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

Returns

RecordSet, or the result of cls(response)

Return type

Exceptions

delete

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

delete(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], if_match: Optional[str] = None, **kwargs: Any) -> 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).

relative_record_set_name
str
Required

The name of the record set, relative to the name of the zone.

record_type
str or RecordType
Required

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

if_match
str
default value: None

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.

cls
callable

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

Returns

None, or the result of cls(response)

Return type

Exceptions

get

Gets a record set.

get(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], **kwargs: Any) -> _models.RecordSet

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

relative_record_set_name
str
Required

The name of the record set, relative to the name of the zone.

record_type
str or RecordType
Required

The type of DNS record in this record set.

cls
callable

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

Returns

RecordSet, or the result of cls(response)

Return type

Exceptions

list_by_dns_zone

Lists all record sets in a DNS zone.

list_by_dns_zone(resource_group_name: str, zone_name: str, top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) -> Iterable[_models.RecordSetListResult]

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

top
int
default value: None

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

recordsetnamesuffix
str
default value: None

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 .:code:.

cls
callable

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

Returns

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

Return type

Exceptions

list_by_type

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

list_by_type(resource_group_name: str, zone_name: str, record_type: Union[str, _models.RecordType], top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) -> Iterable[_models.RecordSetListResult]

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

record_type
str or RecordType
Required

The type of record sets to enumerate.

top
int
default value: None

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

recordsetnamesuffix
str
default value: None

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 .:code:.

cls
callable

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

Returns

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

Return type

Exceptions

update

Updates a record set within a DNS zone.

update(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], parameters: _models.RecordSet, if_match: Optional[str] = None, **kwargs: Any) -> _models.RecordSet

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

relative_record_set_name
str
Required

The name of the record set, relative to the name of the zone.

record_type
str or RecordType
Required

The type of DNS record in this record set.

parameters
RecordSet
Required

Parameters supplied to the Update operation.

if_match
str
default value: None

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.

cls
callable

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

Returns

RecordSet, or the result of cls(response)

Return type

Exceptions

Attributes

models

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