vnet_connections

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

Overview

Name	vnet_connections
Type	Resource
Id	azure.app_service.vnet_connections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id.
name	string	Resource Name.
kind	string	Kind of resource.
properties	object	Core resource properties
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, name, vnetName, subscriptionId		Description for Gets a virtual network the app (or deployment slot) is connected to by name.
create_or_update	insert	resourceGroupName, name, vnetName, subscriptionId		Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
update	update	resourceGroupName, name, vnetName, subscriptionId		Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).
delete	delete	resourceGroupName, name, vnetName, subscriptionId		Description for Deletes a connection from an app (or deployment slot to a named virtual network.
list	exec	resourceGroupName, name, subscriptionId		Description for Gets the virtual networks the app (or deployment slot) is connected to.

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
name	string	Name of the app.
resourceGroupName	string	Name of the resource group to which the resource belongs.
subscriptionId	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
vnetName	string	Name of the virtual network.

SELECT examples

get

Description for Gets a virtual network the app (or deployment slot) is connected to by name.

SELECT
id,
name,
kind,
properties,
type
FROM azure.app_service.vnet_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND name = '{{ name }}' -- required
AND vnetName = '{{ vnetName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).

INSERT INTO azure.app_service.vnet_connections (
data__kind,
data__properties,
resourceGroupName,
name,
vnetName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ name }}',
'{{ vnetName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
kind,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: vnet_connections
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the vnet_connections resource.
    - name: name
      value: string
      description: Required parameter for the vnet_connections resource.
    - name: vnetName
      value: string
      description: Required parameter for the vnet_connections resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the vnet_connections resource.
    - name: kind
      value: string
      description: |
        Kind of resource.
    - name: properties
      value: object
      description: |
        Core resource properties

UPDATE examples

update

Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).

UPDATE azure.app_service.vnet_connections
SET 
data__kind = '{{ kind }}',
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND vnetName = '{{ vnetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
id,
name,
kind,
properties,
type;

DELETE examples

delete

Description for Deletes a connection from an app (or deployment slot to a named virtual network.

DELETE FROM azure.app_service.vnet_connections
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND name = '{{ name }}' --required
AND vnetName = '{{ vnetName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

list

Description for Gets the virtual networks the app (or deployment slot) is connected to.

EXEC azure.app_service.vnet_connections.list 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@name='{{ name }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;