azure.azcollection.azure_rm_devtestlabvirtualmachine_info – Get Azure DevTest Lab Virtual Machine facts
Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
To use it in a playbook, specify: azure.azcollection.azure_rm_devtestlabvirtualmachine_info.
New in version 0.1.2: of azure.azcollection
Synopsis
- Get facts of Azure DevTest Lab Virtual Machine.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- The host that executes this module must have the azure.azcollection collection installed via galaxy
- All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
- Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
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
|
|
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
|
|
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.
|
| lab_name
string / required
|
The name of the lab.
|
|
| log_mode
string
|
Parent argument.
|
|
| log_path
string
|
Parent argument.
|
|
| name
string
|
The name of the virtual machine.
|
|
| 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 / required
|
The name of the resource group.
|
|
| secret
string
|
Azure client secret. Use when authenticating with a Service Principal.
|
|
| subscription_id
string
|
Your Azure subscription Id.
|
|
| tags
list / elements=string
|
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
|
| 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 logincommand.
Examples
- name: Get instance of DTL Virtual Machine
azure_rm_devtestlabvirtualmachine_info:
resource_group: myResourceGroup
lab_name: myLab
name: myVm
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| virtualmachines
complex
|
always |
A list of dictionaries containing facts for DevTest Lab Virtual Machine.
|
||
| compute_vm_id
string
|
always |
Resource id of compute virtual machine.
Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm
|
||
| compute_vm_name
string
|
always |
Name of compute virtual machine.
Sample:
myVm
|
||
| compute_vm_resource_group
string
|
always |
Resource group where compute virtual machine is created.
Sample:
myLab-myVm-097933
|
||
| disallow_public_ip_address
boolean
|
always |
Whether public IP should be not allowed.
|
||
| expiration_date
string
|
always |
Virtual machine expiration date.
Sample:
2029-02-22T01:49:12.117974Z
|
||
| fqdn
string
|
always |
Fully qualified domain name.
Sample:
myvm.eastus.cloudapp.azure.com
|
||
| id
string
|
always |
The identifier of the virtual machine.
Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm
|
||
| image
complex
|
always |
Gallery image reference.
|
||
| offer
string
|
when created from gallery image |
The offer of the gallery image.
Sample:
UbuntuServer
|
||
| os_type
string
|
when created from gallery image |
Operating system type.
Sample:
Linux
|
||
| publisher
string
|
when created from gallery image |
The publisher of the gallery image.
Sample:
Canonical
|
||
| sku
string
|
when created from gallery image |
The SKU of the gallery image.
Sample:
16.04-LTS
|
||
| version
string
|
when created from gallery image |
The version of the gallery image.
Sample:
latest
|
||
| lab_name
string
|
always |
Name of the lab.
Sample:
myLab
|
||
| name
string
|
always |
Name of the virtual machine.
Sample:
myVm
|
||
| notes
string
|
always |
Notes of the virtual machine.
Sample:
My VM notes
|
||
| os_type
string
|
always |
Operating system type.
Sample:
linux
|
||
| provisioning_state
string
|
always |
Provisioning state of the virtual network.
Sample:
Succeeded
|
||
| resource_group
string
|
always |
Name of the resource group.
Sample:
myResourceGroup
|
||
| storage_type
string
|
always |
Storage type to use for virtual machine.
Sample:
standard
|
||
| tags
complex
|
always |
The tags of the resource.
Sample:
{ 'foo': 'bar' }
|
||
| user_name
string
|
always |
Admin user name.
Sample:
dtl_admin
|
||
| vm_size
string
|
always |
Virtual machine size.
Sample:
Standard_A2_v2
|
||
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/latest/collections/azure/azcollection/azure_rm_devtestlabvirtualmachine_info_module.html