firewall_rules

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

Overview

Name	firewall_rules
Type	Resource
Id	azure.sql.firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
endIpAddress	string	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses.
startIpAddress	string	The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
type	string	Resource type.

list_by_server

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
endIpAddress	string	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress. Use value '0.0.0.0' for all Azure-internal IP addresses.
startIpAddress	string	The start IP address of the firewall rule. Must be IPv4 format. Use value '0.0.0.0' for all Azure-internal IP addresses.
type	string	Resource type.

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 a firewall rule.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of firewall rules.
create_or_update	insert	resource_group_name, server_name, firewall_rule_name, subscription_id		Creates or updates a firewall rule.
create_or_update	replace	resource_group_name, server_name, firewall_rule_name, subscription_id		Creates or updates a firewall rule.
replace	replace	resource_group_name, server_name, subscription_id		Replaces all firewall rules on the server.
delete	delete	resource_group_name, server_name, firewall_rule_name, subscription_id		Deletes a 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	The 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 a firewall rule.

SELECT
id,
name,
endIpAddress,
startIpAddress,
type
FROM azure.sql.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

Gets a list of firewall rules.

SELECT
id,
name,
endIpAddress,
startIpAddress,
type
FROM azure.sql.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 or updates a firewall rule.

INSERT INTO azure.sql.firewall_rules (
name,
properties,
resource_group_name,
server_name,
firewall_rule_name,
subscription_id
)
SELECT 
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ firewall_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
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: name
    value: "{{ name }}"
    description: |
      Resource name.
  - name: properties
    description: |
      Resource properties.
    value:
      startIpAddress: "{{ startIpAddress }}"
      endIpAddress: "{{ endIpAddress }}"

REPLACE examples

create_or_update

Creates or updates a firewall rule.

REPLACE azure.sql.firewall_rules
SET 
name = '{{ name }}',
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
RETURNING
id,
name,
properties,
type;

replace

Replaces all firewall rules on the server.

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

DELETE examples

delete

Deletes a firewall rule.

DELETE FROM azure.sql.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
;