Skip to main content

vnet_peerings

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

Overview

Namevnet_peerings
TypeResource
Idazure_isv.databricks.vnet_peerings

Fields

NameDatatypeDescription
idtextResource ID.
nametextName of the virtual network peering resource
allow_forwarded_traffictextfield from the properties object
allow_gateway_transittextfield from the properties object
allow_virtual_network_accesstextfield from the properties object
databricks_address_spacetextfield from the properties object
databricks_virtual_networktextfield from the properties object
peeringNametextfield from the properties object
peering_statetextfield from the properties object
provisioning_statetextfield from the properties object
remote_address_spacetextfield from the properties object
remote_virtual_networktextfield from the properties object
resourceGroupNametextfield from the properties object
subscriptionIdtextfield from the properties object
typetexttype of the virtual network peering resource
use_remote_gatewaystextfield from the properties object
workspaceNametextfield from the properties object

Methods

NameAccessible byRequired ParamsDescription
getSELECTpeeringName, resourceGroupName, subscriptionId, workspaceNameGets the workspace vNet Peering.
list_by_workspaceSELECTresourceGroupName, subscriptionId, workspaceNameLists the workspace vNet Peerings.
create_or_updateINSERTpeeringName, resourceGroupName, subscriptionId, workspaceName, data__propertiesCreates vNet Peering for workspace.
deleteDELETEpeeringName, resourceGroupName, subscriptionId, workspaceNameDeletes the workspace vNetPeering.

SELECT examples

Lists the workspace vNet Peerings.

SELECT
id,
name,
allow_forwarded_traffic,
allow_gateway_transit,
allow_virtual_network_access,
databricks_address_space,
databricks_virtual_network,
peeringName,
peering_state,
provisioning_state,
remote_address_space,
remote_virtual_network,
resourceGroupName,
subscriptionId,
type,
use_remote_gateways,
workspaceName
FROM azure_isv.databricks.vw_vnet_peerings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

INSERT example

Use the following StackQL query and manifest file to create a new vnet_peerings resource.

/*+ create */
INSERT INTO azure_isv.databricks.vnet_peerings (
peeringName,
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
properties
)
SELECT
'{{ peeringName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ properties }}'
;

DELETE example

Deletes the specified vnet_peerings resource.

/*+ delete */
DELETE FROM azure_isv.databricks.vnet_peerings
WHERE peeringName = '{{ peeringName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';