ansible.builtin.azure_rm_rediscachefirewallrule (v2.9.17) — module

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Create, update and delete Azure Cache for Redis Firewall rules.

Requirements

• python >= 2.7
• azure >= 2.0.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Create a Firewall rule for Azure Cache for Redis
    azure_rm_rediscachefirewallrule:
        resource_group: myResourceGroup
        cache_name: myRedisCache
        name: myRule
        start_ip_address: 192.168.1.1
        end_ip_address: 192.168.1.4

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Update a Firewall rule for Azure Cache for Redis
    azure_rm_rediscachefirewallrule:
        resource_group: myResourceGroup
        cache_name: myRedisCache
        name: myRule
        end_ip_address: 192.168.1.5

Inputs

    
name:
    description:
    - Name of the Firewall rule.
    required: true

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Assert the state of the Firewall rule of Azure Cache for Redis.
    - Use C(present) to create or update Firewall rule of Azure Cache for Redis and C(absent)
      to delete it.

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

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

cache_name:
    description:
    - Name of the Azure Cache for Redis.
    required: true

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

end_ip_address:
    description:
    - The end IP address of the Azure Cache for Redis Firewall rule. Must be IPv4 format.
    - Required when creating Firewall rule.

resource_group:
    description:
    - Name of the resource group to which the resource belongs.
    required: true

subscription_id:
    description:
    - Your Azure subscription Id.
    type: str

start_ip_address:
    description:
    - The start IP address of the Azure Cache for Redis Firewall rule. Must be IPv4 format.
    - Required when creating Firewall rule.

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

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

Outputs

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/firewallRules/myRule
  type: str

See also

• Sign in with Azure CLI: How to authenticate using the C(az login) command. link