azure / azure.azcollection / 2.3.0 / module / azure_rm_galleryimageversion Manage Azure SIG Image Version instance | "added in version" 0.1.2 of azure.azcollection" Authors: Zim Kalinowski (@zikalino)azure.azcollection.azure_rm_galleryimageversion (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 SIG Image Version.
- name: Create a gallery image version form a managed image azure_rm_galleryimageversion: resource_group: myResourceGroup gallery_name: myGallery gallery_image_name: myGalleryImage name: 1.1.0 location: East US publishing_profile: end_of_life_date: "2020-10-01t00:00:00+00:00" exclude_from_latest: true replica_count: 4 storage_account_type: Standard_LRS target_regions: - name: West US regional_replica_count: 1 - name: East US regional_replica_count: 3 storage_account_type: Standard_LRS storage_profile: source_image: /subscriptions/sub123/resourceGroups/group123/providers/Microsoft.Compute/images/myOsImage
- name: Create a gallery image version from another gallery image version azure_rm_galleryimageversion: resource_group: myResourceGroup gallery_name: myGallery gallery_image_name: myGalleryImage name: 1.2.0 location: East US publishing_profile: end_of_life_date: "2020-10-01t00:00:00+00:00" exclude_from_latest: true replica_count: 4 storage_account_type: Standard_LRS target_regions: - name: West US regional_replica_count: 1 - name: East US regional_replica_count: 3 storage_account_type: Standard_LRS storage_profile: source_image: version: 1.1.0 gallery_name: myGallery2 gallery_image_name: myGalleryImage2
- name: Create gallery image by using one os dist snapshot and zero or many data disk snapshots azure_rm_galleryimageversion: resource_group: myRsourceGroup gallery_name: myGallery gallery_image_name: myGalleryImage name: 3.4.0 location: East US publishing_profile: end_of_life_date: "2020-10-01t00:00:00+00:00" exclude_from_latest: true replica_count: 1 storage_account_type: Standard_LRS target_regions: - name: East US regional_replica_count: 1 storage_account_type: Standard_LRS storage_profile: os_disk: source: "/subscriptions/mySub/resourceGroups/myGroup/providers/Microsoft.Compute/snapshots/os_snapshot_vma" data_disks: - lun: 0 source: name: data_snapshot_vma - lun: 1 source: "/subscriptions/mySub/resourceGroups/myGroup/providers/Microsoft.Compute/snapshots/data_snapshot_vmb"
name: description: - The name of the gallery Image Version to be created. - Needs to follow semantic version name pattern, The allowed characters are digit and period. - Digits must be within the range of a 32-bit integer. For example <MajorVersion>.<MinorVersion>.<Patch>. 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 state: choices: - absent - present default: present description: - Assert the state of the GalleryImageVersion. - Use C(present) to create or update an GalleryImageVersion 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 profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Resource location. type: str 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 or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. 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 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 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 storage_profile: description: - Storage profile - Required when creating. suboptions: data_disks: description: - list of data disk snapshot - Mutual exclusive with source_image elements: raw suboptions: host_caching: choices: - None - ReadOnly - ReadWrite default: None description: - host disk caching type: str lun: description: - lun of the data disk type: int source: description: - Reference to data disk snapshot. Could be resource ID or dictionary containing I(resource_group) and I(name) type: raw type: list os_disk: description: - os disk snapshot - Mutual exclusive with source_image suboptions: host_caching: choices: - None - ReadOnly - ReadWrite default: None description: - host disk caching type: str source: description: - Reference to os disk snapshot. Could be resource ID or dictionary containing I(resource_group) and I(name) type: raw type: dict source_image: description: - Reference to managed image or gallery image version - Could be resource ID to managed image, or dictionary containing I(resource_group) and I(name) - Could be resource ID to image version, or dictionary containing I(resource_group),I(gallery_name), I(gallery_image_name) and I(version) - Mutual exclusive with os_disk and data_disks type: raw type: dict 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 is to be created. required: true type: str publishing_profile: description: - Publishing profile. suboptions: end_of_life_date: description: - The end of life date of the gallery Image Version. - This property can be used for decommissioning purposes. - This property is updatable. Format should be according to ISO-8601, for instance "2019-06-26". type: str exclude_from_latest: description: If I(exclude_from_latest=true), Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. type: bool managed_image: description: - Managed image reference, could be resource ID, or dictionary containing I(resource_group) and I(name) - Obsolete since 2.10, use storage_profile instead type: raw replica_count: description: - The number of replicas of the Image Version to be created per region. - This property would take effect for a region when regionalReplicaCount is not specified. - This property is updatable. type: int snapshot: description: - Source snapshot to be used. - Obsolete since 2.10, use storage_profile instead type: raw storage_account_type: choices: - Standard_LRS - Standard_ZRS description: - Specifies the storage account type to be used to store the image. - This property is not updatable. type: str target_regions: description: - The target regions where the Image Version is going to be replicated to. - This property is updatable. elements: raw suboptions: encryption: description: - Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. suboptions: data_disk_images: description: - A list of encryption specifications for data disk images. elements: dict suboptions: disk_encryption_set_id: description: - A relative URI containing the resource ID of the disk encryption set. type: str lun: description: - This property specifies the logical unit number of the data disk. - This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. type: int type: list os_disk_image: description: - Contains encryption settings for an OS disk image. suboptions: disk_encryption_set_id: description: - A relative URI containing the resource ID of the disk encryption set. type: str security_profile: description: - This property specifies the security profile of an OS disk image. suboptions: confidential_vm_encryption_type: description: - Confidential VM encryption types. suboptions: encrypted_vm_guest_state_only_with_pmk: description: - VM Guest State Only with PMK. type: str encrypted_with_cmk: description: - Encrypted with CMK. type: str encrypted_with_pmk: description: - Encrypted with PMK. type: str type: dict secure_vm_disk_encryption_set_id: description: - Secure VM disk encryption set id. type: str type: dict type: dict type: dict name: description: - Region name. required: true type: str regional_replica_count: description: - The number of replicas of the Image Version to be created per region. - This property would take effect for a region when regionalReplicaCount is not specified. - This property is updatable. type: int storage_account_type: description: - Storage account type. type: str type: list type: dict 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
id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage/versions/10.1.3 type: str