azure_rm_galleryimageversion – Manage Azure SIG Image Version instance

From Get docs
Ansible/docs/2.9/modules/azure rm galleryimageversion module


azure_rm_galleryimageversion – Manage Azure SIG Image Version instance

New in version 2.9.


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

append_tags

boolean

  • no

  • yes ←

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 2.5

  • auto
  • cli
  • credential_file
  • env
  • msi

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

  • ignore
  • validate

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.

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

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

-

If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. type: bool

managed_image

raw

Managed image reference, could be resource id, or dictionary containing resource_group and name

replica_count

-

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

snapshot

raw

Source snapshot to be used.

storage_account_type

string

Specifies the storage account type to be used to store the image. This property is not updatable.

target_regions

list

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

  • absent

  • present ←

Assert the state of the GalleryImageVersion.

Use present to create or update an GalleryImageVersion and absent to delete it.

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

See also

Sign in with Azure CLI
How to authenticate using the az login command.


Examples

- name: Create or update a simple gallery Image Version.
  azure_rm_galleryimageversion:
    resource_group: myResourceGroup
    gallery_name: myGallery1283
    gallery_image_name: myImage
    name: 10.1.3
    location: West US
    publishing_profile:
      end_of_life_date: "2020-10-01t00:00:00+00:00"
      exclude_from_latest: yes
      replica_count: 3
      storage_account_type: Standard_LRS
      target_regions:
        - name: West US
          regional_replica_count: 1
        - name: East US
          regional_replica_count: 2
          storage_account_type: Standard_ZRS
      managed_image:
        name: myImage
        resource_group: myResourceGroup

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




Status

Authors

  • Zim Kalinowski (@zikalino)

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_galleryimageversion_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.9/modules/azure_rm_galleryimageversion_module&oldid=71845"
Powered by MediaWiki