vnet_peerings

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

Overview

Name	vnet_peerings
Type	Resource
Id	azure_isv.databricks.vnet_peerings

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual network peering resource
properties	object	List of properties for vNet Peering
type	string	type of the virtual network peering resource

list_by_workspace

List succeeded. Returns the resulting resource objects in response body.

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the virtual network peering resource
properties	object	List of properties for vNet Peering
type	string	type of the virtual network peering resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, workspaceName, subscriptionId, peeringName		Gets the workspace vNet Peering.
list_by_workspace	select	resourceGroupName, workspaceName, subscriptionId		Lists the workspace vNet Peerings.
create_or_update	insert	resourceGroupName, workspaceName, subscriptionId, peeringName, data__properties		Creates vNet Peering for workspace.
delete	delete	resourceGroupName, workspaceName, subscriptionId, peeringName		Deletes the workspace vNetPeering.

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
peeringName	string	The name of the workspace vNet peering.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets the workspace vNet Peering.

SELECT
id,
name,
properties,
type
FROM azure_isv.databricks.vnet_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND peeringName = '{{ peeringName }}' -- required
;

list_by_workspace

Lists the workspace vNet Peerings.

SELECT
id,
name,
properties,
type
FROM azure_isv.databricks.vnet_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates vNet Peering for workspace.

INSERT INTO azure_isv.databricks.vnet_peerings (
data__properties,
resourceGroupName,
workspaceName,
subscriptionId,
peeringName
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ subscriptionId }}',
'{{ peeringName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: vnet_peerings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the vnet_peerings resource.
    - name: workspaceName
      value: string
      description: Required parameter for the vnet_peerings resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the vnet_peerings resource.
    - name: peeringName
      value: string
      description: Required parameter for the vnet_peerings resource.
    - name: properties
      value: object
      description: |
        List of properties for vNet Peering

DELETE examples

delete

Deletes the workspace vNetPeering.

DELETE FROM azure_isv.databricks.vnet_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND peeringName = '{{ peeringName }}' --required
;