Try SpotterManage Azure Virtual Machine Scale Set (VMSS) extensions
| "added in version" 2.8 of ansible.builtin"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, update and delete Azure Virtual Machine Scale Set (VMSS) extensions.
- 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
name:
description:
- Name of the VMSS extension.
type:
description:
- The type of the extension handler.
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the extension.
- Use C(present) to create or update an extension and C(absent) to delete it.
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:
- A dictionary containing extension settings.
- Settings depend on extension type.
- Refer to U(https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview)
for more information.
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
publisher:
description:
- The name of the extension handler publisher.
vmss_name:
description:
- The name of the virtual machine where the extension should be create or updated.
required: true
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 VMSS 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:
- A dictionary containing protected extension settings.
- Settings depend on extension type.
- Refer to U(https://docs.microsoft.com/en-us/azure/virtual-machines/extensions/overview)
for more information.
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.
auto_upgrade_minor_version:
description:
- Whether the extension handler should be automatically upgraded across minor versions.
type: bool
id: description: - VMSS extension resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset/extensions/myext type: str