Try SpotterGet facts about azure custom images
Authors: Madhura Naniwadekar (@Madhura-CSI)
preview | supported by community
Install with ansible-galaxy collection install community.azure:==0.1.0
collections:
- name: community.azure
version: 0.1.0List azure custom images. The images can be listed where scope of listing can be based on subscription, resource group, name or tags.
- 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:
name:
description:
- Name of the image to filter from existing images.
tags:
description:
- List of tags to be matched.
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
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
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: '2.5'
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
description:
- 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 C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- 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: '2.5'
version_added_collection: azure.azcollection
resource_group:
description:
- Name of resource group.
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: '2.4'
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: '2.6'
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: '2.5'
version_added_collection: azure.azcollection
images:
contains:
data_disks:
contains:
blob_uri:
description:
- The virtual hard disk.
caching:
description:
- Type of caching of data disk.
sample: read_only
disk_size_gb:
description:
- Specifies the size of empty data disks in gigabytes.
returned: always
sample: 50
type: int
lun:
description:
- Specifies the logical unit number of the data disk.
returned: always
sample: 0
type: int
managed_disk_id:
description:
- Id of managed disk.
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx
type: str
storage_account_type:
description:
- Specifies the storage account type for the managed disk data disk.
sample: Standard_LRS
type: str
description:
- List of data disks associated with the image.
returned: always
type: complex
id:
description:
- Id of the image.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/xx
type: str
location:
description:
- Location of the image.
returned: always
type: str
name:
description:
- Name of the image.
returned: always
type: str
os_disk:
description:
- Id of os disk for image.
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/xx
type: str
os_disk_caching:
description:
- Specifies caching requirements for the image.
returned: always
type: str
os_state:
description:
- Specifies image operating system state. Possible values are C(Generalized)
or C(Specialized).
returned: always
sample: Generalized
type: str
os_storage_account_type:
description:
- Specifies the storage account type for the managed disk.
sample: Standard_LRS
type: str
os_type:
description:
- Type of OS for image.
returned: always
sample: Linux
type: str
provisioning_state:
description:
- State of image.
returned: always
sample: Succeeded
type: str
resource_group:
description:
- Resource group of the image.
returned: always
sample: myResourceGroup
type: str
source:
description:
- 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
type: str
tags:
description:
- Dictionary of tags associated with the image.
type: complex
description:
- List of image dicts.
returned: always
type: complex