exec.azurerm.network.operations

Azure Resource Manager (ARM) Network Execution Module

New in version 1.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.network.operations.check_dns_name_availability(hub, ctx, name, region, **kwargs)

New in version 1.0.0.

Check whether a domain name in the current zone is available for use.

Parameters:
  • name – The DNS name to query.
  • region – The region to query for the DNS name in question.

CLI Example:

azurerm.network.check_dns_name_availability testdnsname westus
idem_azurerm.exec.azurerm.network.operations.check_ip_address_availability(hub, ctx, ip_address, virtual_network, resource_group, **kwargs)

New in version 1.0.0.

Check that a private ip address is available within the specified virtual network.

Parameters:
  • ip_address – The ip_address to query.
  • virtual_network – The virtual network to query for the IP address in question.
  • resource_group – The resource group name assigned to the virtual network.

CLI Example:

azurerm.network.check_ip_address_availability 10.0.0.4 testnet testgroup
idem_azurerm.exec.azurerm.network.operations.usages_list(hub, ctx, location, **kwargs)

New in version 1.0.0.

List subscription network usage for a location.

Parameters:location – The Azure location to query for network usage.

CLI Example:

azurerm.network.usages_list westus