azure_rm_rediscache_info – Get Azure Cache for Redis instance facts¶

New in version 2.9.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis ¶

Get facts for Azure Cache for Redis instance.

Aliases: azure_rm_rediscache_facts

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 2.6		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5	Default: "latest"	Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source string added in 2.5	Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `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 `msi` was added in Ansible 2.6.
cert_validation_mode string added in 2.5	Choices: ignore validate	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 `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable.
client_id string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4	Default: "AzureCloud"	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable.
name -		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 - / required		The resource group to search for the desired Azure Cache for Redis.
return_access_keys boolean	Choices: no ← yes	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 -		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.

Examples ¶

- name: Get Azure Cache for Redis by name
  azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis

- name: Get Azure Cache for Redis with access keys by name
  azure_rm_rediscache_info:
    resource_group: myResourceGroup
    name: myRedis
    return_access_keys: true

- name: Get Azure Cache for Redis in specific resource group
  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'}

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Yunge Zhu (@yungezz)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.