firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure.postgresql_hsc.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a firewall rule.

list_by_cluster

Name	Datatype	Description
properties	object	The properties of a firewall rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, clusterName, firewallRuleName		Gets information about a cluster firewall rule.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Lists all the firewall rules on cluster.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, firewallRuleName, data__properties		Creates a new cluster firewall rule or updates an existing cluster firewall rule.
delete	delete	subscriptionId, resourceGroupName, clusterName, firewallRuleName		Deletes a cluster firewall rule.

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
clusterName	string	The name of the cluster.
firewallRuleName	string	The name of the cluster firewall rule.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about a cluster firewall rule.

SELECT
properties
FROM azure.postgresql_hsc.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND firewallRuleName = '{{ firewallRuleName }}' -- required
;

list_by_cluster

Lists all the firewall rules on cluster.

SELECT
properties
FROM azure.postgresql_hsc.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
;

INSERT examples

create_or_update

Creates a new cluster firewall rule or updates an existing cluster firewall rule.

INSERT INTO azure.postgresql_hsc.firewall_rules (
data__properties,
subscriptionId,
resourceGroupName,
clusterName,
firewallRuleName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ firewallRuleName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: firewall_rules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the firewall_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: clusterName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: firewallRuleName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: properties
      value: object
      description: |
        The properties of a firewall rule.

DELETE examples

delete

Deletes a cluster firewall rule.

DELETE FROM azure.postgresql_hsc.firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND firewallRuleName = '{{ firewallRuleName }}' --required
;