@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the specified virtual network gateway by resource group.
*
* Uses Azure REST API version 2024-05-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 function getVirtualNetworkGateway(args: GetVirtualNetworkGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualNetworkGatewayResult>;
export interface GetVirtualNetworkGatewayArgs {
/**
* The name of the resource group.
*/
resourceGroupName: string;
/**
* The name of the virtual network gateway.
*/
virtualNetworkGatewayName: string;
}
/**
* A common class for general resource information.
*/
export interface GetVirtualNetworkGatewayResult {
/**
* ActiveActive flag.
*/
readonly activeActive?: boolean;
/**
* Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet
*/
readonly adminState?: string;
/**
* Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN.
*/
readonly allowRemoteVnetTraffic?: boolean;
/**
* Configures this gateway to accept traffic from remote Virtual WAN networks.
*/
readonly allowVirtualWanTraffic?: boolean;
/**
* Autoscale configuration for virutal network gateway
*/
readonly autoScaleConfiguration?: outputs.network.VirtualNetworkGatewayAutoScaleConfigurationResponse;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Virtual network gateway's BGP speaker settings.
*/
readonly bgpSettings?: outputs.network.BgpSettingsResponse;
/**
* The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient.
*/
readonly customRoutes?: outputs.network.AddressSpaceResponse;
/**
* disableIPSecReplayProtection flag.
*/
readonly disableIPSecReplayProtection?: boolean;
/**
* Whether BGP is enabled for this virtual network gateway or not.
*/
readonly enableBgp?: boolean;
/**
* EnableBgpRouteTranslationForNat flag.
*/
readonly enableBgpRouteTranslationForNat?: boolean;
/**
* Whether dns forwarding is enabled or not.
*/
readonly enableDnsForwarding?: boolean;
/**
* Whether private IP needs to be enabled on this gateway for connections or not.
*/
readonly enablePrivateIpAddress?: boolean;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* The extended location of type local virtual network gateway.
*/
readonly extendedLocation?: outputs.network.ExtendedLocationResponse;
/**
* The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting.
*/
readonly gatewayDefaultSite?: outputs.network.SubResourceResponse;
/**
* The type of this virtual network gateway.
*/
readonly gatewayType?: string;
/**
* Resource ID.
*/
readonly id?: string;
/**
* The identity of the virtual network gateway, if configured.
*/
readonly identity?: outputs.network.ManagedServiceIdentityResponse;
/**
* The IP address allocated by the gateway to which dns requests can be sent.
*/
readonly inboundDnsForwardingEndpoint: string;
/**
* IP configurations for virtual network gateway.
*/
readonly ipConfigurations?: outputs.network.VirtualNetworkGatewayIPConfigurationResponse[];
/**
* Resource location.
*/
readonly location?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* NatRules for virtual network gateway.
*/
readonly natRules?: outputs.network.VirtualNetworkGatewayNatRuleResponse[];
/**
* The provisioning state of the virtual network gateway resource.
*/
readonly provisioningState: string;
/**
* Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed
*/
readonly resiliencyModel?: string;
/**
* The resource GUID property of the virtual network gateway resource.
*/
readonly resourceGuid: string;
/**
* The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway.
*/
readonly sku?: outputs.network.VirtualNetworkGatewaySkuResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Resource type.
*/
readonly type: string;
/**
* Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet.
*/
readonly vNetExtendedLocationResourceId?: string;
/**
* The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway.
*/
readonly virtualNetworkGatewayPolicyGroups?: outputs.network.VirtualNetworkGatewayPolicyGroupResponse[];
/**
* The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations.
*/
readonly vpnClientConfiguration?: outputs.network.VpnClientConfigurationResponse;
/**
* The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.
*/
readonly vpnGatewayGeneration?: string;
/**
* The type of this virtual network gateway.
*/
readonly vpnType?: string;
}
/**
* Gets the specified virtual network gateway by resource group.
*
* Uses Azure REST API version 2024-05-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 function getVirtualNetworkGatewayOutput(args: GetVirtualNetworkGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVirtualNetworkGatewayResult>;
export interface GetVirtualNetworkGatewayOutputArgs {
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the virtual network gateway.
*/
virtualNetworkGatewayName: pulumi.Input<string>;
}