azure_rm_virtualmachineextension – Managed Azure Virtual Machine extension
azure_rm_virtualmachineextension – Managed Azure Virtual Machine extension
New in version 2.4.
Synopsis
- Create, update and delete Azure Virtual Machine Extension
Aliases: azure_rm_virtualmachine_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 string |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | |
adfs_authority_url string added in 2.6 |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 2.5 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
auth_source string added in 2.5 |
|
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
When set to Can also be set via the When set to The |
auto_upgrade_minor_version boolean |
|
Whether the extension handler should be automatically upgraded across minor versions. |
cert_validation_mode string added in 2.5 |
|
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string 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, |
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 string |
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 string |
Azure client secret. Use when authenticating with a Service Principal. | |
settings - |
Json formatted public settings for the extension. | |
state - |
|
Assert the state of the vm extension. Use |
subscription_id string |
Your Azure subscription Id. | |
tenant string |
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
- This module was called
azure_rm_virtualmachine_extension
before Ansible 2.8. The usage did not change. - 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
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
|
state dictionary |
always |
Current state of the vm extension
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Sertac Ozercan (@sozercan)
- Julien Stroheker (@julienstroheker)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_virtualmachineextension_module.html