azure_rm_virtualmachine_scaleset_facts - Get Virtual Machine Scale Set facts
New in version 2.4.
Synopsis
- Get facts for a virtual machine scale set
Requirements (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ad_user | no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| client_id | no | Azure client ID. Use when authenticating with a Service Principal. | ||
| cloud_environment | no | 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. | |
| name | no | Limit results to a specific virtual machine scale set | ||
| password | no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
| profile | no | Security profile found in ~/.azure/credentials file. | ||
| resource_group | no | The resource group to search for the desired virtual machine scale set | ||
| secret | no | Azure client secret. Use when authenticating with a Service Principal. | ||
| subscription_id | no | Your Azure subscription Id. | ||
| tenant | no | Azure tenant ID. Use when authenticating with a Service Principal. |
Examples
- name: Get facts for a virtual machine scale set
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
name: testvmss001
- name: Get facts for all virtual networks
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
- name: Get facts by tags
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
tags:
- testing
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| azure_vmss | List of virtual machine scale sets | always | list |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_virtualmachine_scaleset_facts_module.html