community.azure.azure_rm_virtualmachinescaleset_info – Get Virtual Machine Scale Set facts

From Get docs
Ansible/docs/2.10/collections/community/azure/azure rm virtualmachinescaleset info module


community.azure.azure_rm_virtualmachinescaleset_info – Get Virtual Machine Scale Set facts

Note

This plugin is part of the community.azure collection (version 1.0.0).

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

To use it in a playbook, specify: community.azure.azure_rm_virtualmachinescaleset_info.


Synopsis

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.

format

string

  • curated
  • raw

Format of the data returned.

If raw is selected information will be returned in raw format from Azure Python SDK.

If curated is selected the structure will be identical to input parameters of community.azure.azure_rm_virtualmachinescaleset module.

In Ansible 2.5 and lower facts are always returned in raw format.

Please note that this option will be deprecated in 2.10 when curated format will become the only supported format.

name

string

Limit results to a specific virtual machine scale set.

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.

resource_group

string

The resource group to search for the desired virtual machine scale set.

secret

string

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

subscription_id

string

Your Azure subscription Id.

tags

string

List of tags to be matched.

tenant

string

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



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: Get facts for a virtual machine scale set
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    name: testvmss001
    format: curated

- name: Get facts for all virtual networks
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup

- name: Get facts by tags
  community.azure.azure_rm_virtualmachinescaleset_info:
    resource_group: myResourceGroup
    tags:
      - testing

Return Values

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

Key Returned Description

vmss

complex

always

List of virtual machine scale sets.


admin_username

string

always

Admin username used to access the host after it is created.


Sample:

adminuser

capacity

integer

always

Capacity of VMSS.


Sample:

2

data_disks

complex

always

List of attached data disks.


caching

string

always

Type of data disk caching.


Sample:

ReadOnly

disk_size_gb

integer

always

The initial disk size in GB for blank data disks.


Sample:

64

lun

integer

always

The logical unit number for data disk.


managed_disk_type

string

always

Managed data disk type.


Sample:

Standard_LRS

id

string

always

Resource ID.


Sample:

/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/scalesets/myscaleset

image

complex

always

Image specification.


offer

string

always

The offer of the platform image or marketplace image used to create the virtual machine.


Sample:

RHEL

publisher

string

always

Publisher name.


Sample:

RedHat

sku

string

always

SKU name.


Sample:

7-RAW

version

string

always

Image version.


Sample:

7.5.2018050901

load_balancer

string

always

Load balancer name.


Sample:

testlb

location

string

always

Resource location.


Sample:

japaneast

managed_disk_type

string

always

Managed data disk type.


Sample:

Standard_LRS

name

string

always

Resource name.


Sample:

myvmss

os_disk_caching

string

always

Type of OS disk caching.


Sample:

ReadOnly

os_type

string

always

Base type of operating system.


Sample:

Linux

overprovision

boolean

success

Specifies whether the Virtual Machine Scale Set should be overprovisioned.


Sample:

True

resource_group

string

always

Resource group.


Sample:

myResourceGroup

ssh_password_enabled

boolean

always

Is SSH password authentication enabled. Valid only for Linux.


Sample:

True

subnet_name

string

always

Subnet name.


Sample:

testsubnet

tags

dictionary

always

Tags assigned to the resource. Dictionary of string:string pairs.


Sample:

{'tag1': 'abc'}

tier

string

always

SKU Tier.


Sample:

Basic

upgrade_policy

string

always

Upgrade policy.


Sample:

Manual

virtual_network_name

string

always

Associated virtual network name.


Sample:

testvn

vm_size

string

always

Virtual machine size.


Sample:

Standard_D4




Authors

  • Sertac Ozercan (@sozercan)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_virtualmachinescaleset_info_module.html