ansible / ansible.builtin / v2.9.17 / module / azure_rm_virtualmachineextension Managed Azure Virtual Machine extension | "added in version" 2.4 of ansible.builtin" Authors: Sertac Ozercan (@sozercan), Julien Stroheker (@julienstroheker) preview | supported by communityansible.builtin.azure_rm_virtualmachineextension (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update and delete Azure Virtual Machine Extension.
Note that this module was called M(azure_rm_virtualmachine_extension) before Ansible 2.8. The usage did not change.
- 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
name: description: - Name of the vm extension. required: true state: choices: - absent - present default: present description: - State of the vm extension. Use C(present) to create or update a vm extension and C(absent) to delete a vm extension. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Valid Azure location. Defaults to location of the resource group. password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str settings: description: - Json formatted public settings for the extension. client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str publisher: description: - The name of the extension handler publisher. api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Name of a resource group where the vm extension exists or will be created. required: true subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection protected_settings: description: - Json formatted protected settings for the extension. cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection type_handler_version: description: - The type version of the extension handler. virtual_machine_name: description: - The name of the virtual machine where the extension should be create or updated. auto_upgrade_minor_version: description: - Whether the extension handler should be automatically upgraded across minor versions. type: bool virtual_machine_extension_type: description: - The type of the extension handler.
changed: description: - Whether or not the resource has changed. returned: always sample: true type: bool state: description: - Current state of the vm extension. returned: always sample: state: Deleted type: dict