azure.azcollection.azure_rm_virtualmachineextension – Managed Azure Virtual Machine extension¶
Note
This plugin is part of the azure.azcollection collection (version 1.5.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_virtualmachineextension
.
New in version 0.1.2: of azure.azcollection
Synopsis¶
Create, update and delete Azure Virtual Machine Extension.
Note that this module was called azure_rm_virtualmachine_extension before Ansible 2.8. The usage did not change.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
azure >= 2.0.0
Parameters¶
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.
See Also¶
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
Examples¶
- name: Create VM Extension
azure_rm_virtualmachineextension:
name: myvmextension
location: eastus
resource_group: myResourceGroup
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_virtualmachineextension:
name: myvmextension
location: eastus
resource_group: myResourceGroup
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
boolean
|
always |
Whether or not the resource has changed.
Sample:
True
|
state
dictionary
|
always |
Current state of the vm extension.
Sample:
{'state': 'Deleted'}
|
Authors¶
Sertac Ozercan (@sozercan)
Julien Stroheker (@julienstroheker)