exec.azurerm.compute.availability_set

Azure Resource Manager (ARM) Compute Availability Set Execution Module

New in version 1.0.0.

Changed 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.availability_set.create_or_update(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Create or update an availability set.

Parameters:
  • name – The availability set to create.
  • resource_group – The resource group name assigned to the availability set.

CLI Example:

azurerm.compute.availability_set.create_or_update testset testgroup
idem_azurerm.exec.azurerm.compute.availability_set.delete(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Delete an availability set.

Parameters:
  • name – The availability set to delete.
  • resource_group – The resource group name assigned to the availability set.

CLI Example:

azurerm.compute.availability_set.delete testset testgroup
idem_azurerm.exec.azurerm.compute.availability_set.get(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

Get a dictionary representing an availability set’s properties.

Parameters:
  • name – The availability set to get.
  • resource_group – The resource group name assigned to the availability set.

CLI Example:

azurerm.compute.availability_set.get testset testgroup
idem_azurerm.exec.azurerm.compute.availability_set.list_(hub, ctx, resource_group=None, **kwargs)

New in version 1.0.0.

Changed in version 4.0.0.

Lists all availability sets in a subscription.

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

CLI Example:

azurerm.compute.availability_set.list
idem_azurerm.exec.azurerm.compute.availability_set.list_available_sizes(hub, ctx, name, resource_group, **kwargs)

New in version 1.0.0.

List all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.

Parameters:
  • name – The availability set name to list available virtual machine sizes within.
  • resource_group – The resource group name to list available availability set sizes within.

CLI Example:

azurerm.compute.availability_set.list_available_sizes testset testgroup