outbound_firewall_rules

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

Overview

Name	outbound_firewall_rules
Type	Resource
Id	azure.sql.outbound_firewall_rules

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified outbound firewall rule.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved outbound 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, outboundRuleFqdn, subscriptionId		Gets an outbound firewall rule.
list_by_server	select	resourceGroupName, serverName, subscriptionId		Gets all outbound firewall rules on a server.
create_or_update	insert	resourceGroupName, serverName, outboundRuleFqdn, subscriptionId		Create a outbound firewall rule with a given name.
delete	delete	resourceGroupName, serverName, outboundRuleFqdn, subscriptionId		Deletes a outbound firewall rule with a given name.

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
outboundRuleFqdn	string
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 an outbound firewall rule.

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

list_by_server

Gets all outbound firewall rules on a server.

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

INSERT examples

create_or_update

Create a outbound firewall rule with a given name.

INSERT INTO azure.sql.outbound_firewall_rules (
data__properties,
resourceGroupName,
serverName,
outboundRuleFqdn,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ outboundRuleFqdn }}',
'{{ subscriptionId }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: outbound_firewall_rules
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the outbound_firewall_rules resource.
    - name: serverName
      value: string
      description: Required parameter for the outbound_firewall_rules resource.
    - name: outboundRuleFqdn
      value: string
      description: Required parameter for the outbound_firewall_rules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the outbound_firewall_rules resource.
    - name: properties
      value: object
      description: |
        Resource properties.

DELETE examples

delete

Deletes a outbound firewall rule with a given name.

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