virtual_network_rules

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

Overview

Name	virtual_network_rules
Type	Resource
Id	azure.sql.virtual_network_rules

Fields

vw_virtual_network_rules

Name	Datatype	Description
ignore_missing_vnet_service_endpoint	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
virtualNetworkRuleName	text	field from the properties object
virtual_network_subnet_id	text	field from the properties object

virtual_network_rules

Name	Datatype	Description
properties	object	Properties of a virtual network rule.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serverName, subscriptionId, virtualNetworkRuleName	Gets a virtual network rule.
list_by_server	SELECT	resourceGroupName, serverName, subscriptionId	Gets a list of virtual network rules in a server.
create_or_update	INSERT	resourceGroupName, serverName, subscriptionId, virtualNetworkRuleName	Creates or updates an existing virtual network rule.
delete	DELETE	resourceGroupName, serverName, subscriptionId, virtualNetworkRuleName	Deletes the virtual network rule with the given name.

SELECT examples

Gets a list of virtual network rules in a server.

vw_virtual_network_rules

SELECT
ignore_missing_vnet_service_endpoint,
resourceGroupName,
serverName,
state,
subscriptionId,
virtualNetworkRuleName,
virtual_network_subnet_id
FROM azure.sql.vw_virtual_network_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

virtual_network_rules

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.sql.virtual_network_rules (
resourceGroupName,
serverName,
subscriptionId,
virtualNetworkRuleName,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ virtualNetworkRuleName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: virtualNetworkSubnetId
          value: string
        - name: ignoreMissingVnetServiceEndpoint
          value: boolean
        - name: state
          value: string

DELETE example

Deletes the specified virtual_network_rules resource.

/*+ delete */
DELETE FROM azure.sql.virtual_network_rules
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND virtualNetworkRuleName = '{{ virtualNetworkRuleName }}';