community / community.azure / 1.0.0 / module / azure_rm_rediscache_info Get Azure Cache for Redis instance facts Authors: Yunge Zhu (@yungezz) preview | supported by communitycommunity.azure.azure_rm_rediscache_info (1.0.0) — module
Install with ansible-galaxy collection install community.azure:==1.0.0
collections: - name: community.azure version: 1.0.0
Get facts for Azure Cache for Redis instance.
- 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
name: description: - Limit results to a specific Azure Cache for Redis. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str 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 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. 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 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 resource_group: description: - The resource group to search for the desired Azure Cache for Redis. required: true subscription_id: description: - Your Azure subscription Id. 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 return_access_keys: default: false description: - Indicate weather to return access keys of the Azure Cache for Redis. type: bool 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 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
rediscaches: contains: access_keys: contains: primary: description: - The current primary key that clients can use to authenticate the Redis cahce. returned: always sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= type: str secondary: description: - The current secondary key that clients can use to authenticate the Redis cahce. returned: always sample: X2xXXxx7xxxxxx5xxxx0xxxxx75xxxxxxxxXXXxxxxx= type: str description: - Azure Cache for Redis access keys. returned: when I(return_access_keys=true) type: dict configuration: description: - Dict of Redis configuration. returned: always sample: maxmeory_reserved type: dict enable_non_ssl_port: description: - Specifies whether the non-ssl Redis server port (6379) is enabled. returned: always sample: false type: bool host_name: description: - Redis host name. returned: always sample: testRedis.redis.cache.windows.net type: str id: description: - Id of the Azure Cache for Redis. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Cache/Redis/myRedis type: str location: description: - Location of the Azure Cache for Redis. returned: always sample: WestUS type: str name: description: - Name of the Azure Cache for Redis. returned: always sample: myRedis type: str provisioning_state: description: - Provisioning state of the Redis cache. returned: always sample: Creating type: str resource_group: description: - Name of a resource group where the Azure Cache for Redis belongs to. returned: always sample: myResourceGroup type: str shard_count: description: - The number of shards on a Premium Cluster Cache. returned: always sample: 1 type: int sku: contains: name: description: - Name of the SKU. returned: always sample: standard type: str size: description: - Size of the Azure Cache for Redis. returned: always sample: C1 type: str description: - Dict of SKU information. returned: always type: dict static_ip: description: - Static IP address. returned: always sample: 10.75.0.11 type: str subnet: description: - 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 type: str tags: description: - Resource tags. returned: always sample: key1: value1 type: dict tenant_settings: description: - Dict of tenant settings. returned: always sample: key1: value1 type: dict description: - List of Azure Cache for Redis instances. returned: always type: complex