exec.azurerm.compute.dedicated_host_group

Azure Resource Manager (ARM) Compute Dedicated Host Group Execution Module

New 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.compute.dedicated_host_group.create_or_update(hub, ctx, name, resource_group, platform_fault_domain_count, zone=None, tags=None, **kwargs)

New in version 4.0.0.

Create or update a dedicated host group. More information about Dedicated Host Groups can be found here.

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.
  • 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.

CLI Example:

azurerm.compute.dedicated_host_group.create_or_update test_name test_group
idem_azurerm.exec.azurerm.compute.dedicated_host_group.delete(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Delete a dedicated host group.

Parameters:
  • name – The dedicated host group to delete.
  • resource_group – The resource group name assigned to the dedicated host group.

CLI Example:

azurerm.compute.dedicated_host_group.delete test_name test_group
idem_azurerm.exec.azurerm.compute.dedicated_host_group.get(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Retrieves information about a dedicated host group.

Parameters:
  • name – The name of the dedicated host group to get.
  • resource_group – The resource group name assigned to the dedicated host group.

CLI Example:

azurerm.compute.dedicated_host_group.get test_name test_group
idem_azurerm.exec.azurerm.compute.dedicated_host_group.list_(hub, ctx, resource_group=None, **kwargs)

New in version 4.0.0.

Lists all of the dedicated host gorups in the subscription.

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

CLI Example:

azurerm.compute.dedicated_host_group.list