azure.azcollection.azure_rm_devtestlabvirtualmachine – Manage Azure DevTest Lab Virtual Machine instance¶
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
To install it use: ansible-galaxy collection install azure.azcollection.
To use it in a playbook, specify: azure.azcollection.azure_rm_devtestlabvirtualmachine.
New in version 0.1.2: of azure.azcollection
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.
|
|||
|
allow_claim
string
|
Indicates whether another user can take ownership of the virtual machine.
|
|||
|
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. |
||
|
append_tags
boolean
|
|
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.
|
||
|
artifacts
list
/ elements=string
|
The artifacts to be installed on the virtual machine.
|
|||
|
parameters
list
/ elements=string
|
The parameters of the artifact.
|
|||
|
name
string
|
The name of the artifact parameter.
|
|||
|
value
string
|
The value of the artifact parameter.
|
|||
|
source_name
string
|
The artifact's source name.
|
|||
|
source_path
string
|
The artifact's path in the source repository.
|
|||
|
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 variablesWhen 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. |
||
|
disallow_public_ip_address
string
|
Indicates whether the virtual machine is to be created without a public IP address.
|
|||
|
expiration_date
string
|
The expiration date for VM.
|
|||
|
image
string
|
The Microsoft Azure Marketplace image reference of the virtual machine.
|
|||
|
offer
string
|
The offer of the gallery image.
|
|||
|
os_type
string
|
The OS type of the gallery image.
|
|||
|
publisher
string
|
The publisher of the gallery image.
|
|||
|
sku
string
|
The SKU of the gallery image.
|
|||
|
version
string
|
The version of the gallery image.
|
|||
|
lab_name
string
/ required
|
The name of the lab.
|
|||
|
lab_subnet
string
|
An existing subnet within lab's virtual network.
It can be the subnet's resource id.
It can be a dict which contains
virtual_network_name and name. |
|||
|
name
string
/ required
|
The name of the virtual machine.
|
|||
|
notes
string
|
The notes of the virtual machine.
|
|||
|
os_type
string
|
|
Base type of operating system.
|
||
|
password
string
|
The password of the virtual machine administrator.
|
|||
|
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.
|
|||
|
ssh_key
string
|
The SSH key of the virtual machine administrator.
|
|||
|
state
string
|
|
Assert the state of the Virtual Machine.
Use
present to create or update an Virtual Machine and absent to delete it. |
||
|
storage_type
string
|
|
Storage type to use for virtual machine.
|
||
|
subscription_id
string
|
Your Azure subscription Id.
|
|||
|
tags
dictionary
|
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.
|
|||
|
tenant
string
|
Azure tenant ID. Use when authenticating with a Service Principal.
|
|||
|
user_name
string
|
The user name of the virtual machine.
|
|||
|
vm_size
string
|
A valid Azure VM size value. For example,
Standard_D4.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.
|
|||
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: ZSuppas$$21!
lab_subnet:
name: myvnSubnet
virtual_network_name: myvn
disallow_public_ip_address: no
image:
offer: UbuntuServer
publisher: Canonical
sku: 16.04-LTS
os_type: Linux
version: latest
artifacts:
- source_name: myartifact
source_path: "/Artifacts/linux-install-mongodb"
allow_claim: no
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:
Authors¶
Zim Kalinowski (@zikalino)