states.azurerm.compute.proximity_placement_group

Azure Resource Manager (ARM) Compute Proximity Placement Group State Module

New in version 4.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed via acct. Note that the authentication parameters are case sensitive.

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

Example acct setup for Azure Resource Manager authentication:

azurerm:
    default:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        tenant: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        client_id: ABCDEFAB-1234-ABCD-1234-ABCDEFABCDEF
        secret: XXXXXXXXXXXXXXXXXXXXXXXX
        cloud_environment: AZURE_PUBLIC_CLOUD
    user_pass_auth:
        subscription_id: 3287abc8-f98a-c678-3bde-326766fd3617
        username: fletch
        password: 123pass

The authentication parameters can also be passed as a dictionary of keyword arguments to the connection_auth parameter of each state, but this is not preferred and could be deprecated in the future.
idem_azurerm.states.azurerm.compute.proximity_placement_group.absent(hub, ctx, name, resource_group, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensures the specified proximity placement group does not exist.

Parameters:
  • name – The name of the proximity placement group.
  • resource_group – The name of the resource group.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure proximity placement group absent:
    azurerm.compute.proximity_placement_group.absent:
        - name: test_ppg
        - resource_group: test_group
idem_azurerm.states.azurerm.compute.proximity_placement_group.present(hub, ctx, name, resource_group, group_type='standard', tags=None, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensures the specified proximity placement group exists.

Parameters:
  • name – The name of the proximity placement group.
  • resource_group – The name of the resource group.
  • group_type – The type of the proximity placement group. Possible values include: “standard”, “ultra”. Defaults to “standard”.
  • tags – A dictionary of strings can be passed as tag metadata to the proximity placement group object.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure proximity placement group exists:
    azurerm.compute.proximity_placement_group.present:
        - name: test_ppg
        - resource_group: test_group
        - group_type: test_type
        - tags:
            contact_name: Elmer Fudd Gantry