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

The following fields are returned by SELECT queries:

get

Successfully retrieved a specified virtual network rule.

Name	Datatype	Description
properties	object	Resource properties.

list_by_server

Successfully retrieved the list of virtual network 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, virtualNetworkRuleName, subscriptionId		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, virtualNetworkRuleName, subscriptionId		Creates or updates an existing virtual network rule.
delete	delete	resourceGroupName, serverName, virtualNetworkRuleName, subscriptionId		Deletes the virtual network rule with the 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
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.
virtualNetworkRuleName	string	The name of the virtual network rule.

SELECT examples

get

Gets a virtual network rule.

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

list_by_server

Gets a list of virtual network rules in a server.

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

INSERT examples

create_or_update

Creates or updates an existing virtual network rule.

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

Manifest

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

DELETE examples

delete

Deletes the virtual network rule with the given name.

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