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

Successfully retrieved the specified firewall rule.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of firewall rules.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serverName, firewallRuleName, subscriptionId		Gets a firewall rule.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets a list of firewall rules.
create_or_update	insert	resourceGroupName, serverName, firewallRuleName, subscriptionId		Creates or updates a firewall rule.
replace	replace	resourceGroupName, serverName, subscriptionId		Replaces all firewall rules on the server.
delete	delete	resourceGroupName, serverName, firewallRuleName, subscriptionId		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
firewallRuleName	string	The name of the firewall rule.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a firewall rule.

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

list_by_server

Gets a list of firewall rules.

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

INSERT examples

create_or_update

Creates or updates a firewall rule.

INSERT INTO azure.sql.firewall_rules (
data__properties,
resourceGroupName,
serverName,
firewallRuleName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ firewallRuleName }}',
'{{ 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: serverName
      value: string
      description: Required parameter for the firewall_rules resource.
    - name: firewallRuleName
      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: |
        Resource properties.

REPLACE examples

replace

Replaces all firewall rules on the server.

REPLACE azure.sql.firewall_rules
SET 
data__values = '{{ values }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes a firewall rule.

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