azure / azure.azcollection / 2.3.0 / module / azure_rm_devtestlabvirtualmachine Manage Azure DevTest Lab Virtual Machine instance | "added in version" 0.1.2 of azure.azcollection" Authors: Zim Kalinowski (@zikalino)azure.azcollection.azure_rm_devtestlabvirtualmachine (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of Azure DevTest Lab Virtual Machine.
- 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: 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"
name: description: - The name of the virtual machine. required: true type: str tags: description: - 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. type: dict image: description: - The Microsoft Azure Marketplace image reference of the virtual machine. suboptions: offer: description: - The offer of the gallery image. type: str os_type: description: - The OS type of the gallery image. type: str publisher: description: - The publisher of the gallery image. type: str sku: description: - The SKU of the gallery image. type: str version: description: - The version of the gallery image. type: str type: dict notes: description: - The notes of the virtual machine. type: str state: choices: - absent - present default: present description: - Assert the state of the Virtual Machine. - Use C(present) to create or update an Virtual Machine and C(absent) to delete it. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str os_type: choices: - windows - linux description: - Base type of operating system. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str ssh_key: description: - The SSH key of the virtual machine administrator. type: str vm_size: description: - A valid Azure VM size value. For example, C(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 U(https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general). - Required when I(state=present). type: str lab_name: description: - The name of the lab. required: true type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - The password of the virtual machine administrator. type: str artifacts: description: - The artifacts to be installed on the virtual machine. elements: dict suboptions: parameters: description: - The parameters of the artifact. elements: dict suboptions: name: description: - The name of the artifact parameter. type: str value: description: - The value of the artifact parameter. type: str type: list source_name: description: - The artifact's source name. type: str source_path: description: - The artifact's path in the source repository. type: str type: list client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str user_name: description: - The user name of the virtual machine. type: str lab_subnet: description: - An existing subnet within lab's virtual network. - It can be the subnet's resource id. - It can be a dict which contains C(virtual_network_name) and C(name). type: raw thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection allow_claim: description: - Indicates whether another user can take ownership of the virtual machine. type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection append_tags: default: true description: - 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. type: bool auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection storage_type: choices: - standard - premium description: - Storage type to use for virtual machine. type: str resource_group: description: - The name of the resource group. required: true type: str expiration_date: description: - The expiration date for VM. type: str subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection disable_instance_discovery: default: false description: - 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection disallow_public_ip_address: description: - Indicates whether the virtual machine is to be created without a public IP address. type: str
compute_id: description: - The identifier of the underlying Compute Virtual Machine resource. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm type: str fqdn: description: - Fully qualified domain name or IP Address of the virtual machine. returned: always sample: myvm.eastus.cloudapp.azure.com type: str id: description: - The identifier of the DTL Virtual Machine resource. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm type: str