azure_rm_virtualmachinescalesetextension – Manage Azure Virtual Machine Scale Set (VMSS) extensions¶
New in version 2.8.
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  latestis appropriate for public clouds; future values will allow use with Azure Stack. | 
| 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  autoif variable is not defined.autowill 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_SOURCEenvironment variable.When set to  msi, the host machine must be an azure resource with an enabled MSI extension.subscription_idor the environment variableAZURE_SUBSCRIPTION_IDcan 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  msiwas added in Ansible 2.6. | 
| 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  ignore. Can also be set via credential file profile or theAZURE_CERT_VALIDATIONenvironment variable. | 
| 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,  AzureChinaCloud,AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or theAZURE_CLOUD_ENVIRONMENTenvironment variable. | 
| location 
                    -
                                                                 | Valid Azure location. Defaults to location of the resource group. | |
| name 
                    -
                                                                 | Name of the VMSS extension. | |
| password 
                    string
                                                                 | 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 
                    -
                                                                 | A dictionary containing protected extension settings. Settings depend on extension type. Refer to https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview for more information. | |
| publisher 
                    -
                                                                 | The name of the extension handler publisher. | |
| resource_group 
                    -
                                             / required                     | Name of a resource group where the VMSS extension exists or will be created. | |
| secret 
                    string
                                                                 | Azure client secret. Use when authenticating with a Service Principal. | |
| settings 
                    -
                                                                 | A dictionary containing extension settings. Settings depend on extension type. Refer to https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview for more information. | |
| state 
                    -
                                                                 | 
 | Assert the state of the extension. Use  presentto create or update an extension andabsentto delete it. | 
| subscription_id 
                    string
                                                                 | Your Azure subscription Id. | |
| tenant 
                    string
                                                                 | Azure tenant ID. Use when authenticating with a Service Principal. | |
| type 
                    -
                                                                 | The type of the extension handler. | |
| type_handler_version 
                    -
                                                                 | The type version of the extension handler. | |
| vmss_name 
                    -
                                             / required                     | 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, 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 logincommand.
Examples¶
- name: Install VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    publisher: Microsoft.Azure.Extensions
    type: CustomScript
    type_handler_version: 2.0
    settings: '{"commandToExecute": "hostname"}'
    auto_upgrade_minor_version: true
- name: Remove VMSS Extension
  azure_rm_virtualmachinescalesetextension:
    name: myvmssextension
    location: eastus
    resource_group: myResourceGroup
    vmss_name: myvm
    state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Zim Kalinowski (@zikalino)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
