ip_firewall_rules

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

Overview

Name	ip_firewall_rules
Type	Resource
Id	azure.synapse.ip_firewall_rules

Fields

vw_ip_firewall_rules

Name	Datatype	Description
end_ip_address	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
ruleName	text	field from the properties object
start_ip_address	text	field from the properties object
subscriptionId	text	field from the properties object
workspaceName	text	field from the properties object

ip_firewall_rules

Name	Datatype	Description
properties	object	IP firewall rule properties

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, ruleName, subscriptionId, workspaceName	Get a firewall rule
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	Returns a list of firewall rules
create_or_update	INSERT	resourceGroupName, ruleName, subscriptionId, workspaceName	Creates or updates a firewall rule
delete	DELETE	resourceGroupName, ruleName, subscriptionId, workspaceName	Deletes a firewall rule
replace_all	EXEC	resourceGroupName, subscriptionId, workspaceName	Replaces firewall rules

SELECT examples

Returns a list of firewall rules

vw_ip_firewall_rules

SELECT
end_ip_address,
provisioning_state,
resourceGroupName,
ruleName,
start_ip_address,
subscriptionId,
workspaceName
FROM azure.synapse.vw_ip_firewall_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

ip_firewall_rules

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

INSERT example

Use the following StackQL query and manifest file to create a new ip_firewall_rules resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.ip_firewall_rules (
resourceGroupName,
ruleName,
subscriptionId,
workspaceName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ ruleName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: endIpAddress
          value: string
        - name: provisioningState
          value: string
        - name: startIpAddress
          value: string

DELETE example

Deletes the specified ip_firewall_rules resource.

/*+ delete */
DELETE FROM azure.synapse.ip_firewall_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND ruleName = '{{ ruleName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';