azure.mgmt.privatedns.models module¶

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

Bases: azure.mgmt.privatedns._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.privatedns.models.AaaaRecord(*, ipv6_address: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.CloudErrorBody(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, details: Optional[List[_models.CloudErrorBody]] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.CnameRecord(*, cname: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.MxRecord(*, preference: Optional[int] = None, exchange: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.PrivateZone(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns.models._models_py3.TrackedResource

Describes a Private DNS zone.

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.
tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.
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 Private 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 Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
max_number_of_virtual_network_links (int) – The maximum number of virtual networks that can be linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
number_of_virtual_network_links (int) – The current number of virtual networks that are linked to this Private DNS zone. This is a read-only property and any attempt to set this value will be ignored.
max_number_of_virtual_network_links_with_registration (int) – The maximum number of virtual networks that can be linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
number_of_virtual_network_links_with_registration (int) – The current number of virtual networks that are linked to this Private DNS zone with registration enabled. This is a read-only property and any attempt to set this value will be ignored.
provisioning_state (str or ProvisioningState) – The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “Canceled”.
internal_id (str) – Private zone internal Id.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.
etag (str) – The ETag of the zone.

class azure.mgmt.privatedns.models.PrivateZoneListResult(*, value: Optional[List[_models.PrivateZone]] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._serialization.Model

The response to a Private DNS zone list operation.

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

Variables

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

Keyword Arguments

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

class azure.mgmt.privatedns.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.

CANCELED = 'Canceled'¶

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.privatedns.models.ProxyResource(**kwargs)[source]¶

Bases: azure.mgmt.privatedns.models._models_py3.Resource

The resource model definition for an ARM proxy resource.

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.

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

Bases: azure.mgmt.privatedns._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.privatedns.models.RecordSet(*, etag: Optional[str] = None, metadata: Optional[Dict[str, str]] = None, ttl: Optional[int] = None, a_records: Optional[List[_models.ARecord]] = None, aaaa_records: Optional[List[_models.AaaaRecord]] = None, cname_record: Optional[_models.CnameRecord] = None, mx_records: Optional[List[_models.MxRecord]] = None, ptr_records: Optional[List[_models.PtrRecord]] = None, soa_record: Optional[_models.SoaRecord] = None, srv_records: Optional[List[_models.SrvRecord]] = None, txt_records: Optional[List[_models.TxtRecord]] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns.models._models_py3.ProxyResource

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

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.
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.
is_auto_registered (bool) – Is the record set auto-registered in the Private DNS zone through a virtual network link?.
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.
cname_record (CnameRecord) – The CNAME record in the record set.
mx_records (list[MxRecord]) – The list of MX records in the record set.
ptr_records (list[PtrRecord]) – The list of PTR records in the record set.
soa_record (SoaRecord) – The SOA record 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.

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.
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.
cname_record (CnameRecord) – The CNAME record in the record set.
mx_records (list[MxRecord]) – The list of MX records in the record set.
ptr_records (list[PtrRecord]) – The list of PTR records in the record set.
soa_record (SoaRecord) – The SOA record 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.

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

Bases: azure.mgmt.privatedns._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.privatedns.models.RecordType(value)[source]¶

Bases: str, enum.Enum

RecordType.

A = 'A'¶

AAAA = 'AAAA'¶

CNAME = 'CNAME'¶

MX = 'MX'¶

PTR = 'PTR'¶

SOA = 'SOA'¶

SRV = 'SRV'¶

TXT = 'TXT'¶

class azure.mgmt.privatedns.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.privatedns._serialization.Model

The core properties of ARM resources.

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.

class azure.mgmt.privatedns.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)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.SrvRecord(*, priority: Optional[int] = None, weight: Optional[int] = None, port: Optional[int] = None, target: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._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.privatedns.models.SubResource(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._serialization.Model

Reference to another subresource.

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

class azure.mgmt.privatedns.models.TrackedResource(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns.models._models_py3.Resource

The resource model definition for a ARM tracked top level resource.

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.
tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.

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

Bases: azure.mgmt.privatedns._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.privatedns.models.VirtualNetworkLink(*, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, etag: Optional[str] = None, virtual_network: Optional[_models.SubResource] = None, registration_enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns.models._models_py3.TrackedResource

Describes a link to virtual network for a Private DNS zone.

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

Variables

id (str) – Fully qualified resource Id for the resource. Example - ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateDnsZones/{privateDnsZoneName}’.
name (str) – The name of the resource.
type (str) – The type of the resource. Example - ‘Microsoft.Network/privateDnsZones’.
tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.
etag (str) – The ETag of the virtual network link.
virtual_network (SubResource) – The reference of the virtual network.
registration_enabled (bool) – Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?.
virtual_network_link_state (str or VirtualNetworkLinkState) – The status of the virtual network link to the Private DNS zone. Possible values are ‘InProgress’ and ‘Done’. This is a read-only property and any attempt to set this value will be ignored. Known values are: “InProgress” and “Completed”.
provisioning_state (str or ProvisioningState) – The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. Known values are: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, and “Canceled”.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
location (str) – The Azure Region where the resource lives.
etag (str) – The ETag of the virtual network link.
virtual_network (SubResource) – The reference of the virtual network.
registration_enabled (bool) – Is auto-registration of virtual machine records in the virtual network in the Private DNS zone enabled?.

class azure.mgmt.privatedns.models.VirtualNetworkLinkListResult(*, value: Optional[List[_models.VirtualNetworkLink]] = None, **kwargs)[source]¶

Bases: azure.mgmt.privatedns._serialization.Model

The response to a list virtual network link to Private DNS zone operation.

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

Variables

value (list[VirtualNetworkLink]) – Information about the virtual network links to the Private DNS zones.
next_link (str) – The continuation token for the next page of results.

Keyword Arguments

value (list[VirtualNetworkLink]) – Information about the virtual network links to the Private DNS zones.

class azure.mgmt.privatedns.models.VirtualNetworkLinkState(value)[source]¶

Bases: str, enum.Enum

The status of the virtual network link to the Private DNS zone. Possible values are ‘InProgress’ and ‘Done’. This is a read-only property and any attempt to set this value will be ignored.

COMPLETED = 'Completed'¶

IN_PROGRESS = 'InProgress'¶