firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure_isv.redis.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Successfully found the rule

Name	Datatype	Description
properties	object	redis cache firewall rule properties

list

Successfully got the current rules

Name	Datatype	Description
properties	object	redis cache firewall rule properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, cacheName, ruleName, subscriptionId		Gets a single firewall rule in a specified redis cache.
list	select	subscriptionId, resourceGroupName, cacheName		Gets all firewall rules in the specified redis cache.
create_or_update	insert	resourceGroupName, cacheName, ruleName, subscriptionId, data__properties		Create or update a redis cache firewall rule
delete	delete	resourceGroupName, cacheName, ruleName, subscriptionId		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
cacheName	string	The name of the Redis cache.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
ruleName	string	The name of the firewall rule.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a single firewall rule in a specified redis cache.

SELECT
properties
FROM azure_isv.redis.firewall_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND cacheName = '{{ cacheName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all firewall rules in the specified redis cache.

SELECT
properties
FROM azure_isv.redis.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cacheName = '{{ cacheName }}' -- required
;

INSERT examples

create_or_update

Create or update a redis cache firewall rule

INSERT INTO azure_isv.redis.firewall_rules (
data__properties,
resourceGroupName,
cacheName,
ruleName,
subscriptionId
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ cacheName }}',
'{{ ruleName }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: cacheName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: properties
      value: object
      description: |
        redis cache firewall rule properties

DELETE examples

delete

Deletes a single firewall rule in a specified redis cache.

DELETE FROM azure_isv.redis.firewall_rules
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND cacheName = '{{ cacheName }}' --required
AND ruleName = '{{ ruleName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;