azure.azcollection.azure_rm_storageaccountmanagementpolicy module – Manage storage account management policies
Note
This module is part of the azure.azcollection collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_storageaccountmanagementpolicy.
New in azure.azcollection 2.4.0
Synopsis
Create, update or delete storage account management policies.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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 Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
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 Choices:
|
|
Parent argument. |
|
Parent argument. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of the resource group to use. |
|
The Storage Account ManagementPolicies Rules. |
|
Whether to enabled the rule |
|
An object that defines the action set. |
|
The management policy action for base blob. |
|
The function to delete the blob. |
|
This property can only be used in conjunction with last access time tracking policy. |
|
Value indicating the age in days after last modification. |
|
This property enables auto tiering of a blob from cool to hot on a blob access. Choices:
|
|
The function to tier blobs to archive storage. Support blobs currently at Hot or Cool tier. |
|
This property can only be used in conjunction with last access time tracking policy. |
|
Value indicating the age in days after last modification. |
|
The function to tier blobs to cool storage. Support blobs currently at Hot tier. |
|
This property can only be used in conjunction with last access time tracking policy. |
|
Value indicating the age in days after last modification. |
|
The management policy action for snapshot. |
|
The function to delete the blob snapshot. |
|
Value indicating the age in days after creation. |
|
The function to tier blob snapshot to archive storage. Support blob snapshot currently at Hot or Cool tier. |
|
Value indicating the age in days after creation. |
|
The function to tier blob snapshot to cool storage. Support blob snapshot at Hot tier. |
|
Value indicating the age in days after creation. |
|
The management policy action for version. |
|
The function to delete the blob version. |
|
Value indicating the age in days after creation. |
|
The function to tier blob version to archive storage. Support blob version currently at Hot or Cool tier. |
|
Value indicating the age in days after creation. |
|
The function to tier blob version to cool storage. Support blob version currently at Hot tier. |
|
Value indicating the age in days after creation. |
|
An object that defines the filter set. |
|
An array of blob index tag based filters, there can be at most 10 tag filters. |
|
This is the filter tag name, it can have 1 - 128 characters. |
|
This is the comparison operator which is used for object comparison and filtering. Only |
|
This is the filter tag value field used for tag based filtering. It can have 0-256 characters. |
|
An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for Choices:
|
|
An array of strings for prefixes to be match. |
|
Whether to enabled the rule Choices:
|
|
The name of the policy rule. A rule name can contain any combination of alpha numeric characters. |
|
The type of the policy rule. Choices:
|
|
Azure client secret. Use when authenticating with a Service Principal. |
|
State of the storage account managed policy. Use Use Choices:
|
|
Name of the storage account. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
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. |
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 logincommand.
Examples
- name: Create storage account management policy with multi parameters
azure_rm_storageaccountmanagementpolicy:
resource_group: testRG
storage_account_name: testaccount
rules:
- name: olcmtest5
type: Lifecycle
enabled: false
definition:
actions:
base_blob:
enable_auto_tier_to_hot_from_cool: true
delete:
days_after_modification_greater_than: 33
days_after_last_access_time_greater_than: 33
tier_to_cool:
days_after_modification_greater_than: 33
days_after_last_access_time_greater_than: 33
tier_to_archive:
days_after_modification_greater_than: 33
days_after_last_access_time_greater_than: 33
snapshot:
tier_to_cool:
days_after_creation_greater_than: 33
tier_to_archive:
days_after_creation_greater_than: 33
delete:
days_after_creation_greater_than: 33
version:
tier_to_archive:
days_after_creation_greater_than: 33
tier_to_cool:
days_after_creation_greater_than: 33
delete:
days_after_creation_greater_than: 33
filters:
prefix_match:
- olcmtestcontainer2
blob_types:
- blockBlob
- appendBlob
blob_index_match:
- name: tags3
op: '=='
value: value3
- name: Delete management policy rules
azure_rm_storageaccountmanagementpolicy:
resource_group: "{{ resource_group }}"
storage_account_name: "st{{ rpfx }}"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The data policy rules associated with the specified storage account. Returned: always |
|
The data policy’s ID. Returned: always Sample: |
|
Returns the date and time the ManagementPolicies was last modified. Returned: always Sample: |
|
The name of the resource. Returned: always Sample: |
|
The Storage Account ManagementPolicy. Returned: always |
|
The Storage Account ManagementPolicies Rules. Returned: always Sample: |
|
The resource group name. Returned: always Sample: |
|
The storage account name. Returned: always Sample: |
|
The type of the resource. Returned: always Sample: |