azure.azcollection.azure_rm_galleryimageversion – Manage Azure SIG Image Version instance
azure.azcollection.azure_rm_galleryimageversion – Manage Azure SIG Image Version instance
Note
This plugin is part of the azure.azcollection collection (version 1.3.1).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_galleryimageversion
.
New in version 0.1.2: of azure.azcollection
Synopsis
- Create, update and delete instance of Azure SIG Image Version.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
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 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |||
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of | ||
append_tags boolean |
|
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. | ||
auth_source string added in 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The | ||
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 | ||
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |||
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, | ||
gallery_image_name string / required |
The name of the gallery Image Definition in which the Image Version is to be created. | |||
gallery_name string / required |
The name of the Shared Image Gallery in which the Image Definition resides. | |||
location string |
Resource location. | |||
name string / required |
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 ... | |||
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. | |||
publishing_profile dictionary / required |
Publishing profile. | |||
end_of_life_date string |
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". | |||
exclude_from_latest boolean |
|
If exclude_from_latest=true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. | ||
managed_image string |
Managed image reference, could be resource ID, or dictionary containing resource_group and name Obsolete since 2.10, use storage_profile instead | |||
replica_count integer |
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. | |||
snapshot string |
Source snapshot to be used. Obsolete since 2.10, use storage_profile instead | |||
storage_account_type string |
Specifies the storage account type to be used to store the image. This property is not updatable. | |||
target_regions list / elements=string |
The target regions where the Image Version is going to be replicated to. This property is updatable. | |||
name string |
Region name. | |||
regional_replica_count string |
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. | |||
storage_account_type string |
Storage account type. | |||
resource_group string / required |
The name of the resource group. | |||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |||
state string |
|
Assert the state of the GalleryImageVersion. Use | ||
storage_profile dictionary / required |
Storage profile | |||
data_disks list / elements=string |
list of data disk snapshot Mutual exclusive with source_image | |||
host_caching string |
|
host disk caching | ||
lun integer |
lun of the data disk | |||
source string |
Reference to data disk snapshot. Could be resource ID or dictionary containing resource_group and name | |||
os_disk raw |
os disk snapshot Mutual exclusive with source_image | |||
host_caching string |
|
host disk caching | ||
source string |
Reference to os disk snapshot. Could be resource ID or dictionary containing resource_group and name | |||
source_image raw |
Reference to managed image or gallery image version Could be resource ID to managed image, or dictionary containing resource_group and name Could be resource ID to image version, or dictionary containing resource_group,gallery_name, gallery_image_name and version Mutual exclusive with os_disk and data_disks | |||
subscription_id string |
Your Azure subscription Id. | |||
tags dictionary |
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. | |||
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
. - Authentication is also possible using a service principal or Active Directory user.
- To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
See Also
Examples
- 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: yes
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: yes
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: yes
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
always |
Resource ID.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage/versions/10.1.3 |
Authors
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_galleryimageversion_module.html