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
- vw_vnet_peerings
- vnet_peerings
Name | Datatype | Description |
---|---|---|
id | text | Resource ID. |
name | text | Name of the virtual network peering resource |
allow_forwarded_traffic | text | field from the properties object |
allow_gateway_transit | text | field from the properties object |
allow_virtual_network_access | text | field from the properties object |
databricks_address_space | text | field from the properties object |
databricks_virtual_network | text | field from the properties object |
peeringName | text | field from the properties object |
peering_state | text | field from the properties object |
provisioning_state | text | field from the properties object |
remote_address_space | text | field from the properties object |
remote_virtual_network | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subscriptionId | text | field from the properties object |
type | text | type of the virtual network peering resource |
use_remote_gateways | text | field from the properties object |
workspaceName | text | field from the properties object |
Name | Datatype | Description |
---|---|---|
id | string | Resource ID. |
name | string | Name of the virtual network peering resource |
properties | object | Properties of the virtual network peering. |
type | string | type of the virtual network peering resource |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | peeringName, resourceGroupName, subscriptionId, workspaceName | Gets the workspace vNet Peering. |
list_by_workspace | SELECT | resourceGroupName, subscriptionId, workspaceName | Lists the workspace vNet Peerings. |
create_or_update | INSERT | peeringName, resourceGroupName, subscriptionId, workspaceName, data__properties | Creates vNet Peering for workspace. |
delete | DELETE | peeringName, resourceGroupName, subscriptionId, workspaceName | Deletes the workspace vNetPeering. |
SELECT
examples
Lists the workspace vNet Peerings.
- vw_vnet_peerings
- 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 }}';
SELECT
id,
name,
properties,
type
FROM azure_isv.databricks.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.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_isv.databricks.vnet_peerings (
peeringName,
resourceGroupName,
subscriptionId,
workspaceName,
data__properties,
properties
)
SELECT
'{{ peeringName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ data__properties }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: allowVirtualNetworkAccess
value: boolean
- name: allowForwardedTraffic
value: boolean
- name: allowGatewayTransit
value: boolean
- name: useRemoteGateways
value: boolean
- name: databricksVirtualNetwork
value: string
- name: databricksAddressSpace
value:
- name: addressPrefixes
value:
- string
- name: remoteVirtualNetwork
value: string
- name: peeringState
value: string
- name: provisioningState
value: []
- name: name
value: string
- name: id
value: string
- name: type
value: string
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 }}';