firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure.postgresql_flexible_servers.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.
endIpAddress	string	IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. Required.
startIpAddress	string	IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. 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_by_server

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.
endIpAddress	string	IP address defining the end of the range of addresses of a firewall rule. Must be expressed in IPv4 format. Required.
startIpAddress	string	IP address defining the start of the range of addresses of a firewall rule. Must be expressed in IPv4 format. 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, server_name, firewall_rule_name, subscription_id		Gets information about a firewall rule in a server.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists information about all firewall rules in a server.
create_or_update	insert	resource_group_name, server_name, firewall_rule_name, subscription_id, properties		Creates a new firewall rule or updates an existing firewall rule.
create_or_update	replace	resource_group_name, server_name, firewall_rule_name, subscription_id, properties		Creates a new firewall rule or updates an existing firewall rule.
delete	delete	resource_group_name, server_name, firewall_rule_name, subscription_id		Deletes an existing 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
firewall_rule_name	string	Name of the firewall rule. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets information about a firewall rule in a server.

SELECT
id,
name,
endIpAddress,
startIpAddress,
systemData,
type
FROM azure.postgresql_flexible_servers.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND firewall_rule_name = '{{ firewall_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists information about all firewall rules in a server.

SELECT
id,
name,
endIpAddress,
startIpAddress,
systemData,
type
FROM azure.postgresql_flexible_servers.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.postgresql_flexible_servers.firewall_rules (
properties,
resource_group_name,
server_name,
firewall_rule_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ firewall_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: server_name
    value: "{{ server_name }}"
    description: Required parameter for the firewall_rules resource.
  - name: firewall_rule_name
    value: "{{ firewall_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: |
      Properties of a firewall rule. Required.
    value:
      startIpAddress: "{{ startIpAddress }}"
      endIpAddress: "{{ endIpAddress }}"

REPLACE examples

create_or_update

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

REPLACE azure.postgresql_flexible_servers.firewall_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND firewall_rule_name = '{{ firewall_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes an existing firewall rule.

DELETE FROM azure.postgresql_flexible_servers.firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND firewall_rule_name = '{{ firewall_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;