virtual_network_rules

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

Overview

Name	virtual_network_rules
Type	Resource
Id	azure_extras.rdbms.virtual_network_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}. # pylint: disable=line-too-long
name	string	The name of the resource.
ignoreMissingVnetServiceEndpoint	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
state	string	Virtual Network Rule State. Known values are: "Initializing", "InProgress", "Ready", "Deleting", and "Unknown".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkSubnetId	string	The ARM resource id of the virtual network subnet.

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
ignoreMissingVnetServiceEndpoint	boolean	Create firewall rule before the virtual network has vnet service endpoint enabled.
state	string	Virtual Network Rule State. Known values are: "Initializing", "InProgress", "Ready", "Deleting", and "Unknown".
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
virtualNetworkSubnetId	string	The ARM resource id of the virtual network subnet.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, virtual_network_rule_name, subscription_id		Gets a virtual network rule.
list_by_server	select	resource_group_name, server_name, subscription_id		Gets a list of virtual network rules in a server.
create_or_update	insert	resource_group_name, server_name, virtual_network_rule_name, subscription_id		Creates or updates an existing virtual network rule.
create_or_update	replace	resource_group_name, server_name, virtual_network_rule_name, subscription_id		Creates or updates an existing virtual network rule.
delete	delete	resource_group_name, server_name, virtual_network_rule_name, subscription_id		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
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
virtual_network_rule_name	string	The name of the virtual network rule. Required.

SELECT examples

get

Gets a virtual network rule.

SELECT
id,
name,
ignoreMissingVnetServiceEndpoint,
state,
type,
virtualNetworkSubnetId
FROM azure_extras.rdbms.virtual_network_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Gets a list of virtual network rules in a server.

SELECT
id,
name,
ignoreMissingVnetServiceEndpoint,
state,
type,
virtualNetworkSubnetId
FROM azure_extras.rdbms.virtual_network_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

Creates or updates an existing virtual network rule.

INSERT INTO azure_extras.rdbms.virtual_network_rules (
properties,
resource_group_name,
server_name,
virtual_network_rule_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ virtual_network_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: virtual_network_rule_name
    value: "{{ virtual_network_rule_name }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_rules resource.
  - name: properties
    value:
      virtualNetworkSubnetId: "{{ virtualNetworkSubnetId }}"
      ignoreMissingVnetServiceEndpoint: {{ ignoreMissingVnetServiceEndpoint }}

REPLACE examples

create_or_update

Creates or updates an existing virtual network rule.

REPLACE azure_extras.rdbms.virtual_network_rules
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes the virtual network rule with the given name.

DELETE FROM azure_extras.rdbms.virtual_network_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND virtual_network_rule_name = '{{ virtual_network_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;