azure.mgmt.privatedns.operations module

class azure.mgmt.privatedns.operations.PrivateZonesOperations(client, config, serializer, deserializer)[source]

Bases: object

PrivateZonesOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-09-01”.

create_or_update(resource_group_name, private_zone_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a Private DNS zone. Does not modify Links to virtual networks or DNS records within the zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • parameters (PrivateZone) – Parameters supplied to the CreateOrUpdate operation.

  • if_match (str) – The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

  • if_none_match (str) – Set to ‘*’ to allow a new Private DNS zone to be created, but to prevent updating an existing zone. Other values will be ignored.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PrivateZone or ClientRawResponse<PrivateZone> if raw==True

Return type

AzureOperationPoller[PrivateZone] or AzureOperationPoller[ClientRawResponse[PrivateZone]]

Raises

CloudError

delete(resource_group_name, private_zone_name, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a Private DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • if_match (str) – The ETag of the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, private_zone_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Private DNS zone. Retrieves the zone properties, but not the virtual networks links or the record sets within the zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

PrivateZone or ClientRawResponse if raw=true

Return type

PrivateZone or ClientRawResponse

Raises

CloudError

list(top=None, custom_headers=None, raw=False, **operation_config)[source]

Lists the Private DNS zones in all resource groups in a subscription.

Parameters

  • top (int) – The maximum number of Private DNS zones to return. If not specified, returns up to 100 zones.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateZone

Return type

PrivateZonePaged[PrivateZone]

Raises

CloudError

list_by_resource_group(resource_group_name, top=None, custom_headers=None, raw=False, **operation_config)[source]

Lists the Private DNS zones within a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of PrivateZone

Return type

PrivateZonePaged[PrivateZone]

Raises

CloudError

update(resource_group_name, private_zone_name, parameters, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates a Private DNS zone. Does not modify virtual network links or DNS records within the zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • parameters (PrivateZone) – Parameters supplied to the Update operation.

  • if_match (str) – The ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns PrivateZone or ClientRawResponse<PrivateZone> if raw==True

Return type

AzureOperationPoller[PrivateZone] or AzureOperationPoller[ClientRawResponse[PrivateZone]]

Raises

CloudError

models = <module 'azure.mgmt.privatedns.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-privatedns/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/privatedns/models/__init__.py'>
class azure.mgmt.privatedns.operations.VirtualNetworkLinksOperations(client, config, serializer, deserializer)[source]

Bases: object

VirtualNetworkLinksOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-09-01”.

create_or_update(resource_group_name, private_zone_name, virtual_network_link_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Creates or updates a virtual network link to the specified Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • virtual_network_link_name (str) – The name of the virtual network link.

  • parameters (VirtualNetworkLink) – Parameters supplied to the CreateOrUpdate operation.

  • if_match (str) – The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

  • if_none_match (str) – Set to ‘*’ to allow a new virtual network link to the Private DNS zone to be created, but to prevent updating an existing link. Other values will be ignored.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkLink or ClientRawResponse<VirtualNetworkLink> if raw==True

Return type

AzureOperationPoller[VirtualNetworkLink] or AzureOperationPoller[ClientRawResponse[VirtualNetworkLink]]

Raises

CloudError

delete(resource_group_name, private_zone_name, virtual_network_link_name, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a virtual network link to the specified Private DNS zone. WARNING: In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • virtual_network_link_name (str) – The name of the virtual network link.

  • if_match (str) – The ETag of the virtual network link to the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, private_zone_name, virtual_network_link_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a virtual network link to the specified Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • virtual_network_link_name (str) – The name of the virtual network link.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

VirtualNetworkLink or ClientRawResponse if raw=true

Return type

VirtualNetworkLink or ClientRawResponse

Raises

CloudError

list(resource_group_name, private_zone_name, top=None, custom_headers=None, raw=False, **operation_config)[source]

Lists the virtual network links to the specified Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • top (int) – The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of VirtualNetworkLink

Return type

VirtualNetworkLinkPaged[VirtualNetworkLink]

Raises

CloudError

update(resource_group_name, private_zone_name, virtual_network_link_name, parameters, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Updates a virtual network link to the specified Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • virtual_network_link_name (str) – The name of the virtual network link.

  • parameters (VirtualNetworkLink) – Parameters supplied to the Update operation.

  • if_match (str) – The ETag of the virtual network link to the Private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns VirtualNetworkLink or ClientRawResponse<VirtualNetworkLink> if raw==True

Return type

AzureOperationPoller[VirtualNetworkLink] or AzureOperationPoller[ClientRawResponse[VirtualNetworkLink]]

Raises

CloudError

models = <module 'azure.mgmt.privatedns.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-privatedns/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/privatedns/models/__init__.py'>
class azure.mgmt.privatedns.operations.RecordSetsOperations(client, config, serializer, deserializer)[source]

Bases: object

RecordSetsOperations operations.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – Client Api Version. Constant value: “2018-09-01”.

create_or_update(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match=None, if_none_match=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • 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 Private DNS zone is created). Possible values include: ‘A’, ‘AAAA’, ‘CNAME’, ‘MX’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

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

  • parameters (RecordSet) – Parameters supplied to the CreateOrUpdate operation.

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

delete(resource_group_name, private_zone_name, record_type, relative_record_set_name, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • 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 Private DNS zone is deleted). Possible values include: ‘A’, ‘AAAA’, ‘CNAME’, ‘MX’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

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

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, private_zone_name, record_type, relative_record_set_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a record set.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • record_type (str or RecordType) – The type of DNS record in this record set. Possible values include: ‘A’, ‘AAAA’, ‘CNAME’, ‘MX’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

list(resource_group_name, private_zone_name, top=None, recordsetnamesuffix=None, custom_headers=None, raw=False, **operation_config)[source]

Lists all record sets in a Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

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

  • 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>”.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecordSet

Return type

RecordSetPaged[RecordSet]

Raises

CloudError

list_by_type(resource_group_name, private_zone_name, record_type, top=None, recordsetnamesuffix=None, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • record_type (str or RecordType) – The type of record sets to enumerate. Possible values include: ‘A’, ‘AAAA’, ‘CNAME’, ‘MX’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

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

  • 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>”.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

An iterator like instance of RecordSet

Return type

RecordSetPaged[RecordSet]

Raises

CloudError

update(resource_group_name, private_zone_name, record_type, relative_record_set_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[source]

Updates a record set within a Private DNS zone.

Parameters

  • resource_group_name (str) – The name of the resource group.

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

  • record_type (str or RecordType) – The type of DNS record in this record set. Possible values include: ‘A’, ‘AAAA’, ‘CNAME’, ‘MX’, ‘PTR’, ‘SOA’, ‘SRV’, ‘TXT’

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

  • parameters (RecordSet) – Parameters supplied to the Update operation.

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

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

RecordSet or ClientRawResponse if raw=true

Return type

RecordSet or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.privatedns.models' from '/home/vsts/work/1/s/sdk/network/azure-mgmt-privatedns/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/privatedns/models/__init__.py'>