community.azure.azure_rm_rediscache_info – Get Azure Cache for Redis instance facts
Note
This plugin is part of the community.azure collection (version 1.1.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 community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_rediscache_info
.
DEPRECATED
- Removed in
version 2.0.0
- Why
The Ansible collection community.azure is deprecated. Use azure.azcollection instead.
- Alternative
Use azure.azcollection.azure_rm_rediscache_info instead.
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-azure.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: “latest” |
|
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. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Limit results to a specific Azure Cache for Redis. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The resource group to search for the desired Azure Cache for Redis. |
|
Indicate weather to return access keys of the Azure Cache for Redis. Choices:
|
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
Azure tenant ID. 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 login
command.
Examples
- name: Get Azure Cache for Redis by name
community.azure.azure_rm_rediscache_info:
resource_group: myResourceGroup
name: myRedis
- name: Get Azure Cache for Redis with access keys by name
community.azure.azure_rm_rediscache_info:
resource_group: myResourceGroup
name: myRedis
return_access_keys: true
- name: Get Azure Cache for Redis in specific resource group
community.azure.azure_rm_rediscache_info:
resource_group: myResourceGroup
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of Azure Cache for Redis instances. Returned: always |
|
Azure Cache for Redis access keys. Returned: when return_access_keys=true |
|
The current primary key that clients can use to authenticate the Redis cahce. Returned: always Sample: “X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=” |
|
The current secondary key that clients can use to authenticate the Redis cahce. Returned: always Sample: “X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx=” |
|
Dict of Redis configuration. Returned: always Sample: “maxmeory_reserved” |
|
Specifies whether the non-ssl Redis server port (6379) is enabled. Returned: always Sample: false |
|
Redis host name. Returned: always Sample: “testRedis.redis.cache.windows.net” |
|
Id of the Azure Cache for Redis. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis” |
|
Location of the Azure Cache for Redis. Returned: always Sample: “WestUS” |
|
Name of the Azure Cache for Redis. Returned: always Sample: “myRedis” |
|
Provisioning state of the Redis cache. Returned: always Sample: “Creating” |
|
Name of a resource group where the Azure Cache for Redis belongs to. Returned: always Sample: “myResourceGroup” |
|
The number of shards on a Premium Cluster Cache. Returned: always Sample: 1 |
|
Dict of SKU information. Returned: always |
|
Name of the SKU. Returned: always Sample: “standard” |
|
Size of the Azure Cache for Redis. Returned: always Sample: “C1” |
|
Static IP address. Returned: always Sample: “10.75.0.11” |
|
The full resource ID of a subnet in a virtual network to deploy the Azure Cache for Redis in. Returned: always Sample: [“/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet”] |
|
Resource tags. Returned: always Sample: {“key1”: “value1”} |
|
Dict of tenant settings. Returned: always Sample: {“key1”: “value1”} |
Status
This module will be removed in version 2.0.0. [deprecated]
For more information see DEPRECATED.
Authors
Yunge Zhu (@yungezz)