azure.mgmt.privatedns.operations module

class azure.mgmt.privatedns.operations.PrivateZonesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PrivateDnsManagementClient’s private_zones attribute.

begin_create_or_update(resource_group_name: str, private_zone_name: str, parameters: _models.PrivateZone, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateZone]

begin_create_or_update(resource_group_name: str, private_zone_name: str, parameters: IO, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateZone]

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

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

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

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

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

• 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 PrivateZone or the result of cls(response)

Return type

LROPoller[PrivateZone]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, private_zone_name: str, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

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

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

begin_update(resource_group_name: str, private_zone_name: str, parameters: _models.PrivateZone, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateZone]

begin_update(resource_group_name: str, private_zone_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateZone]

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

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

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

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

• 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 PrivateZone or the result of cls(response)

Return type

LROPoller[PrivateZone]

Raises

HttpResponseError –

get(resource_group_name: str, private_zone_name: str, **kwargs: Any) → azure.mgmt.privatedns.models._models_py3.PrivateZone

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

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

Keyword Arguments

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

Returns

PrivateZone or the result of cls(response)

Return type

PrivateZone

Raises

HttpResponseError –

list(top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.privatedns.models._models_py3.PrivateZone]

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. 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 PrivateZone or the result of cls(response)

Return type

ItemPaged[PrivateZone]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.privatedns.models._models_py3.PrivateZone]

Lists the Private DNS zones within a resource group.

Parameters

• resource_group_name (str) – The name of the resource group. 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 PrivateZone or the result of cls(response)

Return type

ItemPaged[PrivateZone]

Raises

HttpResponseError –

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

class azure.mgmt.privatedns.operations.RecordSetsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, private_zone_name: str, record_type: Union[str, _models.RecordType], relative_record_set_name: str, parameters: _models.RecordSet, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet

create_or_update(resource_group_name: str, private_zone_name: str, record_type: Union[str, _models.RecordType], relative_record_set_name: str, 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 Private DNS zone.

Parameters

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

• private_zone_name (str) – The name of the Private DNS zone (without a terminating dot). 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 Private DNS zone is created). Known values are: “A”, “AAAA”, “CNAME”, “MX”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

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

• parameters (RecordSet or IO) – Parameters supplied to the CreateOrUpdate operation. Is either a model 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, private_zone_name: str, record_type: Union[str, azure.mgmt.privatedns.models._private_dns_management_client_enums.RecordType], relative_record_set_name: str, if_match: Optional[str] = None, **kwargs: Any) → None

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

• private_zone_name (str) – The name of the Private DNS zone (without a terminating dot). 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 Private DNS zone is deleted). Known values are: “A”, “AAAA”, “CNAME”, “MX”, “PTR”, “SOA”, “SRV”, and “TXT”. Required.

• relative_record_set_name (str) – The name of the record set, relative to the name of the zone. 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, private_zone_name: str, record_type: Union[str, azure.mgmt.privatedns.models._private_dns_management_client_enums.RecordType], relative_record_set_name: str, **kwargs: Any) → azure.mgmt.privatedns.models._models_py3.RecordSet

Gets a record set.

Parameters

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

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

• record_type (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 (str) – The name of the record set, relative to the name of the zone. 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(resource_group_name: str, private_zone_name: str, top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.privatedns.models._models_py3.RecordSet]

Lists all record sets in a Private DNS zone.

Parameters

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

• private_zone_name (str) – The name of the Private 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 to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain 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, private_zone_name: str, record_type: Union[str, azure.mgmt.privatedns.models._private_dns_management_client_enums.RecordType], top: Optional[int] = None, recordsetnamesuffix: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.privatedns.models._models_py3.RecordSet]

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

Parameters

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

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

• record_type (str or RecordType) – The type of record sets to enumerate. Known values are: “A”, “AAAA”, “CNAME”, “MX”, “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 to be used to filter the record set enumeration. If this parameter is specified, the returned enumeration will only contain 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, private_zone_name: str, record_type: Union[str, _models.RecordType], relative_record_set_name: str, parameters: _models.RecordSet, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet

update(resource_group_name: str, private_zone_name: str, record_type: Union[str, _models.RecordType], relative_record_set_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RecordSet

Updates a record set within a Private DNS zone.

Parameters

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

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

• record_type (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 (str) – The name of the record set, relative to the name of the zone. Required.

• parameters (RecordSet or IO) – Parameters supplied to the Update operation. Is either a model 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.privatedns.models' from '/mnt/vss/_work/1/s/sdk/network/azure-mgmt-privatedns/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/privatedns/models/__init__.py'>

class azure.mgmt.privatedns.operations.VirtualNetworkLinksOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through PrivateDnsManagementClient’s virtual_network_links attribute.

begin_create_or_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: _models.VirtualNetworkLink, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkLink]

begin_create_or_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: IO, if_match: Optional[str] = None, if_none_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkLink]

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

Parameters

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

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

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

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

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

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

• 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 VirtualNetworkLink or the result of cls(response)

Return type

LROPoller[VirtualNetworkLink]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, if_match: Optional[str] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

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

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

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

begin_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: _models.VirtualNetworkLink, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkLink]

begin_update(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.VirtualNetworkLink]

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

Parameters

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

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

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

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

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

• 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 VirtualNetworkLink or the result of cls(response)

Return type

LROPoller[VirtualNetworkLink]

Raises

HttpResponseError –

get(resource_group_name: str, private_zone_name: str, virtual_network_link_name: str, **kwargs: Any) → azure.mgmt.privatedns.models._models_py3.VirtualNetworkLink

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

Parameters

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

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

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

Keyword Arguments

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

Returns

VirtualNetworkLink or the result of cls(response)

Return type

VirtualNetworkLink

Raises

HttpResponseError –

list(resource_group_name: str, private_zone_name: str, top: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.privatedns.models._models_py3.VirtualNetworkLink]

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

Parameters

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

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

• top (int) – The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links. 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 VirtualNetworkLink or the result of cls(response)

Return type

ItemPaged[VirtualNetworkLink]

Raises

HttpResponseError –

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