azure.mgmt.dns.v2018_05_01.models module¶

class azure.mgmt.dns.v2018_05_01.models.ARecord(*, ipv4_address: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An A record.

Variables: ipv4_address (str) – The IPv4 address of this A record.
Keyword Arguments: ipv4_address (str) – The IPv4 address of this A record.

class azure.mgmt.dns.v2018_05_01.models.AaaaRecord(*, ipv6_address: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An AAAA record.

Variables: ipv6_address (str) – The IPv6 address of this AAAA record.
Keyword Arguments: ipv6_address (str) – The IPv6 address of this AAAA record.

class azure.mgmt.dns.v2018_05_01.models.CaaRecord(*, flags: Optional[int] = None, tag: Optional[str] = None, value: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

A CAA record.

Variables

flags (int) – The flags for this CAA record as an integer between 0 and 255.
tag (str) – The tag for this CAA record.
value (str) – The value for this CAA record.

Keyword Arguments

flags (int) – The flags for this CAA record as an integer between 0 and 255.
tag (str) – The tag for this CAA record.
value (str) – The value for this CAA record.

class azure.mgmt.dns.v2018_05_01.models.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.CloudErrorBody]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An error response from the service.

Variables

code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message (str) – A message describing the error, intended to be suitable for display in a user interface.
target (str) – The target of the particular error. For example, the name of the property in error.
details (list[CloudErrorBody]) – A list of additional details about the error.

Keyword Arguments

code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
message (str) – A message describing the error, intended to be suitable for display in a user interface.
target (str) – The target of the particular error. For example, the name of the property in error.
details (list[CloudErrorBody]) – A list of additional details about the error.

class azure.mgmt.dns.v2018_05_01.models.CnameRecord(*, cname: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

A CNAME record.

Variables: cname (str) – The canonical name for this CNAME record.
Keyword Arguments: cname (str) – The canonical name for this CNAME record.

class azure.mgmt.dns.v2018_05_01.models.DnsResourceReference(*, dns_resources: Optional[List[_models.SubResource]] = None, target_resource: Optional[_models.SubResource] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Represents a single Azure resource and its referencing DNS records.

Variables

dns_resources (list[SubResource]) – A list of dns Records.
target_resource (SubResource) – A reference to an azure resource from where the dns resource value is taken.

Keyword Arguments

dns_resources (list[SubResource]) – A list of dns Records.
target_resource (SubResource) – A reference to an azure resource from where the dns resource value is taken.

class azure.mgmt.dns.v2018_05_01.models.DnsResourceReferenceRequest(*, target_resources: Optional[List[_models.SubResource]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Represents the properties of the Dns Resource Reference Request.

Variables: target_resources (list[SubResource]) – A list of references to azure resources for which referencing dns records need to be queried.
Keyword Arguments: target_resources (list[SubResource]) – A list of references to azure resources for which referencing dns records need to be queried.

class azure.mgmt.dns.v2018_05_01.models.DnsResourceReferenceResult(*, dns_resource_references: Optional[List[_models.DnsResourceReference]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Represents the properties of the Dns Resource Reference Result.

Variables: dns_resource_references (list[DnsResourceReference]) – The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request.
Keyword Arguments: dns_resource_references (list[DnsResourceReference]) – The result of dns resource reference request. A list of dns resource references for each of the azure resource in the request.

class azure.mgmt.dns.v2018_05_01.models.MxRecord(*, preference: Optional[int] = None, exchange: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An MX record.

Variables

preference (int) – The preference value for this MX record.
exchange (str) – The domain name of the mail host for this MX record.

Keyword Arguments

preference (int) – The preference value for this MX record.
exchange (str) – The domain name of the mail host for this MX record.

class azure.mgmt.dns.v2018_05_01.models.NsRecord(*, nsdname: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An NS record.

Variables: nsdname (str) – The name server name for this NS record.
Keyword Arguments: nsdname (str) – The name server name for this NS record.

class azure.mgmt.dns.v2018_05_01.models.PtrRecord(*, ptrdname: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

A PTR record.

Variables: ptrdname (str) – The PTR target domain name for this PTR record.
Keyword Arguments: ptrdname (str) – The PTR target domain name for this PTR record.

class azure.mgmt.dns.v2018_05_01.models.RecordSet(*, etag: Optional[str] = None, metadata: Optional[Dict[str, str]] = None, ttl: Optional[int] = None, target_resource: Optional[_models.SubResource] = None, a_records: Optional[List[_models.ARecord]] = None, aaaa_records: Optional[List[_models.AaaaRecord]] = None, mx_records: Optional[List[_models.MxRecord]] = None, ns_records: Optional[List[_models.NsRecord]] = None, ptr_records: Optional[List[_models.PtrRecord]] = None, srv_records: Optional[List[_models.SrvRecord]] = None, txt_records: Optional[List[_models.TxtRecord]] = None, cname_record: Optional[_models.CnameRecord] = None, soa_record: Optional[_models.SoaRecord] = None, caa_records: Optional[List[_models.CaaRecord]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Describes a DNS record set (a collection of DNS records with the same name and type).

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The ID of the record set.
name (str) – The name of the record set.
type (str) – The type of the record set.
etag (str) – The etag of the record set.
metadata (dict[str, str]) – The metadata attached to the record set.
ttl (int) – The TTL (time-to-live) of the records in the record set.
fqdn (str) – Fully qualified domain name of the record set.
provisioning_state (str) – provisioning State of the record set.
target_resource (SubResource) – A reference to an azure resource from where the dns resource value is taken.
a_records (list[ARecord]) – The list of A records in the record set.
aaaa_records (list[AaaaRecord]) – The list of AAAA records in the record set.
mx_records (list[MxRecord]) – The list of MX records in the record set.
ns_records (list[NsRecord]) – The list of NS records in the record set.
ptr_records (list[PtrRecord]) – The list of PTR records in the record set.
srv_records (list[SrvRecord]) – The list of SRV records in the record set.
txt_records (list[TxtRecord]) – The list of TXT records in the record set.
cname_record (CnameRecord) – The CNAME record in the record set.
soa_record (SoaRecord) – The SOA record in the record set.
caa_records (list[CaaRecord]) – The list of CAA records in the record set.

Keyword Arguments

etag (str) – The etag of the record set.
metadata (dict[str, str]) – The metadata attached to the record set.
ttl (int) – The TTL (time-to-live) of the records in the record set.
target_resource (SubResource) – A reference to an azure resource from where the dns resource value is taken.
a_records (list[ARecord]) – The list of A records in the record set.
aaaa_records (list[AaaaRecord]) – The list of AAAA records in the record set.
mx_records (list[MxRecord]) – The list of MX records in the record set.
ns_records (list[NsRecord]) – The list of NS records in the record set.
ptr_records (list[PtrRecord]) – The list of PTR records in the record set.
srv_records (list[SrvRecord]) – The list of SRV records in the record set.
txt_records (list[TxtRecord]) – The list of TXT records in the record set.
cname_record (CnameRecord) – The CNAME record in the record set.
soa_record (SoaRecord) – The SOA record in the record set.
caa_records (list[CaaRecord]) – The list of CAA records in the record set.

class azure.mgmt.dns.v2018_05_01.models.RecordSetListResult(*, value: Optional[List[_models.RecordSet]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

The response to a record set List operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RecordSet]) – Information about the record sets in the response.
next_link (str) – The continuation token for the next page of results.

Keyword Arguments

value (list[RecordSet]) – Information about the record sets in the response.

class azure.mgmt.dns.v2018_05_01.models.RecordSetUpdateParameters(*, record_set: Optional[_models.RecordSet] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Parameters supplied to update a record set.

Variables: record_set (RecordSet) – Specifies information about the record set being updated.
Keyword Arguments: record_set (RecordSet) – Specifies information about the record set being updated.

class azure.mgmt.dns.v2018_05_01.models.RecordType(value)[source]¶

Bases: str, enum.Enum

RecordType.

A = 'A'¶

AAAA = 'AAAA'¶

CAA = 'CAA'¶

CNAME = 'CNAME'¶

MX = 'MX'¶

NS = 'NS'¶

PTR = 'PTR'¶

SOA = 'SOA'¶

SRV = 'SRV'¶

TXT = 'TXT'¶

class azure.mgmt.dns.v2018_05_01.models.Resource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Common properties of an Azure Resource Manager resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.dns.v2018_05_01.models.SoaRecord(*, host: Optional[str] = None, email: Optional[str] = None, serial_number: Optional[int] = None, refresh_time: Optional[int] = None, retry_time: Optional[int] = None, expire_time: Optional[int] = None, minimum_ttl: Optional[int] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An SOA record.

Variables

host (str) – The domain name of the authoritative name server for this SOA record.
email (str) – The email contact for this SOA record.
serial_number (int) – The serial number for this SOA record.
refresh_time (int) – The refresh value for this SOA record.
retry_time (int) – The retry time for this SOA record.
expire_time (int) – The expire time for this SOA record.
minimum_ttl (int) – The minimum value for this SOA record. By convention this is used to determine the negative caching duration.

Keyword Arguments

host (str) – The domain name of the authoritative name server for this SOA record.
email (str) – The email contact for this SOA record.
serial_number (int) – The serial number for this SOA record.
refresh_time (int) – The refresh value for this SOA record.
retry_time (int) – The retry time for this SOA record.
expire_time (int) – The expire time for this SOA record.
minimum_ttl (int) – The minimum value for this SOA record. By convention this is used to determine the negative caching duration.

class azure.mgmt.dns.v2018_05_01.models.SrvRecord(*, priority: Optional[int] = None, weight: Optional[int] = None, port: Optional[int] = None, target: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

An SRV record.

Variables

priority (int) – The priority value for this SRV record.
weight (int) – The weight value for this SRV record.
port (int) – The port value for this SRV record.
target (str) – The target domain name for this SRV record.

Keyword Arguments

priority (int) – The priority value for this SRV record.
weight (int) – The weight value for this SRV record.
port (int) – The port value for this SRV record.
target (str) – The target domain name for this SRV record.

class azure.mgmt.dns.v2018_05_01.models.SubResource(*, id: Optional[str] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

A reference to a another resource.

Variables: id (str) – Resource Id.
Keyword Arguments: id (str) – Resource Id.

class azure.mgmt.dns.v2018_05_01.models.TxtRecord(*, value: Optional[List[str]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

A TXT record.

Variables: value (list[str]) – The text value of this TXT record.
Keyword Arguments: value (list[str]) – The text value of this TXT record.

class azure.mgmt.dns.v2018_05_01.models.Zone(*, location: str, tags: Optional[Dict[str, str]] = None, etag: Optional[str] = None, zone_type: Union[str, _models.ZoneType] = 'Public', registration_virtual_networks: Optional[List[_models.SubResource]] = None, resolution_virtual_networks: Optional[List[_models.SubResource]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns.v2018_05_01.models._models_py3.Resource

Describes a DNS zone.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
etag (str) – The etag of the zone.
max_number_of_record_sets (int) – The maximum number of record sets that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
max_number_of_records_per_record_set (int) – The maximum number of records per record set that can be created in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
number_of_record_sets (int) – The current number of record sets in this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
name_servers (list[str]) – The name servers for this DNS zone. This is a read-only property and any attempt to set this value will be ignored.
zone_type (str or ZoneType) – The type of this DNS zone (Public or Private). Known values are: “Public” and “Private”.
registration_virtual_networks (list[SubResource]) – A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
resolution_virtual_networks (list[SubResource]) – A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.

Keyword Arguments

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
etag (str) – The etag of the zone.
zone_type (str or ZoneType) – The type of this DNS zone (Public or Private). Known values are: “Public” and “Private”.
registration_virtual_networks (list[SubResource]) – A list of references to virtual networks that register hostnames in this DNS zone. This is a only when ZoneType is Private.
resolution_virtual_networks (list[SubResource]) – A list of references to virtual networks that resolve records in this DNS zone. This is a only when ZoneType is Private.

class azure.mgmt.dns.v2018_05_01.models.ZoneListResult(*, value: Optional[List[_models.Zone]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

The response to a Zone List or ListAll operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[Zone]) – Information about the DNS zones.
next_link (str) – The continuation token for the next page of results.

Keyword Arguments

value (list[Zone]) – Information about the DNS zones.

class azure.mgmt.dns.v2018_05_01.models.ZoneType(value)[source]¶

Bases: str, enum.Enum

The type of this DNS zone (Public or Private).

PRIVATE = 'Private'¶

PUBLIC = 'Public'¶

class azure.mgmt.dns.v2018_05_01.models.ZoneUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs: Any)[source]¶

Bases: azure.mgmt.dns._serialization.Model

Describes a request to update a DNS zone.

Variables: tags (dict[str, str]) – Resource tags.
Keyword Arguments: tags (dict[str, str]) – Resource tags.