@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 10.8 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";
/**
* A common class for general resource information.
*
* 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 VirtualNetworkGatewayConnection extends pulumi.CustomResource {
/**
* Get an existing VirtualNetworkGatewayConnection 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): VirtualNetworkGatewayConnection;
/**
* Returns true if the given object is an instance of VirtualNetworkGatewayConnection. 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 VirtualNetworkGatewayConnection;
/**
* The authorizationKey.
*/
readonly authorizationKey: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The connection mode for this connection.
*/
readonly connectionMode: pulumi.Output<string | undefined>;
/**
* Connection protocol used for this connection.
*/
readonly connectionProtocol: pulumi.Output<string | undefined>;
/**
* Virtual Network Gateway connection status.
*/
readonly connectionStatus: pulumi.Output<string>;
/**
* Gateway connection type.
*/
readonly connectionType: pulumi.Output<string>;
/**
* The dead peer detection timeout of this connection in seconds.
*/
readonly dpdTimeoutSeconds: pulumi.Output<number | undefined>;
/**
* The egress bytes transferred in this connection.
*/
readonly egressBytesTransferred: pulumi.Output<number>;
/**
* List of egress NatRules.
*/
readonly egressNatRules: pulumi.Output<outputs.network.SubResourceResponse[] | undefined>;
/**
* EnableBgp flag.
*/
readonly enableBgp: pulumi.Output<boolean | undefined>;
/**
* Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
*/
readonly enablePrivateLinkFastPath: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* Bypass ExpressRoute Gateway for data forwarding.
*/
readonly expressRouteGatewayBypass: pulumi.Output<boolean | undefined>;
/**
* GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
*/
readonly gatewayCustomBgpIpAddresses: pulumi.Output<outputs.network.GatewayCustomBgpIpAddressIpConfigurationResponse[] | undefined>;
/**
* The ingress bytes transferred in this connection.
*/
readonly ingressBytesTransferred: pulumi.Output<number>;
/**
* List of ingress NatRules.
*/
readonly ingressNatRules: pulumi.Output<outputs.network.SubResourceResponse[] | undefined>;
/**
* The IPSec Policies to be considered by this connection.
*/
readonly ipsecPolicies: pulumi.Output<outputs.network.IpsecPolicyResponse[] | undefined>;
/**
* The reference to local network gateway resource.
*/
readonly localNetworkGateway2: pulumi.Output<outputs.network.LocalNetworkGatewayResponse | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The reference to peerings resource.
*/
readonly peer: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The provisioning state of the virtual network gateway connection resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* The resource GUID property of the virtual network gateway connection resource.
*/
readonly resourceGuid: pulumi.Output<string>;
/**
* The routing weight.
*/
readonly routingWeight: pulumi.Output<number | undefined>;
/**
* The IPSec shared key.
*/
readonly sharedKey: pulumi.Output<string | undefined>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The Traffic Selector Policies to be considered by this connection.
*/
readonly trafficSelectorPolicies: pulumi.Output<outputs.network.TrafficSelectorPolicyResponse[] | undefined>;
/**
* Collection of all tunnels' connection health status.
*/
readonly tunnelConnectionStatus: pulumi.Output<outputs.network.TunnelConnectionHealthResponse[]>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Use private local Azure IP for the connection.
*/
readonly useLocalAzureIpAddress: pulumi.Output<boolean | undefined>;
/**
* Enable policy-based traffic selectors.
*/
readonly usePolicyBasedTrafficSelectors: pulumi.Output<boolean | undefined>;
/**
* The reference to virtual network gateway resource.
*/
readonly virtualNetworkGateway1: pulumi.Output<outputs.network.VirtualNetworkGatewayResponse>;
/**
* The reference to virtual network gateway resource.
*/
readonly virtualNetworkGateway2: pulumi.Output<outputs.network.VirtualNetworkGatewayResponse | undefined>;
/**
* Create a VirtualNetworkGatewayConnection 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: VirtualNetworkGatewayConnectionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VirtualNetworkGatewayConnection resource.
*/
export interface VirtualNetworkGatewayConnectionArgs {
/**
* The authorizationKey.
*/
authorizationKey?: pulumi.Input<string>;
/**
* The connection mode for this connection.
*/
connectionMode?: pulumi.Input<string | enums.network.VirtualNetworkGatewayConnectionMode>;
/**
* Connection protocol used for this connection.
*/
connectionProtocol?: pulumi.Input<string | enums.network.VirtualNetworkGatewayConnectionProtocol>;
/**
* Gateway connection type.
*/
connectionType: pulumi.Input<string | enums.network.VirtualNetworkGatewayConnectionType>;
/**
* The dead peer detection timeout of this connection in seconds.
*/
dpdTimeoutSeconds?: pulumi.Input<number>;
/**
* List of egress NatRules.
*/
egressNatRules?: pulumi.Input<pulumi.Input<inputs.network.SubResourceArgs>[]>;
/**
* EnableBgp flag.
*/
enableBgp?: pulumi.Input<boolean>;
/**
* Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
*/
enablePrivateLinkFastPath?: pulumi.Input<boolean>;
/**
* Bypass ExpressRoute Gateway for data forwarding.
*/
expressRouteGatewayBypass?: pulumi.Input<boolean>;
/**
* GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
*/
gatewayCustomBgpIpAddresses?: pulumi.Input<pulumi.Input<inputs.network.GatewayCustomBgpIpAddressIpConfigurationArgs>[]>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* List of ingress NatRules.
*/
ingressNatRules?: pulumi.Input<pulumi.Input<inputs.network.SubResourceArgs>[]>;
/**
* The IPSec Policies to be considered by this connection.
*/
ipsecPolicies?: pulumi.Input<pulumi.Input<inputs.network.IpsecPolicyArgs>[]>;
/**
* The reference to local network gateway resource.
*/
localNetworkGateway2?: pulumi.Input<inputs.network.LocalNetworkGatewayArgs>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* The reference to peerings resource.
*/
peer?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The routing weight.
*/
routingWeight?: pulumi.Input<number>;
/**
* The IPSec shared key.
*/
sharedKey?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The Traffic Selector Policies to be considered by this connection.
*/
trafficSelectorPolicies?: pulumi.Input<pulumi.Input<inputs.network.TrafficSelectorPolicyArgs>[]>;
/**
* Use private local Azure IP for the connection.
*/
useLocalAzureIpAddress?: pulumi.Input<boolean>;
/**
* Enable policy-based traffic selectors.
*/
usePolicyBasedTrafficSelectors?: pulumi.Input<boolean>;
/**
* The reference to virtual network gateway resource.
*/
virtualNetworkGateway1: pulumi.Input<inputs.network.VirtualNetworkGatewayArgs>;
/**
* The reference to virtual network gateway resource.
*/
virtualNetworkGateway2?: pulumi.Input<inputs.network.VirtualNetworkGatewayArgs>;
/**
* The name of the virtual network gateway connection.
*/
virtualNetworkGatewayConnectionName?: pulumi.Input<string>;
}