Documentation

azure_rm_availabilityset - Manage Azure availability set.

New in version 2.4.

Synopsis

  • Create, update and delete Azure availability set. An availability set cannot be updated, you will have to recreate one instead. The only update operation will be for the tags.

Requirements (on host that executes module)

  • python >= 2.7
  • azure >= 2.0.0

Options

parameter required default choices comments
ad_user
no
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
append_tags
no True
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
client_id
no
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
no AzureCloud
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
location
no resource_group location
Valid azure location. Defaults to location of the resource group.
name
yes
Name of the availability set.
password
no
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
platform_fault_domain_count
no 3
Fault domains define the group of virtual machines that share a common power source and network switch. Should be between 1 and 3. Default is 3
platform_update_domain_count
no 5
Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time. Default is 5.
profile
no
Security profile found in ~/.azure/credentials file.
resource_group
yes
Name of a resource group where the availability set exists or will be created.
secret
no
Azure client secret. Use when authenticating with a Service Principal.
sku
no Classic
  • Classic
  • Aligned
Define if the availability set supports managed disks.
state
no present
  • absent
  • present
Assert the state of the availability set. Use 'present' to create or update a availability set and 'absent' to delete a availability set.
subscription_id
no
Your Azure subscription Id.
tags
no
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
tenant
no
Azure tenant ID. Use when authenticating with a Service Principal.

Examples

- name: Create an availability set with default options
  azure_rm_availabilityset:
    name: myavailabilityset
    location: eastus
    resource_group: Testing

- name: Create an availability set with advanced options
  azure_rm_availabilityset:
    name: myavailabilityset
    location: eastus
    resource_group: Testing
    platform_update_domain_count: 5
    platform_fault_domain_count: 3
    sku: Aligned

- name: Delete an availability set
  azure_rm_availabilityset:
    name: myavailabilityset
    location: eastus
    resource_group: Testing
    state: absent

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
state
Current state of the avaibility set
always dict
changed
Whether or not the resource has changed
always bool


Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.