ansible / ansible.builtin / v2.8.19 / module / azure_rm_devtestlabvirtualmachine_facts Get Azure DevTest Lab Virtual Machine facts. | "added in version" 2.8 of ansible.builtin" Authors: Zim Kalinowski (@zikalino) preview | supported by communityansible.builtin.azure_rm_devtestlabvirtualmachine_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Get facts of Azure DevTest Lab Virtual Machine.
- name: Get instance of DTL Virtual Machine azure_rm_devtestlabvirtualmachine_facts: resource_group: myResourceGroup lab_name: myLab name: myVm
name: description: - The name of the virtual machine. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. 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 profile: description: - Security profile found in ~/.azure/credentials file. type: str lab_name: description: - The name of the lab. required: true log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str 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 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 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 resource_group: description: - The name of the resource group. required: true 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
virtualmachines: contains: compute_vm_id: description: - Resource id of compute virtual machine. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm type: str compute_vm_name: description: - Name of compute virtual machine. returned: always sample: myVm type: str compute_vm_resource_group: description: - Resource group where compute virtual machine is created. returned: always sample: myLab-myVm-097933 type: str disallow_public_ip_address: description: - Whether public IP should be not allowed. returned: always sample: false type: bool expiration_date: description: - Virtual machine expiration date. returned: always sample: '2029-02-22T01:49:12.117974Z' type: str fqdn: description: - Fully qualified domain name. returned: always sample: myvm.eastus.cloudapp.azure.com type: str id: description: - 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 type: str image: contains: offer: description: - Offer. returned: when created from gallery image sample: UbuntuServer type: str os_type: description: - Operating system type. returned: when created from gallery image sample: Linux type: str publisher: description: - Publisher. returned: when created from gallery image sample: Canonical type: str sku: description: - SKU. returned: when created from gallery image sample: 16.04-LTS type: str version: description: - Version. returned: when created from gallery image sample: latest type: str description: - Gallery image reference. returned: always type: complex lab_name: description: - Name of the lab. returned: always sample: myLab type: str name: description: - Name of the virtual machine. returned: always sample: myVm type: str notes: description: - Notes of the virtual machine. returned: always sample: My VM notes type: str os_type: description: - Operating system type. returned: always sample: linux type: str provisioning_state: description: - Provisioning state of the virtual network. returned: always sample: Succeeded type: str resource_group: description: - Name of the resource group. returned: always sample: myResourceGroup type: str storage_type: description: - Storage type. returned: always sample: standard type: str tags: description: - Tags returned: always sample: '{ ''foo'': ''bar'' }' type: complex user_name: description: - Admin user name. returned: always sample: dtl_admin type: str vm_size: description: - Virtual machine size. returned: always sample: Standard_A2_v2 type: str description: A list of dictionaries containing facts for DevTest Lab Virtual Machine. returned: always type: complex