azure_rm_rediscache

Manage Azure Cache for Redis instance

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_rediscache

Synopsis

Manage Azure Cache for Redis instance

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	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.
append_tags	bool		`true`	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		`auto`	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.
cert_validation_mode	string			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.
client_id	string			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.
cloud_environment	string		`AzureCloud`	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.
disable_instance_discovery	bool		`false`	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.
enable_non_ssl_port	bool		`false`	When set I(enable_non_ssl_port=true), the non-ssl Redis server port 6379 will be enabled.
identity	dict			Identity for the Object
location	string			Resource location. If not set, location from the resource group will be used as default.
log_mode	string			Parent argument.
log_path	string			Parent argument.
maxfragmentationmemory_reserved	int			Configures the amount of memory in MB that is reserved to accommodate for memory fragmentation.
Please see U(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 U(https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings) for more detail.
maxmemory_reserved	int			Configures the amount of memory in MB that is reserved for non-cache operations.
Please see U(https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings) for more detail.
minimum_tls_version	string			Require clients to use a specified TLS version.
name	string	yes		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 U(https://docs.microsoft.com/en-us/azure/redis-cache/cache-configure#advanced-settings) for more detail.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
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.
public_network_access	string		`Enabled`	Whether or not public endpoint access is allowed for this cache.
reboot	dict			Reboot specified Redis node(s). There can be potential data loss.
redis_version	string		`6`	The major version of Redis.
regenerate_key	dict			Regenerate Redis cache’s access keys.
resource_group	string	yes		Name of the resource group to which the resource belongs.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
shard_count	int			The number of shards to be created when I(sku=premium).
sku	dict	yes		SKU info of Azure Cache for Redis.
state	string		`present`	Assert the state of the Azure Cache for Redis.
Use C(present) to create or update an Azure Cache for Redis and C(absent) to delete it.
static_ip	string			Static IP address. Required when deploying an Azure Cache for Redis inside an existing Azure virtual network.
subnet	raw			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 I(name), I(virtual_network_name) and I(resource_group).
I(name). Name of the subnet.
I(resource_group). Resource group name of the subnet.
I(virtual_network_name). Name of virtual network to which this subnet belongs.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
tenant_settings	dict			Dict of tenant settings.
thumbprint	string			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.
wait_for_provisioning	bool		`True`	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 C(true) to wait for provisioning_state. Set to C(false) if you don’t care about provisioning_state.
Poll wait timeout is 60 minutes.
x509_certificate_path	string			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.

Example

yaml

- name: Create an Azure Cache for Redis
  azure.azcollection.azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: basic
      size: C1

- name: Scale up the Azure Cache for Redis
  azure.azcollection.azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    sku:
      name: standard
      size: C1
    tags:
      testing: foo

- name: Force reboot the redis cache
  azure.azcollection.azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedisCache
    reboot:
      reboot_type: all

- name: Create Azure Cache for Redis with subnet
  azure.azcollection.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.azcollection.azure_rm_rediscache:
    resource_group: myResourceGroup
    name: myRedis
    regenerate_key:
      key_type: primary