community.azure.azure_rm_rediscache_info – Get Azure Cache for Redis instance facts
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.0.0).
To install it use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_rediscache_info
.
Synopsis
- Get facts for Azure Cache for Redis instance.
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 |
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, |
name string |
Limit results to a specific Azure Cache for Redis. | |
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. | |
resource_group string / required |
The resource group to search for the desired Azure Cache for Redis. | |
return_access_keys boolean |
|
Indicate weather to return access keys of the Azure Cache for Redis. |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags string |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
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
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 | Returned | Description | ||
---|---|---|---|---|
rediscaches complex |
always |
List of Azure Cache for Redis instances.
| ||
access_keys dictionary |
when return_access_keys=true |
Azure Cache for Redis access keys.
| ||
primary string |
always |
The current primary key that clients can use to authenticate the Redis cahce.
Sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= | ||
secondary string |
always |
The current secondary key that clients can use to authenticate the Redis cahce.
Sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= | ||
configuration dictionary |
always |
Dict of Redis configuration.
Sample: maxmeory_reserved | ||
enable_non_ssl_port boolean |
always |
Specifies whether the non-ssl Redis server port (6379) is enabled.
| ||
host_name string |
always |
Redis host name.
Sample: testRedis.redis.cache.windows.net | ||
id string |
always |
Id of the Azure Cache for Redis.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis | ||
location string |
always |
Location of the Azure Cache for Redis.
Sample: WestUS | ||
name string |
always |
Name of the Azure Cache for Redis.
Sample: myRedis | ||
provisioning_state string |
always |
Provisioning state of the Redis cache.
Sample: Creating | ||
resource_group string |
always |
Name of a resource group where the Azure Cache for Redis belongs to.
Sample: myResourceGroup | ||
shard_count integer |
always |
The number of shards on a Premium Cluster Cache.
Sample: 1 | ||
sku dictionary |
always |
Dict of SKU information.
| ||
name string |
always |
Name of the SKU.
Sample: standard | ||
size string |
always |
Size of the Azure Cache for Redis.
Sample: C1 | ||
static_ip string |
always |
Static IP address.
Sample: 10.75.0.11 | ||
subnet string |
always |
The full resource ID of a subnet in a virtual network to deploy the Azure Cache for Redis in.
Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Network/VirtualNetworks/myVirtualNetwo rk/subnets/mySubnet'] | ||
tags dictionary |
always |
Resource tags.
Sample: {'key1': 'value1'} | ||
tenant_settings dictionary |
always |
Dict of tenant settings.
Sample: {'key1': 'value1'} |
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/community/azure/azure_rm_rediscache_info_module.html