exec.azurerm.network.network_profile

Azure Resource Manager (ARM) Network Profile Execution Module

New in version 3.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.network_profile.create_or_update(hub, ctx, name, resource_group, container_network_interfaces=None, container_network_interface_configurations=None, tags=None, **kwargs)

New in version 3.0.0.

Creates or updates a network profile.

Parameters:

CLI Example:

azurerm.network.network_profile.create_or_update myprofile mygroup
idem_azurerm.exec.azurerm.network.network_profile.delete(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Deletes the specified network profile.

Parameters:
  • name – The name of the network profile.
  • resource_group – The name of the resource group to which the network profile belongs.

CLI Example:

azurerm.network.network_profile.delete myprofile mygroup
idem_azurerm.exec.azurerm.network.network_profile.get(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Gets the specified network profile in a specified resource group.

Parameters:
  • name – The name of the network profile.
  • resource_group – The name of the resource group to which the network profile belongs.

CLI Example:

azurerm.network.network_profile.get myprofile mygroup
idem_azurerm.exec.azurerm.network.network_profile.list_(hub, ctx, resource_group=None, **kwargs)

New in version 3.0.0.

Gets all network profiles in a resource group or subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.network.network_profile.list
idem_azurerm.exec.azurerm.network.network_profile.update_tags(hub, ctx, name, resource_group, tags=None, **kwargs)

New in version 3.0.0.

Updates network profile tags with specified values.

Parameters:
  • name – The name of the network profile.
  • resource_group – The name of the resource group to which the network profile belongs.
  • tags – The tags of the resource.

CLI Example:

azurerm.network.network_profile.update_tags myprofile mygroup tags='{"owner": "me"}'