vnet_peering

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

Overview

Name	vnet_peering
Type	Resource
Id	azure_isv.databricks.vnet_peering

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}.
name	string	The name of the resource.
allowForwardedTraffic	boolean	Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
allowGatewayTransit	boolean	If gateway links can be used in remote virtual networking to link to this virtual network.
allowVirtualNetworkAccess	boolean	Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
databricksAddressSpace	object	The reference to the databricks virtual network address space.
databricksVirtualNetwork	object	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering _).
peeringState	string	The status of the virtual network peering. Known values are: "Initiated", "Connected", and "Disconnected". (Initiated, Connected, Disconnected)
provisioningState	string	The provisioning state of the virtual network peering resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed". (Succeeded, Updating, Deleting, Failed)
remoteAddressSpace	object	The reference to the remote virtual network address space.
remoteVirtualNetwork	object	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering _). Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useRemoteGateways	boolean	If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowForwardedTraffic	boolean	Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
allowGatewayTransit	boolean	If gateway links can be used in remote virtual networking to link to this virtual network.
allowVirtualNetworkAccess	boolean	Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
databricksAddressSpace	object	The reference to the databricks virtual network address space.
databricksVirtualNetwork	object	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering _).
peeringState	string	The status of the virtual network peering. Known values are: "Initiated", "Connected", and "Disconnected". (Initiated, Connected, Disconnected)
provisioningState	string	The provisioning state of the virtual network peering resource. Known values are: "Succeeded", "Updating", "Deleting", and "Failed". (Succeeded, Updating, Deleting, Failed)
remoteAddressSpace	object	The reference to the remote virtual network address space.
remoteVirtualNetwork	object	The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering _). Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
useRemoteGateways	boolean	If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, peering_name, subscription_id		Gets the workspace vNet Peering.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		Lists the workspace vNet Peerings.
create_or_update	insert	resource_group_name, workspace_name, peering_name, subscription_id, properties		Creates vNet Peering for workspace.
create_or_update	replace	resource_group_name, workspace_name, peering_name, subscription_id, properties		Creates vNet Peering for workspace.
delete	delete	resource_group_name, workspace_name, peering_name, subscription_id		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
peering_name	string	The name of the workspace vNet peering. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Gets the workspace vNet Peering.

SELECT
id,
name,
allowForwardedTraffic,
allowGatewayTransit,
allowVirtualNetworkAccess,
databricksAddressSpace,
databricksVirtualNetwork,
peeringState,
provisioningState,
remoteAddressSpace,
remoteVirtualNetwork,
systemData,
type,
useRemoteGateways
FROM azure_isv.databricks.vnet_peering
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND peering_name = '{{ peering_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

Lists the workspace vNet Peerings.

SELECT
id,
name,
allowForwardedTraffic,
allowGatewayTransit,
allowVirtualNetworkAccess,
databricksAddressSpace,
databricksVirtualNetwork,
peeringState,
provisioningState,
remoteAddressSpace,
remoteVirtualNetwork,
systemData,
type,
useRemoteGateways
FROM azure_isv.databricks.vnet_peering
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates vNet Peering for workspace.

INSERT INTO azure_isv.databricks.vnet_peering (
properties,
resource_group_name,
workspace_name,
peering_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ peering_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: vnet_peering
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vnet_peering resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the vnet_peering resource.
  - name: peering_name
    value: "{{ peering_name }}"
    description: Required parameter for the vnet_peering resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vnet_peering resource.
  - name: properties
    description: |
      List of properties for vNet Peering. Required.
    value:
      allowVirtualNetworkAccess: {{ allowVirtualNetworkAccess }}
      allowForwardedTraffic: {{ allowForwardedTraffic }}
      allowGatewayTransit: {{ allowGatewayTransit }}
      useRemoteGateways: {{ useRemoteGateways }}
      databricksVirtualNetwork:
        id: "{{ id }}"
      databricksAddressSpace:
        addressPrefixes:
          - "{{ addressPrefixes }}"
      remoteVirtualNetwork:
        id: "{{ id }}"
      remoteAddressSpace:
        addressPrefixes:
          - "{{ addressPrefixes }}"
      peeringState: "{{ peeringState }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates vNet Peering for workspace.

REPLACE azure_isv.databricks.vnet_peering
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the workspace vNetPeering.

DELETE FROM azure_isv.databricks.vnet_peering
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND peering_name = '{{ peering_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;