azure.mgmt.dns.v2018_03_01_preview.operations module

class azure.mgmt.dns.v2018_03_01_preview.operations.RecordSetsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DnsManagementClient’s record_sets attribute.

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, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet[source]
create_or_update(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], parameters: IO, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet

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

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

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

  • 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). Known values are: “A”, “AAAA”, “CAA”, “CNAME”, “MX”, “NS”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

  • parameters (RecordSet or IO) – Parameters supplied to the CreateOrUpdate operation. Is either a RecordSet type or a IO type. Required.

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

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

RecordSet or the result of cls(response)

Return type

RecordSet

Raises

HttpResponseError –

delete(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, azure.mgmt.dns.v2018_03_01_preview.models._dns_management_client_enums.RecordType], if_match: Optional[str] = None, **kwargs: Any) → None[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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

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

  • 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). Known values are: “A”, “AAAA”, “CAA”, “CNAME”, “MX”, “NS”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, azure.mgmt.dns.v2018_03_01_preview.models._dns_management_client_enums.RecordType], **kwargs: Any) → azure.mgmt.dns.v2018_03_01_preview.models._models_py3.RecordSet[source]

Gets a record set.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

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

  • record_type (str or RecordType) – The type of DNS record in this record set. Known values are: “A”, “AAAA”, “CAA”, “CNAME”, “MX”, “NS”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecordSet or the result of cls(response)

Return type

RecordSet

Raises

HttpResponseError –

list_all_by_dns_zone(resource_group_name: str, zone_name: str, top: Optional[int] = None, record_set_name_suffix: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.dns.v2018_03_01_preview.models._models_py3.RecordSet][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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets. Default value is 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 .:code:<recordSetNameSuffix>. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RecordSet]

Raises

HttpResponseError –

list_by_dns_zone(resource_group_name: str, zone_name: str, top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.dns.v2018_03_01_preview.models._models_py3.RecordSet][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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets. Default value is 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 .:code:<recordSetNameSuffix>. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RecordSet]

Raises

HttpResponseError –

list_by_type(resource_group_name: str, zone_name: str, record_type: Union[str, azure.mgmt.dns.v2018_03_01_preview.models._dns_management_client_enums.RecordType], top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.dns.v2018_03_01_preview.models._models_py3.RecordSet][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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

  • record_type (str or RecordType) – The type of record sets to enumerate. Known values are: “A”, “AAAA”, “CAA”, “CNAME”, “MX”, “NS”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

  • top (int) – The maximum number of record sets to return. If not specified, returns up to 100 record sets. Default value is 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 .:code:<recordSetNameSuffix>. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RecordSet]

Raises

HttpResponseError –

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, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet[source]
update(resource_group_name: str, zone_name: str, relative_record_set_name: str, record_type: Union[str, _models.RecordType], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet

Updates a record set within a DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

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

  • record_type (str or RecordType) – The type of DNS record in this record set. Known values are: “A”, “AAAA”, “CAA”, “CNAME”, “MX”, “NS”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

  • parameters (RecordSet or IO) – Parameters supplied to the Update operation. Is either a RecordSet type or a IO type. Required.

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

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

RecordSet or the result of cls(response)

Return type

RecordSet

Raises

HttpResponseError –

models = <module 'azure.mgmt.dns.v2018_03_01_preview.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-dns/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/dns/v2018_03_01_preview/models/__init__.py'>
class azure.mgmt.dns.v2018_03_01_preview.operations.ZonesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through DnsManagementClient’s zones attribute.

begin_delete(resource_group_name: str, zone_name: str, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

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

Keyword Arguments

  • cls (callable) – A custom type or function that will be passed the direct response

  • continuation_token (str) – A continuation token to restart a poller from a saved state.

  • polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

  • polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

create_or_update(resource_group_name: str, zone_name: str, parameters: _models.Zone, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Zone[source]
create_or_update(resource_group_name: str, zone_name: str, parameters: IO, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Zone

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

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

  • parameters (Zone or IO) – Parameters supplied to the CreateOrUpdate operation. Is either a Zone type or a IO type. Required.

  • 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. Default value is 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 is None.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

Zone or the result of cls(response)

Return type

Zone

Raises

HttpResponseError –

get(resource_group_name: str, zone_name: str, **kwargs: Any) → azure.mgmt.dns.v2018_03_01_preview.models._models_py3.Zone[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. Required.

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Zone or the result of cls(response)

Return type

Zone

Raises

HttpResponseError –

list(top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.dns.v2018_03_01_preview.models._models_py3.Zone][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. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Zone]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.dns.v2018_03_01_preview.models._models_py3.Zone][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. Required.

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

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Zone]

Raises

HttpResponseError –

update(resource_group_name: str, zone_name: str, parameters: _models.ZoneUpdate, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Zone[source]
update(resource_group_name: str, zone_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Zone

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

  • zone_name (str) – The name of the DNS zone (without a terminating dot). Required.

  • parameters (ZoneUpdate or IO) – Parameters supplied to the Update operation. Is either a ZoneUpdate type or a IO type. Required.

  • 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. Default value is None.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

  • cls (callable) – A custom type or function that will be passed the direct response

Returns

Zone or the result of cls(response)

Return type

Zone

Raises

HttpResponseError –

models = <module 'azure.mgmt.dns.v2018_03_01_preview.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-dns/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/dns/v2018_03_01_preview/models/__init__.py'>