@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Peerings in a VirtualNetwork resource
*
* Uses Azure REST API version 2024-05-01.
*
* Other available API versions: 2023-02-01, 2023-09-15-preview, 2024-09-01-preview, 2025-03-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class VNetPeering extends pulumi.CustomResource {
/**
* Get an existing VNetPeering resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VNetPeering;
/**
* Returns true if the given object is an instance of VNetPeering. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VNetPeering;
/**
* Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
*/
readonly allowForwardedTraffic: pulumi.Output<boolean | undefined>;
/**
* If gateway links can be used in remote virtual networking to link to this virtual network.
*/
readonly allowGatewayTransit: pulumi.Output<boolean | undefined>;
/**
* Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
*/
readonly allowVirtualNetworkAccess: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The reference to the databricks virtual network address space.
*/
readonly databricksAddressSpace: pulumi.Output<outputs.databricks.AddressSpaceResponse | undefined>;
/**
* 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).
*/
readonly databricksVirtualNetwork: pulumi.Output<outputs.databricks.VirtualNetworkPeeringPropertiesFormatResponseDatabricksVirtualNetwork | undefined>;
/**
* Name of the virtual network peering resource
*/
readonly name: pulumi.Output<string>;
/**
* The status of the virtual network peering.
*/
readonly peeringState: pulumi.Output<string>;
/**
* The provisioning state of the virtual network peering resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The reference to the remote virtual network address space.
*/
readonly remoteAddressSpace: pulumi.Output<outputs.databricks.AddressSpaceResponse | undefined>;
/**
* 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).
*/
readonly remoteVirtualNetwork: pulumi.Output<outputs.databricks.VirtualNetworkPeeringPropertiesFormatResponseRemoteVirtualNetwork>;
/**
* type of the virtual network peering resource
*/
readonly type: pulumi.Output<string>;
/**
* 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.
*/
readonly useRemoteGateways: pulumi.Output<boolean | undefined>;
/**
* Create a VNetPeering resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VNetPeeringArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VNetPeering resource.
*/
export interface VNetPeeringArgs {
/**
* Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
*/
allowForwardedTraffic?: pulumi.Input<boolean>;
/**
* If gateway links can be used in remote virtual networking to link to this virtual network.
*/
allowGatewayTransit?: pulumi.Input<boolean>;
/**
* Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
*/
allowVirtualNetworkAccess?: pulumi.Input<boolean>;
/**
* The reference to the databricks virtual network address space.
*/
databricksAddressSpace?: pulumi.Input<inputs.databricks.AddressSpaceArgs>;
/**
* 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).
*/
databricksVirtualNetwork?: pulumi.Input<inputs.databricks.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkArgs>;
/**
* The name of the workspace vNet peering.
*/
peeringName?: pulumi.Input<string>;
/**
* The reference to the remote virtual network address space.
*/
remoteAddressSpace?: pulumi.Input<inputs.databricks.AddressSpaceArgs>;
/**
* 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).
*/
remoteVirtualNetwork: pulumi.Input<inputs.databricks.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* 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.
*/
useRemoteGateways?: pulumi.Input<boolean>;
/**
* The name of the workspace.
*/
workspaceName: pulumi.Input<string>;
}