azure.azcollection.azure_rm_devtestlabvirtualmachine module – Manage Azure DevTest Lab Virtual Machine instance
Note
This module is part of the azure.azcollection collection (version 3.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 azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_devtestlabvirtualmachine.
New in azure.azcollection 0.1.2
Synopsis
Create, update and delete instance 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.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. |
|
Indicates whether another user can take ownership of the virtual machine. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object’s metadata. Choices:
|
|
The artifacts to be installed on the virtual machine. |
|
The parameters of the artifact. |
|
The name of the artifact parameter. |
|
The value of the artifact parameter. |
|
The artifact’s source name. |
|
The artifact’s path in the source repository. |
|
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 or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the Choices:
|
|
Indicates whether the virtual machine is to be created without a public IP address. |
|
The expiration date for VM. |
|
The Microsoft Azure Marketplace image reference of the virtual machine. |
|
The offer of the gallery image. |
|
The OS type of the gallery image. |
|
The publisher of the gallery image. |
|
The SKU of the gallery image. |
|
The version of the gallery image. |
|
Indicates whether this virtual machine uses an SSH key for authentication. is_authentication_with_ssh_key=True when ssh_key is set for ssh authentication. Choices:
|
|
The name of the lab. |
|
An existing subnet within lab’s virtual network. It can be the subnet’s resource id. It can be a dict which contains |
|
Parent argument. |
|
Parent argument. |
|
The name of the virtual machine. |
|
The notes of the virtual machine. |
|
Base type of operating system. Choices:
|
|
The password of the virtual machine administrator. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
The SSH key of the virtual machine administrator. |
|
Assert the state of the Virtual Machine. Use Choices:
|
|
Storage type to use for virtual machine. Choices:
|
|
Your Azure subscription Id. |
|
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don’t allow the use of spaces in the tag. Azure Front Door doesn’t support the use of Azure Automation and Azure CDN only support 15 tags on resources. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
The user name of the virtual machine. |
|
A valid Azure VM size value. For example, The list of choices varies depending on the subscription and location. Check your subscription for available choices. Available values can be found on this website, link https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general. Required when state=present. |
|
Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. 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: Create (or update) Virtual Machine
azure_rm_devtestlabvirtualmachine:
resource_group: myrg
lab_name: mylab
name: myvm
notes: Virtual machine notes....
os_type: linux
vm_size: Standard_A2_v2
user_name: vmadmin
password: "{{ password }}"
lab_subnet:
name: myvnSubnet
virtual_network_name: myvn
disallow_public_ip_address: false
image:
offer: 0001-com-ubuntu-server-focal
publisher: Canonical
sku: 20_04-lts
os_type: Linux
version: latest
artifacts:
- source_name: myartifact
source_path: "/Artifacts/linux-install-mongodb"
allow_claim: false
expiration_date: "2019-02-22T01:49:12.117974Z"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The identifier of the underlying Compute Virtual Machine resource. Returned: always Sample: |
|
Fully qualified domain name or IP Address of the virtual machine. Returned: always Sample: |
|
The identifier of the DTL Virtual Machine resource. Returned: always Sample: |