@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets the specified virtual network gateway connection 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 getVirtualNetworkGatewayConnection(args: GetVirtualNetworkGatewayConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetVirtualNetworkGatewayConnectionResult>;
export interface GetVirtualNetworkGatewayConnectionArgs {
/**
* The name of the resource group.
*/
resourceGroupName: string;
/**
* The name of the virtual network gateway connection.
*/
virtualNetworkGatewayConnectionName: string;
}
/**
* A common class for general resource information.
*/
export interface GetVirtualNetworkGatewayConnectionResult {
/**
* The authorizationKey.
*/
readonly authorizationKey?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The connection mode for this connection.
*/
readonly connectionMode?: string;
/**
* Connection protocol used for this connection.
*/
readonly connectionProtocol?: string;
/**
* Virtual Network Gateway connection status.
*/
readonly connectionStatus: string;
/**
* Gateway connection type.
*/
readonly connectionType: string;
/**
* The dead peer detection timeout of this connection in seconds.
*/
readonly dpdTimeoutSeconds?: number;
/**
* The egress bytes transferred in this connection.
*/
readonly egressBytesTransferred: number;
/**
* List of egress NatRules.
*/
readonly egressNatRules?: outputs.network.SubResourceResponse[];
/**
* EnableBgp flag.
*/
readonly enableBgp?: boolean;
/**
* Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled.
*/
readonly enablePrivateLinkFastPath?: boolean;
/**
* A unique read-only string that changes whenever the resource is updated.
*/
readonly etag: string;
/**
* Bypass ExpressRoute Gateway for data forwarding.
*/
readonly expressRouteGatewayBypass?: boolean;
/**
* GatewayCustomBgpIpAddresses to be used for virtual network gateway Connection.
*/
readonly gatewayCustomBgpIpAddresses?: outputs.network.GatewayCustomBgpIpAddressIpConfigurationResponse[];
/**
* Resource ID.
*/
readonly id?: string;
/**
* The ingress bytes transferred in this connection.
*/
readonly ingressBytesTransferred: number;
/**
* List of ingress NatRules.
*/
readonly ingressNatRules?: outputs.network.SubResourceResponse[];
/**
* The IPSec Policies to be considered by this connection.
*/
readonly ipsecPolicies?: outputs.network.IpsecPolicyResponse[];
/**
* The reference to local network gateway resource.
*/
readonly localNetworkGateway2?: outputs.network.LocalNetworkGatewayResponse;
/**
* Resource location.
*/
readonly location?: string;
/**
* Resource name.
*/
readonly name: string;
/**
* The reference to peerings resource.
*/
readonly peer?: outputs.network.SubResourceResponse;
/**
* The provisioning state of the virtual network gateway connection resource.
*/
readonly provisioningState: string;
/**
* The resource GUID property of the virtual network gateway connection resource.
*/
readonly resourceGuid: string;
/**
* The routing weight.
*/
readonly routingWeight?: number;
/**
* The IPSec shared key.
*/
readonly sharedKey?: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The Traffic Selector Policies to be considered by this connection.
*/
readonly trafficSelectorPolicies?: outputs.network.TrafficSelectorPolicyResponse[];
/**
* Collection of all tunnels' connection health status.
*/
readonly tunnelConnectionStatus: outputs.network.TunnelConnectionHealthResponse[];
/**
* Resource type.
*/
readonly type: string;
/**
* Use private local Azure IP for the connection.
*/
readonly useLocalAzureIpAddress?: boolean;
/**
* Enable policy-based traffic selectors.
*/
readonly usePolicyBasedTrafficSelectors?: boolean;
/**
* The reference to virtual network gateway resource.
*/
readonly virtualNetworkGateway1: outputs.network.VirtualNetworkGatewayResponse;
/**
* The reference to virtual network gateway resource.
*/
readonly virtualNetworkGateway2?: outputs.network.VirtualNetworkGatewayResponse;
}
/**
* Gets the specified virtual network gateway connection 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 getVirtualNetworkGatewayConnectionOutput(args: GetVirtualNetworkGatewayConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVirtualNetworkGatewayConnectionResult>;
export interface GetVirtualNetworkGatewayConnectionOutputArgs {
/**
* The name of the resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the virtual network gateway connection.
*/
virtualNetworkGatewayConnectionName: pulumi.Input<string>;
}