RecordSetsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

PrivateDnsManagementClient's

<xref:record_sets> attribute.

Constructor

RecordSetsOperations(*args, **kwargs)

Methods

create_or_update

Creates or updates a record set within a Private DNS zone.
delete

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

Gets a record set.
list

Lists all record sets in a Private DNS zone.
list_by_type

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

Updates a record set within a Private DNS zone.

create_or_update

Creates or updates a record set within a Private DNS zone.

create_or_update(resource_group_name: str, private_zone_name: str, record_type: str | _models.RecordType, relative_record_set_name: str, parameters: _models.RecordSet, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.RecordSet

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

The name of the DNS zone (without a terminating dot). Required.
record_type
Required
str or RecordType

The type of DNS record in this record set. Known values are: "A", "AAAA", "CNAME", "MX", "PTR", "SOA", "SRV", and "TXT". Required.
relative_record_set_name
Required
str

The name of the record set, relative to the name of the zone. Required.
parameters
Required
RecordSet or RecordSet or IO[bytes]

Parameters supplied to the CreateOrUpdate operation. Is either a RecordSet type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name Description
etag
str

check if resource is changed. Set None to skip checking etag. Default value is None.

Default value: None
match_condition
MatchConditions

The match condition to use upon the etag. Default value is None.

Default value: None

Returns

Type Description
RecordSet

RecordSet. The RecordSet is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete

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

delete(resource_group_name: str, private_zone_name: str, record_type: str | RecordType, relative_record_set_name: str, *, etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

The name of the DNS zone (without a terminating dot). Required.
record_type
Required
str or RecordType

The type of DNS record in this record set. Known values are: "A", "AAAA", "CNAME", "MX", "PTR", "SOA", "SRV", and "TXT". Required.
relative_record_set_name
Required
str

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

Keyword-Only Parameters

Name Description
etag
str

check if resource is changed. Set None to skip checking etag. Default value is None.

Default value: None
match_condition
MatchConditions

The match condition to use upon the etag. Default value is None.

Default value: None

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get

Gets a record set.

get(resource_group_name: str, private_zone_name: str, record_type: str | RecordType, relative_record_set_name: str, **kwargs: Any) -> RecordSet

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

The name of the DNS zone (without a terminating dot). Required.
record_type
Required
str or RecordType

The type of DNS record in this record set. Known values are: "A", "AAAA", "CNAME", "MX", "PTR", "SOA", "SRV", and "TXT". Required.
relative_record_set_name
Required
str

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

Returns

Type Description
RecordSet

RecordSet. The RecordSet is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

Lists all record sets in a Private DNS zone.

list(resource_group_name: str, private_zone_name: str, *, top: int | None = None, recordsetnamesuffix: str | None = None, **kwargs: Any) -> ItemPaged[RecordSet]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

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

Keyword-Only Parameters

Name Description
top
int

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

Default value: None
recordsetnamesuffix
str

The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".<recordsetnamesuffix>". Default value is None.

Default value: None

Returns

Type Description
ItemPaged[RecordSet]

An iterator like instance of RecordSet

Exceptions

Type Description
HttpResponseError

list_by_type

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

list_by_type(resource_group_name: str, private_zone_name: str, record_type: str | RecordType, *, top: int | None = None, recordsetnamesuffix: str | None = None, **kwargs: Any) -> ItemPaged[RecordSet]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

The name of the DNS zone (without a terminating dot). Required.
record_type
Required
str or RecordType

The type of DNS record in this record set. Known values are: "A", "AAAA", "CNAME", "MX", "PTR", "SOA", "SRV", and "TXT". Required.

Keyword-Only Parameters

Name Description
top
int

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

Default value: None
recordsetnamesuffix
str

The suffix label of the record set name to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain records that end with ".<recordsetnamesuffix>". Default value is None.

Default value: None

Returns

Type Description
ItemPaged[RecordSet]

An iterator like instance of RecordSet

Exceptions

Type Description
HttpResponseError

update

Updates a record set within a Private DNS zone.

update(resource_group_name: str, private_zone_name: str, record_type: str | _models.RecordType, relative_record_set_name: str, parameters: _models.RecordSet, *, content_type: str = 'application/json', etag: str | None = None, match_condition: MatchConditions | None = None, **kwargs: Any) -> _models.RecordSet

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
private_zone_name
Required
str

The name of the DNS zone (without a terminating dot). Required.
record_type
Required
str or RecordType

The type of DNS record in this record set. Known values are: "A", "AAAA", "CNAME", "MX", "PTR", "SOA", "SRV", and "TXT". Required.
relative_record_set_name
Required
str

The name of the record set, relative to the name of the zone. Required.
parameters
Required
RecordSet or RecordSet or IO[bytes]

Parameters supplied to the Update operation. Is either a RecordSet type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name Description
etag
str

check if resource is changed. Set None to skip checking etag. Default value is None.

Default value: None
match_condition
MatchConditions

The match condition to use upon the etag. Default value is None.

Default value: None

Returns

Type Description
RecordSet

RecordSet. The RecordSet is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError