azure.azcollection.azure_rm_virtualmachinescalesetinstance – Get Azure Virtual Machine Scale Set Instance facts

From Get docs
Ansible/docs/2.11/collections/azure/azcollection/azure rm virtualmachinescalesetinstance module


azure.azcollection.azure_rm_virtualmachinescalesetinstance – Get Azure Virtual Machine Scale Set Instance facts

Note

This plugin is part of the azure.azcollection collection (version 1.4.0).

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_virtualmachinescalesetinstance.


New in version 0.1.2: of azure.azcollection


Synopsis

  • Get facts of Azure Virtual Machine Scale Set VMs.

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 0.0.1 of azure.azcollection

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in 0.0.1 of azure.azcollection

Default:

"latest"

Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.

auth_source

string

added in 0.0.1 of azure.azcollection

  • auto

  • cli
  • credential_file
  • env
  • msi

Controls the source of the credentials to use for authentication.

Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.

When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.

When set to env, the credentials will be read from the environment variables

When set to credential_file, it will read the profile from ~/.azure/credentials.

When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6.

cert_validation_mode

string

added in 0.0.1 of azure.azcollection

  • ignore
  • validate

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 the AZURE_CERT_VALIDATION environment variable.

client_id

string

Azure client ID. Use when authenticating with a Service Principal.

cloud_environment

string

added in 0.0.1 of azure.azcollection

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 the AZURE_CLOUD_ENVIRONMENT environment variable.

instance_id

string / required

The instance ID of the virtual machine.

latest_model

boolean

  • no
  • yes

Set to yes to upgrade to the latest model.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

power_state

string

  • running
  • stopped
  • deallocated

Use this option to change power state of the instance.

profile

string

Security profile found in ~/.azure/credentials file.

protect_from_scale_in

boolean

  • no
  • yes

turn on/off instance protection from scale in

protect_from_scale_set_actions

boolean

  • no
  • yes

tun on/off instance protection from scale set actions

resource_group

string / required

The name of the resource group.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

state

string

  • absent
  • present

State of the VMSS instance. Use present to update an instance and absent to delete an instance.

subscription_id

string

Your Azure subscription Id.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

vmss_name

string / required

The name of the VM scale set.



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: Upgrade instance to the latest image
  azure_rm_virtualmachinescalesetinstance:
    resource_group: myResourceGroup
    vmss_name: myVMSS
    instance_id: "2"
    latest_model: yes

- name: Turn on protect from scale in
  azure_rm_virtualmachinescalesetinstance:
      resource_group: myResourceGroup
      vmss_name: myVMSS
      instance_id: "2"
      protect_from_scale_in: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

instances

complex

always

A list of instances.


id

string

always

Instance resource ID.


Sample:

/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.Compute/scalesets/myscaleset/vms/myvm




Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_virtualmachinescalesetinstance_module.html