exec.azurerm.dns.zone

Azure Resource Manager (ARM) DNS Zone Execution Module

New in version 1.0.0.

Changed in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values:

  • AZURE_PUBLIC_CLOUD (default)
  • AZURE_CHINA_CLOUD
  • AZURE_US_GOV_CLOUD
  • AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.dns.zone.create_or_update(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Creates or updates a DNS zone. Does not modify DNS records within the zone.

Parameters:
  • name – The name of the DNS zone to create (without a terminating dot).
  • resource_group – The name of the resource group.

CLI Example:

azurerm.dns.zone.create_or_update myzone testgroup
idem_azurerm.exec.azurerm.dns.zone.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete a DNS zone within a resource group. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

Parameters:
  • name – The name of the DNS zone to delete.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.dns.zone.delete myzone testgroup
idem_azurerm.exec.azurerm.dns.zone.get(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get a dictionary representing a DNS zone’s properties, but not the record sets within the zone.

Parameters:
  • name – The DNS zone to get.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.dns.zone.get myzone testgroup
idem_azurerm.exec.azurerm.dns.zone.list_(hub, ctx, resource_group=None, top=None, **kwargs)

New in version 1.0.0.

Lists the DNS zones in a subscription.

Parameters:
  • resource_group – The name of the resource group to limit the results.
  • top – The maximum number of DNS zones to return. If not specified, returns up to 100 zones.

CLI Example:

azurerm.dns.zone.list