New in version 2.9.
Aliases: azure_rm_image_facts
The below requirements are needed on the host that executes this module.
| 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. | |
| 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. |
| auth_source string added in 2.5 |
| 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 |
| 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. |
| name - | Name of the image to filter from existing images. | |
| password string | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
| profile string | Security profile found in ~/.azure/credentials file. | |
| resource_group - | Name of resource group. | |
| secret string | Azure client secret. Use when authenticating with a Service Principal. | |
| subscription_id string | Your Azure subscription Id. | |
| tags - | List of tags to be matched. | |
| tenant string | Azure tenant ID. Use when authenticating with a Service Principal. |
Note
az login.See also
az login command.- name: List images with name
azure_rm_image_info:
name: test-image
resource_group: myResourceGroup
- name: List images by resource group
azure_rm_image_info:
resource_group: myResourceGroup
tags:
- testing
- foo:bar
- name: List all available images under current subscription
azure_rm_image_info:
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
| images complex | always | List of image dicts. | ||
| data_disks complex | always | List of data disks associated with the image. | ||
| blob_uri - | The virtual hard disk. | |||
| caching - | Type of caching of data disk. Sample: read_only | |||
| disk_size_gb integer | always | Specifies the size of empty data disks in gigabytes. Sample: 50 | ||
| lun integer | always | Specifies the logical unit number of the data disk. | ||
| managed_disk_id string | Id of managed disk. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx | |||
| storage_account_type string | Specifies the storage account type for the managed disk data disk. Sample: Standard_LRS | |||
| id string | always | Id of the image. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/xx | ||
| location string | always | Location of the image. | ||
| name string | always | Name of the image. | ||
| os_disk string | Id of os disk for image. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx | |||
| os_disk_caching string | always | Specifies caching requirements for the image. | ||
| os_state string | always | Specifies image operating system state. Possible values are Generalized or Specialized.Sample: Generalized | ||
| os_storage_account_type string | Specifies the storage account type for the managed disk. Sample: Standard_LRS | |||
| os_type string | always | Type of OS for image. Sample: Linux | ||
| provisioning_state string | always | State of image. Sample: Succeeded | ||
| resource_group string | always | Resource group of the image. Sample: myResourceGroup | ||
| source string | Resource id of source VM from which the image is created. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/xx | |||
| tags complex | Dictionary of tags associated with the image. | |||
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_image_info_module.html