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

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	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress.
provisioningState	string	Resource provisioning state. Known values are: "Provisioning", "Succeeded", "Deleting", "Failed", and "DeleteError".
startIpAddress	string	The start IP address of the firewall rule. Must be IPv4 format.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

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	The end IP address of the firewall rule. Must be IPv4 format. Must be greater than or equal to startIpAddress.
provisioningState	string	Resource provisioning state. Known values are: "Provisioning", "Succeeded", "Deleting", "Failed", and "DeleteError".
startIpAddress	string	The start IP address of the firewall rule. Must be IPv4 format.
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, workspace_name, rule_name, subscription_id		Get a firewall rule.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Returns a list of firewall rules.
create_or_update	insert	resource_group_name, workspace_name, rule_name, subscription_id		Creates or updates a firewall rule.
create_or_update	replace	resource_group_name, workspace_name, rule_name, subscription_id		Creates or updates a firewall rule.
delete	delete	resource_group_name, workspace_name, rule_name, subscription_id		Deletes a firewall rule.
replace_all	exec	resource_group_name, workspace_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
rule_name	string	The IP firewall rule name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get a firewall rule.

SELECT
id,
name,
endIpAddress,
provisioningState,
startIpAddress,
type
FROM azure.synapse.ip_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND rule_name = '{{ rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Returns a list of firewall rules.

SELECT
id,
name,
endIpAddress,
provisioningState,
startIpAddress,
type
FROM azure.synapse.ip_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a firewall rule.

INSERT INTO azure.synapse.ip_firewall_rules (
properties,
resource_group_name,
workspace_name,
rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: ip_firewall_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ip_firewall_rules resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the ip_firewall_rules resource.
  - name: rule_name
    value: "{{ rule_name }}"
    description: Required parameter for the ip_firewall_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ip_firewall_rules resource.
  - name: properties
    value:
      endIpAddress: "{{ endIpAddress }}"
      startIpAddress: "{{ startIpAddress }}"

REPLACE examples

create_or_update

Creates or updates a firewall rule.

REPLACE azure.synapse.ip_firewall_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a firewall rule.

DELETE FROM azure.synapse.ip_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND rule_name = '{{ rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

replace_all

Replaces firewall rules.

EXEC azure.synapse.ip_firewall_rules.replace_all 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"ipFirewallRules": "{{ ipFirewallRules }}"
}'
;