states.azurerm.compute.dedicated_host_group

Azure Resource Manager (ARM) Compute Dedicated Host 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.dedicated_host_group.absent(hub, ctx, name, resource_group, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensures the specified dedicated host group does not exist.

Parameters:
  • name – The name of the dedicated host 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 dedicated host group absent:
    azurerm.compute.dedicated_host_group.absent:
        - name: test_dhg
        - resource_group: test_rg
idem_azurerm.states.azurerm.compute.dedicated_host_group.present(hub, ctx, name, resource_group, platform_fault_domain_count, zone=None, tags=None, connection_auth=None, **kwargs)

New in version 4.0.0.

Ensures the dedicated host group exists.

Parameters:
  • name – The name of the dedicated host group.
  • resource_group – The name of the resource group name assigned to the dedicated host group.
  • platform_fault_domain_count – The number of fault domains that the host group can span. This value cannot be changed after creation. Must be an integer between 1 and 5.
  • zone – The Availability Zone to use for this host group. The zone can only be assigned during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone.
  • tags – A dictionary of strings can be passed as tag metadata to the dedicate host group resource object.
  • connection_auth – A dict with subscription and authentication parameters to be used in connecting to the Azure Resource Manager API.

Example usage:

Ensure dedicated host group exists:
    azurerm.compute.dedicate_host_group.present:
        - name: test_host_group
        - resource_group: test_group
        - platform_fault_domain_count: 1
        - tags:
            contact_name: Elmer Fudd Gantry