W3cubDocs

/Ansible

azure.azcollection.azure_rm_availabilityset – Manage Azure Availability Set

Note

This plugin is part of the azure.azcollection collection (version 1.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_availabilityset.

New in version 0.1.2: of azure.azcollection

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

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

The below requirements are needed on the host that executes this module.

python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	Choices/Defaults	Comments
ad_user string		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 0.0.1 of azure.azcollection		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 0.0.1 of azure.azcollection	Default: "latest"	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags boolean	Choices: no yes ←	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.
auth_source string added in 0.0.1 of azure.azcollection	Choices: auto ← cli credential_file env msi	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6.
cert_validation_mode string added in 0.0.1 of azure.azcollection	Choices: ignore validate	Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection	Default: "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 string		Valid Azure location. Defaults to location of the resource group.
log_mode string		Parent argument.
log_path string		Parent argument.
name string / required		Name of the availability set.
password string		Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
platform_fault_domain_count integer	Default: 3	Fault domains define the group of virtual machines that share a common power source and network switch. Should be between `1` and `3`.
platform_update_domain_count integer	Default: 5	Update domains indicate groups of virtual machines and underlying physical hardware that can be rebooted at the same time.
profile string		Security profile found in ~/.azure/credentials file.
proximity_placement_group string		The proximity placement group that the availability set should be assigned to.
resource_group string / required		Name of a resource group where the availability set exists or will be created.
secret string		Azure client secret. Use when authenticating with a Service Principal.
sku string	Choices: Classic ← Aligned	Define if the availability set supports managed disks.
state string	Choices: 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 string		Your Azure subscription Id.
tags dictionary		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. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources.
tenant string		Azure tenant ID. Use when authenticating with a Service Principal.

Notes

Note

For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
Authentication is also 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.

Examples

- name: Create an availability set with default options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup

- name: Create an availability set with advanced options
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    platform_update_domain_count: 5
    platform_fault_domain_count: 3
    proximity_placement_group: myProximityPlacementGroup
    sku: Aligned

- name: Delete an availability set
  azure_rm_availabilityset:
    name: myAvailabilitySet
    location: eastus
    resource_group: myResourceGroup
    state: absent

Return Values

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

Key		Returned	Description
changed boolean		always	Whether or not the resource has changed Sample: True
state complex		always	Current state of the availability set.
	id string	success	Resource ID. Sample: /subscriptions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/availabilitySets/myavailabilityset2
	location string	success	Location where the resource lives. Sample: eastus
	name string	success	Resource name. Sample: myavailabilityset2
	platform_fault_domain_count integer	success	Fault domains values. Sample: 2
	platform_update_domain_count integer	success	Update domains values. Sample: 5
	proximity_placement_group string	success	The proximity placement group that the availability is assigned to. Sample: myProximityPlacementGroup
	sku string	success	The availability set supports managed disks. Sample: Aligned
	tags dictionary	success	Resource tags. Sample: {'env': 'sandbox'}

Authors

Julien Stroheker (@julienstroheker)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_availabilityset_module.html