azure / azure.azcollection / 2.3.0 / module / azure_rm_rediscache Manage Azure Cache for Redis instance | "added in version" 0.1.2 of azure.azcollection" Authors: Yunge Zhu(@yungezz)azure.azcollection.azure_rm_rediscache (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update and delete instance of Azure Cache for Redis.
- 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
sku: description: - SKU info of Azure Cache for Redis. required: true suboptions: name: choices: - basic - standard - premium description: - Type of Azure Cache for Redis to deploy. required: true type: str size: choices: - C0 - C1 - C2 - C3 - C4 - C5 - C6 - P1 - P2 - P3 - P4 description: - Size of Azure Cache for Redis to deploy. - When I(sku=basic) or I(sku=standard), allowed values are C(C0), C(C1), C(C2), C(C3), C(C4), C(C5), C(C6). - When I(sku=premium), allowed values are C(P1), C(P2), C(P3), C(P4). - Please see U(https://docs.microsoft.com/en-us/rest/api/redis/redis/create#sku) for allowed values. required: true type: str type: dict name: description: - Unique name of the Azure Cache for Redis to create or update. required: true 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. - 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. type: dict state: choices: - absent - present default: present description: - 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. type: str reboot: description: - Reboot specified Redis node(s). There can be potential data loss. suboptions: reboot_type: choices: - primary - secondary - all description: - Which Redis node(s) to reboot. type: str shard_id: description: - If clustering is enabled, the id of the shard to be rebooted. type: str type: dict secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str subnet: description: - 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. type: raw 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 profile: description: - Security profile found in ~/.azure/credentials file. type: str location: description: - Resource location. If not set, location from the resource group will be used as default. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. 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 or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str static_ip: description: - Static IP address. Required when deploying an Azure Cache for Redis inside an existing Azure virtual network. type: str thumbprint: description: - 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. type: str version_added: 1.14.0 version_added_collection: azure.azcollection 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: 0.0.1 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 default: auto description: - 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. type: str version_added: 0.0.1 version_added_collection: azure.azcollection shard_count: description: - The number of shards to be created when I(sku=premium). type: int redis_version: choices: - '4' - '6' default: '6' description: - The major version of Redis. type: str version_added: 1.10.0 version_added_collection: azure.azcollection regenerate_key: description: - Regenerate Redis cache's access keys. suboptions: key_type: choices: - primary - secondary description: - The Redis key to regenerate. type: str type: dict resource_group: description: - Name of the resource group to which the resource belongs. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str tenant_settings: description: - Dict of tenant settings. type: dict maxmemory_policy: choices: - volatile_lru - allkeys_lru - volatile_random - allkeys_random - volatile_ttl - noeviction description: - 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. 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: 0.0.1 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: 0.0.1 version_added_collection: azure.azcollection maxmemory_reserved: description: - 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. type: int enable_non_ssl_port: default: false description: - When set I(enable_non_ssl_port=true), the non-ssl Redis server port 6379 will be enabled. type: bool minimum_tls_version: choices: - '1.0' - '1.1' - '1.2' description: - Require clients to use a specified TLS version. type: str version_added: 1.10.0 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: 0.0.1 version_added_collection: azure.azcollection public_network_access: choices: - Enabled - Disabled default: Enabled description: - Whether or not public endpoint access is allowed for this cache. type: str version_added: 1.10.0 version_added_collection: azure.azcollection wait_for_provisioning: default: true description: - 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. type: bool x509_certificate_path: description: - 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. type: path version_added: 1.14.0 version_added_collection: azure.azcollection notify_keyspace_events: description: - 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. type: str disable_instance_discovery: default: false description: - 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. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection maxfragmentationmemory_reserved: description: - 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. type: int
host_name: description: - Host name of the Azure Cache for Redis. returned: when I(state=present) sample: myredis.redis.cache.windows.net type: str id: description: - Id of the Azure Cache for Redis. returned: always sample: /subscriptions/xxxxxxxx-xxxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis type: str