Try SpotterManage Azure SIG Image instance
| "added in version" 0.1.2 of azure.azcollection"
Authors: Zim Kalinowski (@zikalino)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Azure SIG Image.
- name: Create or update gallery image
azure_rm_galleryimage:
resource_group: myResourceGroup
gallery_name: myGallery1283
name: myImage
location: West US
os_type: linux
os_state: generalized
identifier:
publisher: myPublisherName
offer: myOfferName
sku: mySkuName
eula:
description:
- The Eula agreement for the gallery Image Definition.
type: str
name:
description:
- The name of the gallery Image Definition to be created or updated.
- The allowed characters are alphabets and numbers with dots, dashes, and periods
allowed in the middle.
- The maximum length is 80 characters.
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 GalleryImage.
- Use C(present) to create or update an GalleryImage 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
os_type:
choices:
- windows
- linux
description:
- This property allows you to specify the type of the OS that is included in the disk
when creating a VM from a managed image.
- Required when creating.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
features:
description:
- A list of gallery image features.
elements: dict
suboptions:
name:
description:
- The name of the gallery image feature.
required: true
type: str
value:
description:
- The value of the gallery image feature.
required: true
type: str
type: list
location:
description:
- Resource location.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
os_state:
choices:
- generalized
- specialized
description:
- The allowed values for OS State are C(generalized).
- Required when creating.
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
disallowed:
description:
- Disallowed parameter values.
suboptions:
disk_types:
description:
- A list of disallowed disk types.
elements: str
type: list
type: dict
identifier:
description:
- Image identifier.
- Required when creating.
suboptions:
offer:
description:
- The name of the gallery Image Definition offer.
required: true
type: str
publisher:
description:
- The name of the gallery Image Definition publisher.
required: true
type: str
sku:
description:
- The name of the gallery Image Definition SKU.
required: true
type: str
type: dict
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
description:
description:
- The description of this gallery Image Definition resource. This property is updatable.
type: str
recommended:
description:
- Recommended parameter values.
suboptions:
memory:
description:
- Memory.
suboptions:
max:
description:
- The maximum number of the resource.
type: int
min:
description:
- The minimum number of the resource.
type: int
type: dict
v_cpus:
description:
- Number of virtual CPUs.
suboptions:
max:
description:
- The maximum number of the resource.
type: int
min:
description:
- The minimum number of the resource.
type: int
type: dict
type: dict
architecture:
choices:
- Arm64
- x64
description:
- This property allows you to specify the hardware architecture of the Virtual Machines.
- Arm64 is only supported with Hyper V Version 2.
type: str
gallery_name:
description:
- The name of the Shared Image Gallery in which the Image Definition is to be created.
required: true
type: str
purchase_plan:
description:
- Purchase plan.
suboptions:
name:
description:
- The plan ID.
type: str
product:
description:
- The product ID.
type: str
publisher:
description:
- The publisher ID.
type: str
type: dict
resource_group:
description:
- The name of the resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
end_of_life_date:
description:
- The end of life date of the gallery Image Definition.
- 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
hypervgeneration:
choices:
- V1
- V2
description:
- This property allows you to specify the Hyper V Version of the Virtual Machines.
type: str
release_note_uri:
description:
- The release note uri.
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
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
privacy_statement_uri:
description:
- The privacy statement uri.
type: str
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
type: str