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

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.
provisioningState	string	The state of the outbound rule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

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.
provisioningState	string	The state of the outbound rule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, outbound_rule_fqdn, subscription_id		Gets an outbound firewall rule.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets all outbound firewall rules on a server.
create_or_update	insert	resource_group_name, server_name, outbound_rule_fqdn, subscription_id		Create a outbound firewall rule with a given name.
create_or_update	replace	resource_group_name, server_name, outbound_rule_fqdn, subscription_id		Create a outbound firewall rule with a given name.
delete	delete	resource_group_name, server_name, outbound_rule_fqdn, subscription_id		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
outbound_rule_fqdn	string	Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets an outbound firewall rule.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.sql.outbound_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND outbound_rule_fqdn = '{{ outbound_rule_fqdn }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets all outbound firewall rules on a server.

SELECT
id,
name,
provisioningState,
systemData,
type
FROM azure.sql.outbound_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a outbound firewall rule with a given name.

INSERT INTO azure.sql.outbound_firewall_rules (
resource_group_name,
server_name,
outbound_rule_fqdn,
subscription_id
)
SELECT 
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ outbound_rule_fqdn }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: outbound_firewall_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the outbound_firewall_rules resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the outbound_firewall_rules resource.
  - name: outbound_rule_fqdn
    value: "{{ outbound_rule_fqdn }}"
    description: Required parameter for the outbound_firewall_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the outbound_firewall_rules resource.

REPLACE examples

create_or_update

Create a outbound firewall rule with a given name.

REPLACE azure.sql.outbound_firewall_rules
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND outbound_rule_fqdn = '{{ outbound_rule_fqdn }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a outbound firewall rule with a given name.

DELETE FROM azure.sql.outbound_firewall_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND outbound_rule_fqdn = '{{ outbound_rule_fqdn }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;