exec.azurerm.compute.proximity_placement_group

Azure Resource Manager (ARM) Compute Proximity Placement 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.proximity_placement_group.create_or_update(hub, ctx, name, resource_group, group_type='standard', **kwargs)

New in version 4.0.0.

Create or update a proximity placement group.

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

CLI Example:

azurerm.compute.proximity_placement_group.create_or_update test_name test_rg test_type
idem_azurerm.exec.azurerm.compute.proximity_placement_group.delete(hub, ctx, name, resource_group, **kwargs)

New in version 4.0.0.

Delete a proximity placement group.

Parameters:
  • name – The name of the proximity placement group to delete.
  • resource_group – The name of the resource group.

CLI Example:

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

New in version 4.0.0.

Retrieves information about a proximity placement group.

Parameters:
  • name – The proximity placement group to query.
  • resource_group – The name of the resource group.

CLI Example:

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

New in version 4.0.0.

Lists all proximity placement groups in a subscription.

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

CLI Example:

azurerm.compute.proximity_placement_group.list