Documentation

azure_rm_virtualmachine_extension - Managed Azure Virtual Machine extension

New in version 2.4.

Synopsis

  • Create, update and delete Azure Virtual Machine Extension

Requirements

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

  • python >= 2.7
  • azure >= 2.0.0

Parameters

Parameter Choices/Defaults Comments
ad_user
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
(added in 2.6)
Default:
None
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
(added in 2.5)
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.
auth_source
(added in 2.5)
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.
When set to cli, the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
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.
auto_upgrade_minor_version
bool
    Choices:
  • no
  • yes
Whether the extension handler should be automatically upgraded across minor versions.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
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
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
(added in 2.4)
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
Valid azure location. Defaults to location of the resource group.
name
required
Name of the vm extension
password
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
Security profile found in ~/.azure/credentials file.
protected_settings
Json formatted protected settings for the extension.
publisher
The name of the extension handler publisher.
resource_group
required
Name of a resource group where the vm extension exists or will be created.
secret
Azure client secret. Use when authenticating with a Service Principal.
settings
Json formatted public settings for the extension.
state
    Choices:
  • absent
  • present ←
Assert the state of the vm extension. Use 'present' to create or update a vm extension and 'absent' to delete a vm extension.
subscription_id
Your Azure subscription Id.
tenant
Azure tenant ID. Use when authenticating with a Service Principal.
type_handler_version
The type version of the extension handler.
virtual_machine_extension_type
The type of the extension handler.
virtual_machine_name
The name of the virtual machine where the extension should be create or updated.

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.

Examples

- name: Create VM Extension
  azure_rm_virtualmachine_extension:
    name: myvmextension
    location: eastus
    resource_group: Testing
    virtual_machine_name: myvm
    publisher: Microsoft.Azure.Extensions
    virtual_machine_extension_type: CustomScript
    type_handler_version: 2.0
    settings: '{"commandToExecute": "hostname"}'
    auto_upgrade_minor_version: true

- name: Delete VM Extension
  azure_rm_virtualmachine_extension:
    name: myvmextension
    location: eastus
    resource_group: Testing
    virtual_machine_name: myvm
    state: absent

Return Values

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

Key Returned Description
changed
bool
always
Whether or not the resource has changed

state
dict
always
Current state of the vm extension



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Sertac Ozercan (@sozercan)
  • Julien Stroheker (@julienstroheker)

Hint

If you notice any issues in this documentation you can edit this document to improve it.