@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [;
exports.VpnGateway = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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, 2024-10-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.
*/
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, id, opts) {
return new VpnGateway(name, undefined, { ...opts, id: id });
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === VpnGateway.__pulumiType;
}
/**
* 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, args, opts) {
let resourceInputs = {};
opts = opts || {};
if (!opts.id) {
if (args?.resourceGroupName === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceGroupName'");
}
resourceInputs["bgpSettings"] = args?.bgpSettings;
resourceInputs["connections"] = args?.connections;
resourceInputs["enableBgpRouteTranslationForNat"] = args?.enableBgpRouteTranslationForNat;
resourceInputs["gatewayName"] = args?.gatewayName;
resourceInputs["id"] = args?.id;
resourceInputs["isRoutingPreferenceInternet"] = args?.isRoutingPreferenceInternet;
resourceInputs["location"] = args?.location;
resourceInputs["natRules"] = args?.natRules;
resourceInputs["resourceGroupName"] = args?.resourceGroupName;
resourceInputs["tags"] = args?.tags;
resourceInputs["virtualHub"] = args?.virtualHub;
resourceInputs["vpnGatewayScaleUnit"] = args?.vpnGatewayScaleUnit;
resourceInputs["azureApiVersion"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["ipConfigurations"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["provisioningState"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
}
else {
resourceInputs["azureApiVersion"] = undefined /*out*/;
resourceInputs["bgpSettings"] = undefined /*out*/;
resourceInputs["connections"] = undefined /*out*/;
resourceInputs["enableBgpRouteTranslationForNat"] = undefined /*out*/;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["ipConfigurations"] = undefined /*out*/;
resourceInputs["isRoutingPreferenceInternet"] = undefined /*out*/;
resourceInputs["location"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["natRules"] = undefined /*out*/;
resourceInputs["provisioningState"] = undefined /*out*/;
resourceInputs["tags"] = undefined /*out*/;
resourceInputs["type"] = undefined /*out*/;
resourceInputs["virtualHub"] = undefined /*out*/;
resourceInputs["vpnGatewayScaleUnit"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "azure-native:network/v20180401:VpnGateway" }, { type: "azure-native:network/v20180601:VpnGateway" }, { type: "azure-native:network/v20180701:VpnGateway" }, { type: "azure-native:network/v20180801:VpnGateway" }, { type: "azure-native:network/v20181001:VpnGateway" }, { type: "azure-native:network/v20181101:VpnGateway" }, { type: "azure-native:network/v20181201:VpnGateway" }, { type: "azure-native:network/v20190201:VpnGateway" }, { type: "azure-native:network/v20190401:VpnGateway" }, { type: "azure-native:network/v20190601:VpnGateway" }, { type: "azure-native:network/v20190701:VpnGateway" }, { type: "azure-native:network/v20190801:VpnGateway" }, { type: "azure-native:network/v20190901:VpnGateway" }, { type: "azure-native:network/v20191101:VpnGateway" }, { type: "azure-native:network/v20191201:VpnGateway" }, { type: "azure-native:network/v20200301:VpnGateway" }, { type: "azure-native:network/v20200401:VpnGateway" }, { type: "azure-native:network/v20200501:VpnGateway" }, { type: "azure-native:network/v20200601:VpnGateway" }, { type: "azure-native:network/v20200701:VpnGateway" }, { type: "azure-native:network/v20200801:VpnGateway" }, { type: "azure-native:network/v20201101:VpnGateway" }, { type: "azure-native:network/v20210201:VpnGateway" }, { type: "azure-native:network/v20210301:VpnGateway" }, { type: "azure-native:network/v20210501:VpnGateway" }, { type: "azure-native:network/v20210801:VpnGateway" }, { type: "azure-native:network/v20220101:VpnGateway" }, { type: "azure-native:network/v20220501:VpnGateway" }, { type: "azure-native:network/v20220701:VpnGateway" }, { type: "azure-native:network/v20220901:VpnGateway" }, { type: "azure-native:network/v20221101:VpnGateway" }, { type: "azure-native:network/v20230201:VpnGateway" }, { type: "azure-native:network/v20230401:VpnGateway" }, { type: "azure-native:network/v20230501:VpnGateway" }, { type: "azure-native:network/v20230601:VpnGateway" }, { type: "azure-native:network/v20230901:VpnGateway" }, { type: "azure-native:network/v20231101:VpnGateway" }, { type: "azure-native:network/v20240101:VpnGateway" }, { type: "azure-native:network/v20240301:VpnGateway" }, { type: "azure-native:network/v20240501:VpnGateway" }, { type: "azure-native:network/v20240701:VpnGateway" }, { type: "azure-native:network/v20241001:VpnGateway" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(VpnGateway.__pulumiType, name, resourceInputs, opts);
}
}
exports.VpnGateway = VpnGateway;
/** @internal */
VpnGateway.__pulumiType = 'azure-native:network:VpnGateway';
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidnBuR2F0ZXdheS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL25ldHdvcmsvdnBuR2F0ZXdheS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsc0VBQXNFO0FBQ3RFLGlGQUFpRjs7O0FBRWpGLHlDQUF5QztBQUl6QywwQ0FBMEM7QUFFMUM7Ozs7OztHQU1HO0FBQ0gsTUFBYSxVQUFXLFNBQVEsTUFBTSxDQUFDLGNBQWM7SUFDakQ7Ozs7Ozs7T0FPRztJQUNJLE1BQU0sQ0FBQyxHQUFHLENBQUMsSUFBWSxFQUFFLEVBQTJCLEVBQUUsSUFBbUM7UUFDNUYsT0FBTyxJQUFJLFVBQVUsQ0FBQyxJQUFJLEVBQUUsU0FBZ0IsRUFBRSxFQUFFLEdBQUcsSUFBSSxFQUFFLEVBQUUsRUFBRSxFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBQ3ZFLENBQUM7SUFLRDs7O09BR0c7SUFDSSxNQUFNLENBQUMsVUFBVSxDQUFDLEdBQVE7UUFDN0IsSUFBSSxHQUFHLEtBQUssU0FBUyxJQUFJLEdBQUcsS0FBSyxJQUFJLEVBQUU7WUFDbkMsT0FBTyxLQUFLLENBQUM7U0FDaEI7UUFDRCxPQUFPLEdBQUcsQ0FBQyxjQUFjLENBQUMsS0FBSyxVQUFVLENBQUMsWUFBWSxDQUFDO0lBQzNELENBQUM7SUErREQ7Ozs7OztPQU1HO0lBQ0gsWUFBWSxJQUFZLEVBQUUsSUFBb0IsRUFBRSxJQUFtQztRQUMvRSxJQUFJLGNBQWMsR0FBa0IsRUFBRSxDQUFDO1FBQ3ZDLElBQUksR0FBRyxJQUFJLElBQUksRUFBRSxDQUFDO1FBQ2xCLElBQUksQ0FBQyxJQUFJLENBQUMsRUFBRSxFQUFFO1lBQ1YsSUFBSSxJQUFJLEVBQUUsaUJBQWlCLEtBQUssU0FBUyxJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRTtnQkFDcEQsTUFBTSxJQUFJLEtBQUssQ0FBQywrQ0FBK0MsQ0FBQyxDQUFDO2FBQ3BFO1lBQ0QsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLElBQUksRUFBRSxXQUFXLENBQUM7WUFDbEQsY0FBYyxDQUFDLGFBQWEsQ0FBQyxHQUFHLElBQUksRUFBRSxXQUFXLENBQUM7WUFDbEQsY0FBYyxDQUFDLGlDQUFpQyxDQUFDLEdBQUcsSUFBSSxFQUFFLCtCQUErQixDQUFDO1lBQzFGLGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxJQUFJLEVBQUUsV0FBVyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxJQUFJLENBQUMsR0FBRyxJQUFJLEVBQUUsRUFBRSxDQUFDO1lBQ2hDLGNBQWMsQ0FBQyw2QkFBNkIsQ0FBQyxHQUFHLElBQUksRUFBRSwyQkFBMkIsQ0FBQztZQUNsRixjQUFjLENBQUMsVUFBVSxDQUFDLEdBQUcsSUFBSSxFQUFFLFFBQVEsQ0FBQztZQUM1QyxjQUFjLENBQUMsVUFBVSxDQUFDLEdBQUcsSUFBSSxFQUFFLFFBQVEsQ0FBQztZQUM1QyxjQUFjLENBQUMsbUJBQW1CLENBQUMsR0FBRyxJQUFJLEVBQUUsaUJBQWlCLENBQUM7WUFDOUQsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLElBQUksRUFBRSxJQUFJLENBQUM7WUFDcEMsY0FBYyxDQUFDLFlBQVksQ0FBQyxHQUFHLElBQUksRUFBRSxVQUFVLENBQUM7WUFDaEQsY0FBYyxDQUFDLHFCQUFxQixDQUFDLEdBQUcsSUFBSSxFQUFFLG1CQUFtQixDQUFDO1lBQ2xFLGNBQWMsQ0FBQyxpQkFBaUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDdEQsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLGtCQUFrQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUN2RCxjQUFjLENBQUMsTUFBTSxDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUMzQyxjQUFjLENBQUMsbUJBQW1CLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3hELGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1NBQzlDO2FBQU07WUFDSCxjQUFjLENBQUMsaUJBQWlCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ3RELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxhQUFhLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xELGNBQWMsQ0FBQyxpQ0FBaUMsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDdEUsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLGtCQUFrQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztZQUN2RCxjQUFjLENBQUMsNkJBQTZCLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQ2xFLGNBQWMsQ0FBQyxVQUFVLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQy9DLGNBQWMsQ0FBQyxNQUFNLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQzNDLGNBQWMsQ0FBQyxVQUFVLENBQUMsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDO1lBQy9DLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDeEQsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDM0MsY0FBYyxDQUFDLFlBQVksQ0FBQyxHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUM7WUFDakQsY0FBYyxDQUFDLHFCQUFxQixDQUFDLEdBQUcsU0FBUyxDQUFDLE9BQU8sQ0FBQztTQUM3RDtRQUNELElBQUksR0FBRyxNQUFNLENBQUMsWUFBWSxDQUFDLFNBQVMsQ0FBQyxvQkFBb0IsRUFBRSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ25FLE1BQU0sU0FBUyxHQUFHLEVBQUUsT0FBTyxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLEVBQUUsRUFBRSxJQUFJLEVBQUUsMkNBQTJDLEVBQUUsRUFBRSxFQUFFLElBQUksRUFBRSwyQ0FBMkMsRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLDJDQUEyQyxFQUFFLENBQUMsRUFBRSxDQUFDO1FBQ3R5RSxJQUFJLEdBQUcsTUFBTSxDQUFDLFlBQVksQ0FBQyxJQUFJLEVBQUUsU0FBUyxDQUFDLENBQUM7UUFDNUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxZQUFZLEVBQUUsSUFBSSxFQUFFLGNBQWMsRUFBRSxJQUFJLENBQUMsQ0FBQztJQUMvRCxDQUFDOztBQTdJTCxnQ0E4SUM7QUFqSUcsZ0JBQWdCO0FBQ08sdUJBQVksR0FBRyxpQ0FBaUMsQ0FBQyJ9