/ home / ansible / ansible.builtin / v2.9.17 / module / azure_rm_galleryimageversion_info

ansible.builtin.azure_rm_galleryimageversion_info (v2.9.17) — module

Get Azure SIG Image Version info.

| "added in version" 2.9 of ansible.builtin"

Authors: Liu Qingyi (@smile37773)

preview | supported by community

Install Ansible via `pip`

Install with pip install ansible==2.9.17

Description

Get info of Azure SIG Image Version.

Requirements

python >= 2.7
azure >= 2.0.0

Usage examples

Scanned by Steampunk Spotter

- name: List gallery image versions in a gallery image definition.
  azure_rm_galleryimageversion_info:
    resource_group: myResourceGroup
    gallery_name: myGallery
    gallery_image_name: myImage

Scanned by Steampunk Spotter

- name: Get a gallery image version.
  azure_rm_galleryimageversion_info:
    resource_group: myResourceGroup
    gallery_name: myGallery
    gallery_image_name: myImage
    name: myVersion

Inputs

name:
description:
- Resource name
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

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

gallery_name:
description:
- The name of the Shared Image Gallery in which the Image Definition resides.
required: true
type: str

resource_group:
description:
- The name of the resource group.
required: true
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

gallery_image_name:
description:
- The name of the gallery Image Definition in which the Image Version resides.
required: true
type: str

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

Outputs

versions:
  contains:
    id:
      description:
      - Resource Id
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Compute/galleries/myGallery/
        images/myImage/versions/myVersion
      type: str
    location:
      description:
      - Resource location
      returned: always
      sample: eastus
      type: str
    name:
      description:
      - Resource name
      returned: always
      sample: myVersion
      type: str
    provisioning_state:
      description:
      - The current state of the gallery.
      sample: Succeeded
      type: str
    publishing_profile:
      description:
      - The publishing profile of a gallery image version.
      type: dict
    tags:
      description:
      - Resource tags
      returned: always
      sample:
        tag: value
      type: dict
  description: A list of dict results where the key is the name of the version and
    the values are the info for that version.
  returned: always
  type: complex

Install Ansible via pip