@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.19 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* VpnGateway 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 VpnGateway extends pulumi.CustomResource {
/**
* Get an existing VpnGateway 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): VpnGateway;
/**
* Returns true if the given object is an instance of VpnGateway. 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 VpnGateway;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Local network gateway's BGP speaker settings.
*/
readonly bgpSettings: pulumi.Output<outputs.network.BgpSettingsResponse | undefined>;
/**
* List of all vpn connections to the gateway.
*/
readonly connections: pulumi.Output<outputs.network.VpnConnectionResponse[] | undefined>;
/**
* Enable BGP routes translation for NAT on this VpnGateway.
*/
readonly enableBgpRouteTranslationForNat: pulumi.Output<boolean | undefined>;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: pulumi.Output<string>;
/**
* List of all IPs configured on the gateway.
*/
readonly ipConfigurations: pulumi.Output<outputs.network.VpnGatewayIpConfigurationResponse[]>;
/**
* Enable Routing Preference property for the Public IP Interface of the VpnGateway.
*/
readonly isRoutingPreferenceInternet: pulumi.Output<boolean | undefined>;
/**
* Resource location.
*/
readonly location: pulumi.Output<string>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* List of all the nat Rules associated with the gateway.
*/
readonly natRules: pulumi.Output<outputs.network.VpnGatewayNatRuleResponse[] | undefined>;
/**
* The provisioning state of the VPN gateway resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* The VirtualHub to which the gateway belongs.
*/
readonly virtualHub: pulumi.Output<outputs.network.SubResourceResponse | undefined>;
/**
* The scale unit for this vpn gateway.
*/
readonly vpnGatewayScaleUnit: pulumi.Output<number | undefined>;
/**
* Create a VpnGateway 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: VpnGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VpnGateway resource.
*/
export interface VpnGatewayArgs {
/**
* Local network gateway's BGP speaker settings.
*/
bgpSettings?: pulumi.Input<inputs.network.BgpSettingsArgs>;
/**
* List of all vpn connections to the gateway.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
connections?: pulumi.Input<pulumi.Input<inputs.network.VpnConnectionArgs>[]>;
/**
* Enable BGP routes translation for NAT on this VpnGateway.
*/
enableBgpRouteTranslationForNat?: pulumi.Input<boolean>;
/**
* The name of the gateway.
*/
gatewayName?: pulumi.Input<string>;
/**
* Resource ID.
*/
id?: pulumi.Input<string>;
/**
* Enable Routing Preference property for the Public IP Interface of the VpnGateway.
*/
isRoutingPreferenceInternet?: pulumi.Input<boolean>;
/**
* Resource location.
*/
location?: pulumi.Input<string>;
/**
* List of all the nat Rules associated with the gateway.
* These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion.
*/
natRules?: pulumi.Input<pulumi.Input<inputs.network.VpnGatewayNatRuleArgs>[]>;
/**
* The resource group name of the VpnGateway.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The VirtualHub to which the gateway belongs.
*/
virtualHub?: pulumi.Input<inputs.network.SubResourceArgs>;
/**
* The scale unit for this vpn gateway.
*/
vpnGatewayScaleUnit?: pulumi.Input<number>;
}