Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. databricks
  6. getVNetPeering
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.28.0
published on Sunday, Sep 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.databricks.getVNetPeering

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.
Viewing docs for Azure Native v3.28.0
published on Sunday, Sep 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Gets the workspace vNet Peering.

    Uses Azure REST API version 2026-01-01.

    Other available API versions: 2023-02-01, 2023-09-15-preview, 2024-05-01, 2024-09-01-preview, 2025-03-01-preview, 2025-08-01-preview, 2025-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databricks [ApiVersion]. See the version guide for details.

    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?: InvokeOutputOptions): 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: pulumi.Input[Optional[str]] = None,
                      resource_group_name: pulumi.Input[Optional[str]] = None,
                      workspace_name: pulumi.Input[Optional[str]] = None,
                      opts: Optional[InvokeOutputOptions] = 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 Output<GetVNetPeeringResult> Invoke(GetVNetPeeringInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetVNetPeeringResult> getVNetPeering(GetVNetPeeringArgs args, InvokeOptions options)
public static Output<GetVNetPeeringResult> getVNetPeering(GetVNetPeeringArgs args, InvokeOptions options)
public static Output<GetVNetPeeringResult> getVNetPeering(GetVNetPeeringArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: azure-native:databricks:getVNetPeering
  arguments:
    # arguments dictionary
    data "azure-native_databricks_get_v_net_peering" "name" {
    # arguments
}

    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.
    peering_name string
    The name of the workspace vNet peering.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    workspace_name 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:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the 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.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse
    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).
    SystemData Pulumi.AzureNative.Databricks.Outputs.SystemDataResponse
    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"
    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.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    PeeringState string
    The status of the virtual network peering.
    ProvisioningState string
    The provisioning state of the virtual network peering resource.
    RemoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse
    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).
    SystemData SystemDataResponse
    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"
    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 VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse
    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.
    azure_api_version string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    peering_state string
    The status of the virtual network peering.
    provisioning_state string
    The provisioning state of the virtual network peering resource.
    remote_virtual_network 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).
    system_data 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"
    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 object
    The reference to the databricks virtual network address space.
    databricks_virtual_network 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).
    remote_address_space object
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    peeringState String
    The status of the virtual network peering.
    provisioningState String
    The provisioning state of the virtual network peering resource.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse
    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).
    systemData SystemDataResponse
    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"
    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 VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse
    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.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    peeringState string
    The status of the virtual network peering.
    provisioningState string
    The provisioning state of the virtual network peering resource.
    remoteVirtualNetwork VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse
    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).
    systemData SystemDataResponse
    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"
    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 VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse
    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.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the 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 VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse
    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).
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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 VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse
    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.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the 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).
    systemData Property Map
    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"
    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.
    address_prefixes list(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.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse

    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 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.

    VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse

    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 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.
    Viewing docs for Azure Native v3.28.0
    published on Sunday, Sep 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial