firewall_rules

Creates, updates, deletes, gets or lists a firewall_rules resource.

Overview

Name	firewall_rules
Type	Resource
Id	azure.redis.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endIP	string	highest IP address included in the range. Required.
startIP	string	lowest IP address included in the range. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
endIP	string	highest IP address included in the range. Required.
startIP	string	lowest IP address included in the range. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cache_name, rule_name, subscription_id		Gets a single firewall rule in a specified redis cache.
list	select	resource_group_name, cache_name, subscription_id		Gets all firewall rules in the specified redis cache.
create_or_update	insert	resource_group_name, cache_name, rule_name, subscription_id, properties		Create or update a redis cache firewall rule.
create_or_update	replace	resource_group_name, cache_name, rule_name, subscription_id, properties		Create or update a redis cache firewall rule.
delete	delete	resource_group_name, cache_name, rule_name, subscription_id		Deletes a single firewall rule in a specified redis cache.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cache_name	string	The name of the Redis cache. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_name	string	The name of the firewall rule. Required.
subscription_id	string

SELECT examples

get

Gets a single firewall rule in a specified redis cache.

SELECT
id,
name,
endIP,
startIP,
systemData,
type
FROM azure.redis.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all firewall rules in the specified redis cache.

SELECT
id,
name,
endIP,
startIP,
systemData,
type
FROM azure.redis.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cache_name = '{{ cache_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a redis cache firewall rule.

INSERT INTO azure.redis.firewall_rules (
properties,
resource_group_name,
cache_name,
rule_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ cache_name }}',
'{{ rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: cache_name
    value: "{{ cache_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the firewall_rules resource.
  - name: properties
    description: |
      redis cache firewall rule properties. Required.
    value:
      startIP: "{{ startIP }}"
      endIP: "{{ endIP }}"

REPLACE examples

create_or_update

Create or update a redis cache firewall rule.

REPLACE azure.redis.firewall_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a single firewall rule in a specified redis cache.

DELETE FROM azure.redis.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cache_name = '{{ cache_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;