azure.azcollection.azure_rm_rediscache module – Manage Azure Cache for Redis instance
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_rediscache.
New in azure.azcollection 0.1.2
Synopsis
Create, update and delete instance of Azure Cache for Redis.
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: |
|
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. Choices:
|
|
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:
|
|
When set enable_non_ssl_port=true, the non-ssl Redis server port 6379 will be enabled. Choices:
|
|
Identity for the Object |
|
Type of the managed identity Choices:
|
|
User Assigned Managed Identities and its options Default: |
|
If the list of identities has to be appended to current identities (true) or if it has to replace current identities (false) Choices:
|
|
List of the user assigned identities IDs associated to the Object Default: |
|
Resource location. If not set, location from the resource group will be used as default. |
|
Parent argument. |
|
Parent argument. |
|
Configures the amount of memory in MB that is reserved to accommodate for memory fragmentation. Please see https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings for more detail. |
|
Configures the eviction policy of the cache. Please see https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings for more detail. Choices:
|
|
Configures the amount of memory in MB that is reserved for non-cache operations. Please see https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings for more detail. |
|
Require clients to use a specified TLS version. Choices:
|
|
Unique name of the Azure Cache for Redis to create or update. |
|
Allows clients to receive notifications when certain events occur. Please see https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings for more detail. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Whether or not public endpoint access is allowed for this cache. Choices:
|
|
Reboot specified Redis node(s). There can be potential data loss. |
|
Which Redis node(s) to reboot. Choices:
|
|
If clustering is enabled, the id of the shard to be rebooted. |
|
The major version of Redis. Choices:
|
|
Regenerate Redis cache’s access keys. |
|
The Redis key to regenerate. Choices:
|
|
Name of the resource group to which the resource belongs. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
The number of shards to be created when sku=premium. |
|
SKU info of Azure Cache for Redis. |
|
Type of Azure Cache for Redis to deploy. Choices:
|
|
Size of Azure Cache for Redis to deploy. When sku=basic or sku=standard, allowed values are When sku=premium, allowed values are Please see https://docs.microsoft.com/en-us/rest/api/redis/redis/create#sku for allowed values. Choices:
|
|
Assert the state of the Azure Cache for Redis. Use Choices:
|
|
Static IP address. Required when deploying an Azure Cache for Redis inside an existing Azure virtual network. |
|
Subnet in a virtual network to deploy the Azure Cache for Redis in. It can be resource id of subnet, for example /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1. It can be a dictionary where contains name, virtual_network_name and resource_group. name. Name of the subnet. resource_group. Resource group name of the subnet. virtual_network_name. Name of virtual network to which this subnet belongs. |
|
Your Azure subscription Id. |
|
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. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Dict of tenant settings. |
|
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. |
|
Wait till the Azure Cache for Redis instance provisioning_state is Succeeded. It takes several minutes for Azure Cache for Redis to be provisioned ready for use after creating/updating/rebooting. Set this option to Poll wait timeout is 60 minutes. Choices:
|
|
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 an Azure Cache for Redis
azure_rm_rediscache:
resource_group: myResourceGroup
name: myRedis
sku:
name: basic
size: C1
- name: Scale up the Azure Cache for Redis
azure_rm_rediscache:
resource_group: myResourceGroup
name: myRedis
sku:
name: standard
size: C1
tags:
testing: foo
- name: Force reboot the redis cache
azure_rm_rediscache:
resource_group: myResourceGroup
name: myRedisCache
reboot:
reboot_type: all
- name: Create Azure Cache for Redis with subnet
azure_rm_rediscache:
resource_group: myResourceGroup
name: myRedis
sku:
name: premium
size: P1
subnet: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirt
ualNetwork/subnets/mySubnet"
- name: Regenerate primary Redis key
azure_rm_rediscache:
resource_group: myResourceGroup
name: myRedis
regenerate_key:
key_type: primary
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Host name of the Azure Cache for Redis. Returned: when state=present Sample: |
|
Id of the Azure Cache for Redis. Returned: always Sample: |