Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.1 published on Monday, Aug 15, 2022 by Pulumi

getP2sVpnGatewayP2sVpnConnectionHealth

P2SVpnGateway Resource. API Version: 2020-11-01.

Using getP2sVpnGatewayP2sVpnConnectionHealth

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getP2sVpnGatewayP2sVpnConnectionHealth(args: GetP2sVpnGatewayP2sVpnConnectionHealthArgs, opts?: InvokeOptions): Promise<GetP2sVpnGatewayP2sVpnConnectionHealthResult>
function getP2sVpnGatewayP2sVpnConnectionHealthOutput(args: GetP2sVpnGatewayP2sVpnConnectionHealthOutputArgs, opts?: InvokeOptions): Output<GetP2sVpnGatewayP2sVpnConnectionHealthResult>
def get_p2s_vpn_gateway_p2s_vpn_connection_health(gateway_name: Optional[str] = None,
                                                  resource_group_name: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetP2sVpnGatewayP2sVpnConnectionHealthResult
def get_p2s_vpn_gateway_p2s_vpn_connection_health_output(gateway_name: Optional[pulumi.Input[str]] = None,
                                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetP2sVpnGatewayP2sVpnConnectionHealthResult]
func GetP2sVpnGatewayP2sVpnConnectionHealth(ctx *Context, args *GetP2sVpnGatewayP2sVpnConnectionHealthArgs, opts ...InvokeOption) (*GetP2sVpnGatewayP2sVpnConnectionHealthResult, error)
func GetP2sVpnGatewayP2sVpnConnectionHealthOutput(ctx *Context, args *GetP2sVpnGatewayP2sVpnConnectionHealthOutputArgs, opts ...InvokeOption) GetP2sVpnGatewayP2sVpnConnectionHealthResultOutput

> Note: This function is named GetP2sVpnGatewayP2sVpnConnectionHealth in the Go SDK.

public static class GetP2sVpnGatewayP2sVpnConnectionHealth 
{
    public static Task<GetP2sVpnGatewayP2sVpnConnectionHealthResult> InvokeAsync(GetP2sVpnGatewayP2sVpnConnectionHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetP2sVpnGatewayP2sVpnConnectionHealthResult> Invoke(GetP2sVpnGatewayP2sVpnConnectionHealthInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetP2sVpnGatewayP2sVpnConnectionHealthResult> getP2sVpnGatewayP2sVpnConnectionHealth(GetP2sVpnGatewayP2sVpnConnectionHealthArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:network:getP2sVpnGatewayP2sVpnConnectionHealth
  Arguments:
    # Arguments dictionary

The following arguments are supported:

GatewayName string

The name of the P2SVpnGateway.

ResourceGroupName string

The name of the resource group.

GatewayName string

The name of the P2SVpnGateway.

ResourceGroupName string

The name of the resource group.

gatewayName String

The name of the P2SVpnGateway.

resourceGroupName String

The name of the resource group.

gatewayName string

The name of the P2SVpnGateway.

resourceGroupName string

The name of the resource group.

gateway_name str

The name of the P2SVpnGateway.

resource_group_name str

The name of the resource group.

gatewayName String

The name of the P2SVpnGateway.

resourceGroupName String

The name of the resource group.

getP2sVpnGatewayP2sVpnConnectionHealth Result

The following output properties are available:

Etag string

A unique read-only string that changes whenever the resource is updated.

Location string

Resource location.

Name string

Resource name.

ProvisioningState string

The provisioning state of the P2S VPN gateway resource.

Type string

Resource type.

VpnClientConnectionHealth Pulumi.AzureNative.Network.Outputs.VpnClientConnectionHealthResponse

All P2S VPN clients' connection health status.

CustomDnsServers List<string>

List of all customer specified DNS servers IP addresses.

Id string

Resource ID.

IsRoutingPreferenceInternet bool

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

P2SConnectionConfigurations List<Pulumi.AzureNative.Network.Outputs.P2SConnectionConfigurationResponse>

List of all p2s connection configurations of the gateway.

Tags Dictionary<string, string>

Resource tags.

VirtualHub Pulumi.AzureNative.Network.Outputs.SubResourceResponse

The VirtualHub to which the gateway belongs.

VpnGatewayScaleUnit int

The scale unit for this p2s vpn gateway.

VpnServerConfiguration Pulumi.AzureNative.Network.Outputs.SubResourceResponse

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

Etag string

A unique read-only string that changes whenever the resource is updated.

Location string

Resource location.

Name string

Resource name.

ProvisioningState string

The provisioning state of the P2S VPN gateway resource.

Type string

Resource type.

VpnClientConnectionHealth VpnClientConnectionHealthResponse

All P2S VPN clients' connection health status.

CustomDnsServers []string

List of all customer specified DNS servers IP addresses.

Id string

Resource ID.

IsRoutingPreferenceInternet bool

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

P2SConnectionConfigurations []P2SConnectionConfigurationResponse

List of all p2s connection configurations of the gateway.

Tags map[string]string

Resource tags.

VirtualHub SubResourceResponse

The VirtualHub to which the gateway belongs.

VpnGatewayScaleUnit int

The scale unit for this p2s vpn gateway.

VpnServerConfiguration SubResourceResponse

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

etag String

A unique read-only string that changes whenever the resource is updated.

location String

Resource location.

name String

Resource name.

provisioningState String

The provisioning state of the P2S VPN gateway resource.

type String

Resource type.

vpnClientConnectionHealth VpnClientConnectionHealthResponse

All P2S VPN clients' connection health status.

customDnsServers List<String>

List of all customer specified DNS servers IP addresses.

id String

Resource ID.

isRoutingPreferenceInternet Boolean

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

p2SConnectionConfigurations List<P2SConnectionConfigurationResponse>

List of all p2s connection configurations of the gateway.

tags Map<String,String>

Resource tags.

virtualHub SubResourceResponse

The VirtualHub to which the gateway belongs.

vpnGatewayScaleUnit Integer

The scale unit for this p2s vpn gateway.

vpnServerConfiguration SubResourceResponse

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

etag string

A unique read-only string that changes whenever the resource is updated.

location string

Resource location.

name string

Resource name.

provisioningState string

The provisioning state of the P2S VPN gateway resource.

type string

Resource type.

vpnClientConnectionHealth VpnClientConnectionHealthResponse

All P2S VPN clients' connection health status.

customDnsServers string[]

List of all customer specified DNS servers IP addresses.

id string

Resource ID.

isRoutingPreferenceInternet boolean

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

p2SConnectionConfigurations P2SConnectionConfigurationResponse[]

List of all p2s connection configurations of the gateway.

tags {[key: string]: string}

Resource tags.

virtualHub SubResourceResponse

The VirtualHub to which the gateway belongs.

vpnGatewayScaleUnit number

The scale unit for this p2s vpn gateway.

vpnServerConfiguration SubResourceResponse

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

etag str

A unique read-only string that changes whenever the resource is updated.

location str

Resource location.

name str

Resource name.

provisioning_state str

The provisioning state of the P2S VPN gateway resource.

type str

Resource type.

vpn_client_connection_health VpnClientConnectionHealthResponse

All P2S VPN clients' connection health status.

custom_dns_servers Sequence[str]

List of all customer specified DNS servers IP addresses.

id str

Resource ID.

is_routing_preference_internet bool

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

p2_s_connection_configurations Sequence[P2SConnectionConfigurationResponse]

List of all p2s connection configurations of the gateway.

tags Mapping[str, str]

Resource tags.

virtual_hub SubResourceResponse

The VirtualHub to which the gateway belongs.

vpn_gateway_scale_unit int

The scale unit for this p2s vpn gateway.

vpn_server_configuration SubResourceResponse

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

etag String

A unique read-only string that changes whenever the resource is updated.

location String

Resource location.

name String

Resource name.

provisioningState String

The provisioning state of the P2S VPN gateway resource.

type String

Resource type.

vpnClientConnectionHealth Property Map

All P2S VPN clients' connection health status.

customDnsServers List<String>

List of all customer specified DNS servers IP addresses.

id String

Resource ID.

isRoutingPreferenceInternet Boolean

Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.

p2SConnectionConfigurations List<Property Map>

List of all p2s connection configurations of the gateway.

tags Map<String>

Resource tags.

virtualHub Property Map

The VirtualHub to which the gateway belongs.

vpnGatewayScaleUnit Number

The scale unit for this p2s vpn gateway.

vpnServerConfiguration Property Map

The VpnServerConfiguration to which the p2sVpnGateway is attached to.

Supporting Types

AddressSpaceResponse

AddressPrefixes List<string>

A list of address blocks reserved for this virtual network in CIDR notation.

AddressPrefixes []string

A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes List<String>

A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes string[]

A list of address blocks reserved for this virtual network in CIDR notation.

address_prefixes Sequence[str]

A list of address blocks reserved for this virtual network in CIDR notation.

addressPrefixes List<String>

A list of address blocks reserved for this virtual network in CIDR notation.

P2SConnectionConfigurationResponse

Etag string

A unique read-only string that changes whenever the resource is updated.

ProvisioningState string

The provisioning state of the P2SConnectionConfiguration resource.

EnableInternetSecurity bool

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

Id string

Resource ID.

Name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

RoutingConfiguration Pulumi.AzureNative.Network.Inputs.RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

VpnClientAddressPool Pulumi.AzureNative.Network.Inputs.AddressSpaceResponse

The reference to the address space resource which represents Address space for P2S VpnClient.

Etag string

A unique read-only string that changes whenever the resource is updated.

ProvisioningState string

The provisioning state of the P2SConnectionConfiguration resource.

EnableInternetSecurity bool

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

Id string

Resource ID.

Name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

RoutingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

VpnClientAddressPool AddressSpaceResponse

The reference to the address space resource which represents Address space for P2S VpnClient.

etag String

A unique read-only string that changes whenever the resource is updated.

provisioningState String

The provisioning state of the P2SConnectionConfiguration resource.

enableInternetSecurity Boolean

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

id String

Resource ID.

name String

The name of the resource that is unique within a resource group. This name can be used to access the resource.

routingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

vpnClientAddressPool AddressSpaceResponse

The reference to the address space resource which represents Address space for P2S VpnClient.

etag string

A unique read-only string that changes whenever the resource is updated.

provisioningState string

The provisioning state of the P2SConnectionConfiguration resource.

enableInternetSecurity boolean

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

id string

Resource ID.

name string

The name of the resource that is unique within a resource group. This name can be used to access the resource.

routingConfiguration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

vpnClientAddressPool AddressSpaceResponse

The reference to the address space resource which represents Address space for P2S VpnClient.

etag str

A unique read-only string that changes whenever the resource is updated.

provisioning_state str

The provisioning state of the P2SConnectionConfiguration resource.

enable_internet_security bool

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

id str

Resource ID.

name str

The name of the resource that is unique within a resource group. This name can be used to access the resource.

routing_configuration RoutingConfigurationResponse

The Routing Configuration indicating the associated and propagated route tables on this connection.

vpn_client_address_pool AddressSpaceResponse

The reference to the address space resource which represents Address space for P2S VpnClient.

etag String

A unique read-only string that changes whenever the resource is updated.

provisioningState String

The provisioning state of the P2SConnectionConfiguration resource.

enableInternetSecurity Boolean

Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not.

id String

Resource ID.

name String

The name of the resource that is unique within a resource group. This name can be used to access the resource.

routingConfiguration Property Map

The Routing Configuration indicating the associated and propagated route tables on this connection.

vpnClientAddressPool Property Map

The reference to the address space resource which represents Address space for P2S VpnClient.

PropagatedRouteTableResponse

Ids List<Pulumi.AzureNative.Network.Inputs.SubResourceResponse>

The list of resource ids of all the RouteTables.

Labels List<string>

The list of labels.

Ids []SubResourceResponse

The list of resource ids of all the RouteTables.

Labels []string

The list of labels.

ids List<SubResourceResponse>

The list of resource ids of all the RouteTables.

labels List<String>

The list of labels.

ids SubResourceResponse[]

The list of resource ids of all the RouteTables.

labels string[]

The list of labels.

ids Sequence[SubResourceResponse]

The list of resource ids of all the RouteTables.

labels Sequence[str]

The list of labels.

ids List<Property Map>

The list of resource ids of all the RouteTables.

labels List<String>

The list of labels.

RoutingConfigurationResponse

AssociatedRouteTable Pulumi.AzureNative.Network.Inputs.SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

PropagatedRouteTables Pulumi.AzureNative.Network.Inputs.PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

VnetRoutes Pulumi.AzureNative.Network.Inputs.VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

AssociatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

PropagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

VnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnetRoutes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associated_route_table SubResourceResponse

The resource id RouteTable associated with this RoutingConfiguration.

propagated_route_tables PropagatedRouteTableResponse

The list of RouteTables to advertise the routes to.

vnet_routes VnetRouteResponse

List of routes that control routing from VirtualHub into a virtual network connection.

associatedRouteTable Property Map

The resource id RouteTable associated with this RoutingConfiguration.

propagatedRouteTables Property Map

The list of RouteTables to advertise the routes to.

vnetRoutes Property Map

List of routes that control routing from VirtualHub into a virtual network connection.

StaticRouteResponse

AddressPrefixes List<string>

List of all address prefixes.

Name string

The name of the StaticRoute that is unique within a VnetRoute.

NextHopIpAddress string

The ip address of the next hop.

AddressPrefixes []string

List of all address prefixes.

Name string

The name of the StaticRoute that is unique within a VnetRoute.

NextHopIpAddress string

The ip address of the next hop.

addressPrefixes List<String>

List of all address prefixes.

name String

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress String

The ip address of the next hop.

addressPrefixes string[]

List of all address prefixes.

name string

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress string

The ip address of the next hop.

address_prefixes Sequence[str]

List of all address prefixes.

name str

The name of the StaticRoute that is unique within a VnetRoute.

next_hop_ip_address str

The ip address of the next hop.

addressPrefixes List<String>

List of all address prefixes.

name String

The name of the StaticRoute that is unique within a VnetRoute.

nextHopIpAddress String

The ip address of the next hop.

SubResourceResponse

Id string

Resource ID.

Id string

Resource ID.

id String

Resource ID.

id string

Resource ID.

id str

Resource ID.

id String

Resource ID.

VnetRouteResponse

StaticRoutes []StaticRouteResponse

List of all Static Routes.

staticRoutes List<StaticRouteResponse>

List of all Static Routes.

staticRoutes StaticRouteResponse[]

List of all Static Routes.

staticRoutes List<Property Map>

List of all Static Routes.

VpnClientConnectionHealthResponse

TotalEgressBytesTransferred double

Total of the Egress Bytes Transferred in this connection.

TotalIngressBytesTransferred double

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

AllocatedIpAddresses List<string>

List of allocated ip addresses to the connected p2s vpn clients.

VpnClientConnectionsCount int

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

TotalEgressBytesTransferred float64

Total of the Egress Bytes Transferred in this connection.

TotalIngressBytesTransferred float64

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

AllocatedIpAddresses []string

List of allocated ip addresses to the connected p2s vpn clients.

VpnClientConnectionsCount int

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

totalEgressBytesTransferred Double

Total of the Egress Bytes Transferred in this connection.

totalIngressBytesTransferred Double

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

allocatedIpAddresses List<String>

List of allocated ip addresses to the connected p2s vpn clients.

vpnClientConnectionsCount Integer

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

totalEgressBytesTransferred number

Total of the Egress Bytes Transferred in this connection.

totalIngressBytesTransferred number

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

allocatedIpAddresses string[]

List of allocated ip addresses to the connected p2s vpn clients.

vpnClientConnectionsCount number

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

total_egress_bytes_transferred float

Total of the Egress Bytes Transferred in this connection.

total_ingress_bytes_transferred float

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

allocated_ip_addresses Sequence[str]

List of allocated ip addresses to the connected p2s vpn clients.

vpn_client_connections_count int

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

totalEgressBytesTransferred Number

Total of the Egress Bytes Transferred in this connection.

totalIngressBytesTransferred Number

Total of the Ingress Bytes Transferred in this P2S Vpn connection.

allocatedIpAddresses List<String>

List of allocated ip addresses to the connected p2s vpn clients.

vpnClientConnectionsCount Number

The total of p2s vpn clients connected at this time to this P2SVpnGateway.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0