Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databricks
  5. getVNetPeering
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databricks.getVNetPeering

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the workspace vNet Peering.

    Uses Azure REST API version 2023-02-01.

    Using getVNetPeering

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVNetPeering(args: GetVNetPeeringArgs, opts?: InvokeOptions): Promise<GetVNetPeeringResult>
function getVNetPeeringOutput(args: GetVNetPeeringOutputArgs, opts?: InvokeOptions): Output<GetVNetPeeringResult>
    def get_v_net_peering(peering_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      workspace_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetVNetPeeringResult
def get_v_net_peering_output(peering_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      workspace_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetVNetPeeringResult]
    func LookupVNetPeering(ctx *Context, args *LookupVNetPeeringArgs, opts ...InvokeOption) (*LookupVNetPeeringResult, error)
func LookupVNetPeeringOutput(ctx *Context, args *LookupVNetPeeringOutputArgs, opts ...InvokeOption) LookupVNetPeeringResultOutput

    > Note: This function is named LookupVNetPeering in the Go SDK.

    public static class GetVNetPeering 
{
    public static Task<GetVNetPeeringResult> InvokeAsync(GetVNetPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetVNetPeeringResult> Invoke(GetVNetPeeringInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVNetPeeringResult> getVNetPeering(GetVNetPeeringArgs args, InvokeOptions options)
public static Output<GetVNetPeeringResult> getVNetPeering(GetVNetPeeringArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:databricks:getVNetPeering
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PeeringName string
    The name of the workspace vNet peering.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    PeeringName string
    The name of the workspace vNet peering.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the workspace.
    peeringName String
    The name of the workspace vNet peering.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.
    peeringName string
    The name of the workspace vNet peering.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the workspace.
    peering_name str
    The name of the workspace vNet peering.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the workspace.
    peeringName String
    The name of the workspace vNet peering.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the workspace.

    getVNetPeering Result

    The following output properties are available:

    Id string
    Resource ID.
    Name string
    Name of the virtual network peering resource
    PeeringState string
    The status of the virtual network peering.
    ProvisioningState string
    The provisioning state of the virtual network peering resource.
    RemoteVirtualNetwork Pulumi.AzureNative.Databricks.Outputs.VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork
    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).
    Type string
    type of the virtual network peering resource
    AllowForwardedTraffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    AllowGatewayTransit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    AllowVirtualNetworkAccess bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    DatabricksAddressSpace Pulumi.AzureNative.Databricks.Outputs.AddressSpaceResponse
    The reference to the databricks virtual network address space.
    DatabricksVirtualNetwork Pulumi.AzureNative.Databricks.Outputs.VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork
    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).
    RemoteAddressSpace Pulumi.AzureNative.Databricks.Outputs.AddressSpaceResponse
    The reference to the remote virtual network address space.
    UseRemoteGateways bool
    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.
    Id string
    Resource ID.
    Name string
    Name of the virtual network peering resource
    PeeringState string
    The status of the virtual network peering.
    ProvisioningState string
    The provisioning state of the virtual network peering resource.
    RemoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork
    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).
    Type string
    type of the virtual network peering resource
    AllowForwardedTraffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    AllowGatewayTransit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    AllowVirtualNetworkAccess bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    DatabricksAddressSpace AddressSpaceResponse
    The reference to the databricks virtual network address space.
    DatabricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork
    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).
    RemoteAddressSpace AddressSpaceResponse
    The reference to the remote virtual network address space.
    UseRemoteGateways bool
    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.
    id String
    Resource ID.
    name String
    Name of the virtual network peering resource
    peeringState String
    The status of the virtual network peering.
    provisioningState String
    The provisioning state of the virtual network peering resource.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork
    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).
    type String
    type of the virtual network peering 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 AddressSpaceResponse
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork
    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).
    remoteAddressSpace AddressSpaceResponse
    The reference to the remote virtual network address space.
    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.
    id string
    Resource ID.
    name string
    Name of the virtual network peering resource
    peeringState string
    The status of the virtual network peering.
    provisioningState string
    The provisioning state of the virtual network peering resource.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork
    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).
    type string
    type of the virtual network peering 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 AddressSpaceResponse
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork
    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).
    remoteAddressSpace AddressSpaceResponse
    The reference to the remote virtual network address space.
    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.
    id str
    Resource ID.
    name str
    Name of the virtual network peering resource
    peering_state str
    The status of the virtual network peering.
    provisioning_state str
    The provisioning state of the virtual network peering resource.
    remote_virtual_network VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork
    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).
    type str
    type of the virtual network peering resource
    allow_forwarded_traffic bool
    Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
    allow_gateway_transit bool
    If gateway links can be used in remote virtual networking to link to this virtual network.
    allow_virtual_network_access bool
    Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
    databricks_address_space AddressSpaceResponse
    The reference to the databricks virtual network address space.
    databricks_virtual_network VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork
    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).
    remote_address_space AddressSpaceResponse
    The reference to the remote virtual network address space.
    use_remote_gateways bool
    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.
    id String
    Resource ID.
    name String
    Name of the virtual network peering resource
    peeringState String
    The status of the virtual network peering.
    provisioningState String
    The provisioning state of the virtual network peering resource.
    remoteVirtualNetwork Property Map
    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).
    type String
    type of the virtual network peering 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 Property Map
    The reference to the databricks virtual network address space.
    databricksVirtualNetwork Property Map
    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).
    remoteAddressSpace Property Map
    The reference to the remote virtual network address space.
    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.

    Supporting Types

    AddressSpaceResponse

    AddressPrefixes List<string>
    A list of address blocks reserved for this virtual network in CIDR notation.
    AddressPrefixes []string
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes string[]
    A list of address blocks reserved for this virtual network in CIDR notation.
    address_prefixes Sequence[str]
    A list of address blocks reserved for this virtual network in CIDR notation.
    addressPrefixes List<String>
    A list of address blocks reserved for this virtual network in CIDR notation.

    VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork

    Id string
    The Id of the databricks virtual network.
    Id string
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.
    id string
    The Id of the databricks virtual network.
    id str
    The Id of the databricks virtual network.
    id String
    The Id of the databricks virtual network.

    VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork

    Id string
    The Id of the remote virtual network.
    Id string
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.
    id string
    The Id of the remote virtual network.
    id str
    The Id of the remote virtual network.
    id String
    The Id of the remote virtual network.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-azure-native