ip_firewall_rules

Creates, updates, deletes, gets or lists an ip_firewall_rules resource.

Overview

Name	ip_firewall_rules
Type	Resource
Id	azure.synapse.ip_firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Ip Firewall Rule details

Name	Datatype	Description
properties	object	IP firewall rule properties

list_by_workspace

Name	Datatype	Description
properties	object	IP firewall rule properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, ruleName		Get a firewall rule
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		Returns a list of firewall rules
create_or_update	insert	subscriptionId, resourceGroupName, workspaceName, ruleName		Creates or updates a firewall rule
delete	delete	subscriptionId, resourceGroupName, workspaceName, ruleName		Deletes a firewall rule
replace_all	exec	subscriptionId, resourceGroupName, workspaceName		Replaces firewall rules

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
ruleName	string	The IP firewall rule name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get a firewall rule

SELECT
properties
FROM azure.synapse.ip_firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND ruleName = '{{ ruleName }}' -- required
;

list_by_workspace

Returns a list of firewall rules

SELECT
properties
FROM azure.synapse.ip_firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a firewall rule

INSERT INTO azure.synapse.ip_firewall_rules (
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
ruleName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ ruleName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: ip_firewall_rules
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the ip_firewall_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the ip_firewall_rules resource.
    - name: workspaceName
      value: string
      description: Required parameter for the ip_firewall_rules resource.
    - name: ruleName
      value: string
      description: Required parameter for the ip_firewall_rules resource.
    - name: properties
      value: object
      description: |
        IP firewall rule properties

DELETE examples

delete

Deletes a firewall rule

DELETE FROM azure.synapse.ip_firewall_rules
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND ruleName = '{{ ruleName }}' --required
;

Lifecycle Methods

replace_all

Replaces firewall rules

EXEC azure.synapse.ip_firewall_rules.replace_all 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required 
@@json=
'{
"ipFirewallRules": "{{ ipFirewallRules }}"
}'
;