azure_rm_devtestlabvirtualmachine – Manage Azure DevTest Lab Virtual Machine instance — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# azure_rm_devtestlabvirtualmachine – Manage Azure DevTest Lab Virtual Machine instance

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- See Also
- Examples
- Return Values
- Status

## 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
- 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 2.6 |  | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
allow_claim - |  | Indicates whether another user can take ownership of the virtual machine.
api_profile string added in 2.5 | 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 | Choices: no yes ← | 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 |  | The artifacts to be installed on the virtual machine.
| parameters list |  | The parameters of the artifact.
|  | name - |  | The name of the artifact parameter.
|  | value - |  | The value of the artifact parameter.
| source_name - |  | The artifact's source name.
| source_path - |  | The artifact's path in the source repository.
auth_source string added in 2.5 | Choices: auto cli credential_file env msi | Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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 2.5 | Choices: ignore validate | 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 2.4 | 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 - |  | Indicates whether the virtual machine is to be created without a public IP address.
expiration_date - |  | The expiration date for VM.
image - |  | The Microsoft Azure Marketplace image reference of the virtual machine.
| offer - |  | The offer of the gallery image.
| os_type - |  | The OS type of the gallery image.
| publisher - |  | The publisher of the gallery image.
| sku - |  | The SKU of the gallery image.
| version - |  | The version of the gallery image.
lab_name - / required |  | The name of the lab.
lab_subnet - |  | 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 - / required |  | The name of the virtual machine.
notes - |  | The notes of the virtual machine.
os_type - | Choices: windows linux | 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 - / required |  | The name of the resource group.
secret string |  | Azure client secret. Use when authenticating with a Service Principal.
ssh_key - |  | The SSH key of the virtual machine administrator.
state - | Choices: absent present ← | Assert the state of the Virtual Machine. Use `present` to create or update an Virtual Machine and `absent` to delete it.
storage_type - | Choices: standard premium | 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 - |  | The user name of the virtual machine.
vm_size - |  | 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 login` command.

## 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:

Key | Returned | Description
--- | --- | ---
compute_id string | always | The identifier of the underlying Compute Virtual Machine resource. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm
fqdn string | always | Fully qualified domain name or IP Address of the virtual machine. Sample: myvm.eastus.cloudapp.azure.com
id string | always | The identifier of the DTL Virtual Machine resource. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.