Try SpotterManage Azure Snapshot instance.
| "added in version" 2.9 of azure.azcollection"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
Install with ansible-galaxy collection install azure.azcollection:==0.3.0
collections:
- name: azure.azcollection
version: 0.3.0Create, update and delete instance of Azure Snapshot.
- name: Create a snapshot by importing an unmanaged blob from the same subscription.
azure_rm_snapshot:
resource_group: myResourceGroup
name: mySnapshot
location: eastus
creation_data:
create_option: Import
source_uri: 'https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd'
- name: Create a snapshot by copying an existing managed disk.
azure_rm_snapshot:
resource_group: myResourceGroup
name: mySnapshot
location: eastus
creation_data:
create_option: Copy
source_id: '/subscriptions/sub123/resourceGroups/group123/providers/Microsoft.Compute/disks/disk123'
sku:
description:
- The snapshots SKU.
suboptions:
name:
choices:
- Standard_LRS
- Premium_LRS
- Standard_ZRS
description:
- The sku name.
type: str
tier:
description:
- The sku tier.
type: str
type: dict
name:
description:
- Resource name.
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.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Snapshot.
- Use C(present) to create or update an Snapshot 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:
- Linux
- Windows
description:
- The Operating System type.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Resource location.
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: '2.5'
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
description:
- 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 C(auto) if variable is not defined.
- C(auto) will follow the default precedence of module parameters -> environment variables
-> default profile in credential file C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the default Azure CLI profile.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- 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: '2.5'
version_added_collection: azure.azcollection
creation_data:
description:
- Disk source information.
- CreationData information cannot be changed after the disk has been created.
suboptions:
create_option:
choices:
- Import
- Copy
description:
- This enumerates the possible sources of a disk's creation.
type: str
source_id:
description:
- If I(createOption=Copy), this is the resource ID of a managed disk to be copied
from.
type: str
source_uri:
description:
- If I(createOption=Import), this is the URI of a blob to be imported into a managed
disk.
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
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: '2.4'
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: '2.6'
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: '2.5'
version_added_collection: azure.azcollection
id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot type: str