@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.97 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* VpnConnection Resource.
*
* Uses Azure REST API version 2024-05-01. In version 2.x of the Azure Native provider, it used API version 2023-02-01.
*
* Other available API versions: 2018-06-01, 2018-07-01, 2018-08-01, 2018-10-01, 2018-11-01, 2018-12-01, 2019-02-01, 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01, 2024-07-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native network [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class VpnConnection extends pulumi.CustomResource {
/**
* Get an existing VpnConnection 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): VpnConnection;
/**
* Returns true if the given object is an instance of VpnConnection. 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 VpnConnection;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Expected bandwidth in MBPS.
*/
readonly connectionBandwidth: pulumi.Output<number | undefined>;
/**
* The connection status.
*/
readonly connectionStatus: pulumi.Output<string>;
/**
* DPD timeout in seconds for vpn connection.
*/
readonly dpdTimeoutSeconds: pulumi.Output<number | undefined>;
/**
* Egress bytes transferred.
*/
readonly egressBytesTransferred: pulumi.Output<number>;
/**
* EnableBgp flag.
*/
readonly enableBgp: pulumi.Output<boolean | undefined>;
/**
* Enable internet security.
*/
readonly enableInternetSecurity: pulumi.Output<boolean | undefined>;
/**
* EnableBgp flag.
*/
readonly enableRateLimiting: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* Ingress bytes transferred.
*/
readonly ingressBytesTransferred: pulumi.Output<number>;
/**
* The IPSec Policies to be considered by this connection.
*/
readonly ipsecPolicies: pulumi.Output<outputs.network.IpsecPolicyResponse[] | undefined>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The provisioning state of the VPN connection resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Id of the connected vpn site.
*/
readonly remoteVpnSite: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The Routing Configuration indicating the associated and propagated route tables on this connection.
*/
readonly routingConfiguration: pulumi.Output<outputs.network.RoutingConfigurationResponse | undefined>;
/**
* Routing weight for vpn connection.
*/
readonly routingWeight: pulumi.Output<number | undefined>;
/**
* SharedKey for the vpn connection.
*/
readonly sharedKey: pulumi.Output<string | undefined>;
/**
* The Traffic Selector Policies to be considered by this connection.
*/
readonly trafficSelectorPolicies: pulumi.Output<outputs.network.TrafficSelectorPolicyResponse[] | undefined>;
/**
* Use local azure ip to initiate connection.
*/
readonly useLocalAzureIpAddress: pulumi.Output<boolean | undefined>;
/**
* Enable policy-based traffic selectors.
*/
readonly usePolicyBasedTrafficSelectors: pulumi.Output<boolean | undefined>;
/**
* Connection protocol used for this connection.
*/
readonly vpnConnectionProtocolType: pulumi.Output<string | undefined>;
/**
* List of all vpn site link connections to the gateway.
*/
readonly vpnLinkConnections: pulumi.Output<outputs.network.VpnSiteLinkConnectionResponse[] | undefined>;
/**
* Create a VpnConnection 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: VpnConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VpnConnection resource.
*/
export interface VpnConnectionArgs {
/**
* Expected bandwidth in MBPS.
*/
connectionBandwidth?: pulumi.Input<number>;
/**
* The name of the connection.
*/
connectionName?: pulumi.Input<string>;
/**
* DPD timeout in seconds for vpn connection.
*/
dpdTimeoutSeconds?: pulumi.Input<number>;
/**
* EnableBgp flag.
*/
enableBgp?: pulumi.Input<boolean>;
/**
* Enable internet security.
*/
enableInternetSecurity?: pulumi.Input<boolean>;
/**
* EnableBgp flag.
*/
enableRateLimiting?: pulumi.Input<boolean>;
/**
* The name of the gateway.
*/
gatewayName: pulumi.Input<string>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* The IPSec Policies to be considered by this connection.
*/
ipsecPolicies?: pulumi.Input<pulumi.Input<inputs.network.IpsecPolicyArgs>[]>;
/**
* The name of the resource that is unique within a resource group. This name can be used to access the resource.
*/
name?: pulumi.Input<string>;
/**
* Id of the connected vpn site.
*/
remoteVpnSite?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The resource group name of the VpnGateway.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The Routing Configuration indicating the associated and propagated route tables on this connection.
*/
routingConfiguration?: pulumi.Input<inputs.network.RoutingConfigurationArgs>;
/**
* Routing weight for vpn connection.
*/
routingWeight?: pulumi.Input<number>;
/**
* SharedKey for the vpn connection.
*/
sharedKey?: pulumi.Input<string>;
/**
* The Traffic Selector Policies to be considered by this connection.
*/
trafficSelectorPolicies?: pulumi.Input<pulumi.Input<inputs.network.TrafficSelectorPolicyArgs>[]>;
/**
* Use local azure ip to initiate connection.
*/
useLocalAzureIpAddress?: pulumi.Input<boolean>;
/**
* Enable policy-based traffic selectors.
*/
usePolicyBasedTrafficSelectors?: pulumi.Input<boolean>;
/**
* Connection protocol used for this connection.
*/
vpnConnectionProtocolType?: pulumi.Input<string | enums.network.VirtualNetworkGatewayConnectionProtocol>;
/**
* List of all vpn site link connections to the gateway.
*/
vpnLinkConnections?: pulumi.Input<pulumi.Input<inputs.network.VpnSiteLinkConnectionArgs>[]>;
}