community.azure.azure_rm_devtestlabvirtualmachine_info – Get Azure DevTest Lab Virtual Machine facts
Note
This plugin is part of the community.azure collection (version 1.1.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 community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_devtestlabvirtualmachine_info
.
DEPRECATED
- Removed in
version 2.0.0
- Why
The Ansible collection community.azure is deprecated. Use azure.azcollection instead.
- Alternative
Use azure.azcollection.azure_rm_devtestlabvirtualmachine_info instead.
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 |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
The name of the lab. |
|
Parent argument. |
|
Parent argument. |
|
The name of the virtual machine. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
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 instance of DTL Virtual Machine
community.azure.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 |
Description |
---|---|
A list of dictionaries containing facts for DevTest Lab Virtual Machine. Returned: always |
|
Resource id of compute virtual machine. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm” |
|
Name of compute virtual machine. Returned: always Sample: “myVm” |
|
Resource group where compute virtual machine is created. Returned: always Sample: “myLab-myVm-097933” |
|
Whether public IP should be not allowed. Returned: always Sample: false |
|
Virtual machine expiration date. Returned: always Sample: “2029-02-22T01:49:12.117974Z” |
|
Fully qualified domain name. Returned: always Sample: “myvm.eastus.cloudapp.azure.com” |
|
The identifier of the virtual machine. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm” |
|
Gallery image reference. Returned: always |
|
The offer of the gallery image. Returned: when created from gallery image Sample: “UbuntuServer” |
|
Operating system type. Returned: when created from gallery image Sample: “Linux” |
|
The publisher of the gallery image. Returned: when created from gallery image Sample: “Canonical” |
|
The SKU of the gallery image. Returned: when created from gallery image Sample: “16.04-LTS” |
|
The version of the gallery image. Returned: when created from gallery image Sample: “latest” |
|
Name of the lab. Returned: always Sample: “myLab” |
|
Name of the virtual machine. Returned: always Sample: “myVm” |
|
Notes of the virtual machine. Returned: always Sample: “My VM notes” |
|
Operating system type. Returned: always Sample: “linux” |
|
Provisioning state of the virtual network. Returned: always Sample: “Succeeded” |
|
Name of the resource group. Returned: always Sample: “myResourceGroup” |
|
Storage type to use for virtual machine. Returned: always Sample: “standard” |
|
The tags of the resource. Returned: always Sample: “{ \u0027foo\u0027: \u0027bar\u0027 }” |
|
Admin user name. Returned: always Sample: “dtl_admin” |
|
Virtual machine size. Returned: always Sample: “Standard_A2_v2” |
Status
This module will be removed in version 2.0.0. [deprecated]
For more information see DEPRECATED.
Authors
Zim Kalinowski (@zikalino)