azure.azcollection.azure_rm_rediscache – Manage Azure Cache for Redis instance
azure.azcollection.azure_rm_rediscache – Manage Azure Cache for Redis instance
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_rediscache
.
New in version 0.1.2: of azure.azcollection
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
- 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 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | ||
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of | |
append_tags boolean |
|
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 0.0.1 of azure.azcollection |
|
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 | |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 | |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | ||
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, | |
enable_non_ssl_port boolean |
|
When set enable_non_ssl_port=true, the non-ssl Redis server port 6379 will be enabled. | |
location string |
Resource location. If not set, location from the resource group will be used as default. | ||
maxfragmentationmemory_reserved string |
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. | ||
maxmemory_policy string |
|
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. | |
maxmemory_reserved string |
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. | ||
name string / required |
Unique name of the Azure Cache for Redis to create or update. | ||
notify_keyspace_events string |
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. | ||
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. | ||
reboot string |
Reboot specified Redis node(s). There can be potential data loss. | ||
reboot_type string |
|
Which Redis node(s) to reboot. | |
shard_id integer |
If clustering is enabled, the id of the shard to be rebooted. | ||
regenerate_key string |
Regenerate Redis cache's access keys. | ||
key_type string |
|
The Redis key to regenerate. | |
resource_group string / required |
Name of the resource group to which the resource belongs. | ||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | ||
shard_count integer |
The number of shards to be created when sku=premium. | ||
sku string |
SKU info of Azure Cache for Redis. | ||
name string / required |
|
Type of Azure Cache for Redis to deploy. | |
size string / required |
|
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. | |
state string |
|
Assert the state of the Azure Cache for Redis. Use | |
static_ip string |
Static IP address. Required when deploying an Azure Cache for Redis inside an existing Azure virtual network. | ||
subnet string |
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. | ||
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. | ||
tenant_settings dictionary |
Dict of tenant settings. | ||
wait_for_provisioning boolean |
|
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. |
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
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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
host_name string |
when state=present |
Host name of the Azure Cache for Redis.
Sample: myredis.redis.cache.windows.net |
id string |
always |
Id of the Azure Cache for Redis.
Sample: /subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis |
Authors
- Yunge Zhu(@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_rediscache_module.html