Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
azure-native.network.getP2sVpnGateway
Explore with Pulumi AI
Retrieves the details of a virtual wan p2s vpn gateway. API Version: 2020-11-01.
Using getP2sVpnGateway
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 getP2sVpnGateway(args: GetP2sVpnGatewayArgs, opts?: InvokeOptions): Promise<GetP2sVpnGatewayResult>
function getP2sVpnGatewayOutput(args: GetP2sVpnGatewayOutputArgs, opts?: InvokeOptions): Output<GetP2sVpnGatewayResult>
def get_p2s_vpn_gateway(gateway_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetP2sVpnGatewayResult
def get_p2s_vpn_gateway_output(gateway_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetP2sVpnGatewayResult]
func LookupP2sVpnGateway(ctx *Context, args *LookupP2sVpnGatewayArgs, opts ...InvokeOption) (*LookupP2sVpnGatewayResult, error)
func LookupP2sVpnGatewayOutput(ctx *Context, args *LookupP2sVpnGatewayOutputArgs, opts ...InvokeOption) LookupP2sVpnGatewayResultOutput
> Note: This function is named LookupP2sVpnGateway
in the Go SDK.
public static class GetP2sVpnGateway
{
public static Task<GetP2sVpnGatewayResult> InvokeAsync(GetP2sVpnGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetP2sVpnGatewayResult> Invoke(GetP2sVpnGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetP2sVpnGatewayResult> getP2sVpnGateway(GetP2sVpnGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:network:getP2sVpnGateway
arguments:
# arguments dictionary
The following arguments are supported:
- Gateway
Name string The name of the gateway.
- Resource
Group stringName The resource group name of the P2SVpnGateway.
- Gateway
Name string The name of the gateway.
- Resource
Group stringName The resource group name of the P2SVpnGateway.
- gateway
Name String The name of the gateway.
- resource
Group StringName The resource group name of the P2SVpnGateway.
- gateway
Name string The name of the gateway.
- resource
Group stringName The resource group name of the P2SVpnGateway.
- gateway_
name str The name of the gateway.
- resource_
group_ strname The resource group name of the P2SVpnGateway.
- gateway
Name String The name of the gateway.
- resource
Group StringName The resource group name of the P2SVpnGateway.
getP2sVpnGateway 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.
- Provisioning
State string The provisioning state of the P2S VPN gateway resource.
- Type string
Resource type.
- Vpn
Client Pulumi.Connection Health Azure Native. Network. Outputs. Vpn Client Connection Health Response All P2S VPN clients' connection health status.
- Custom
Dns List<string>Servers List of all customer specified DNS servers IP addresses.
- Id string
Resource ID.
- Is
Routing boolPreference Internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- P2SConnection
Configurations List<Pulumi.Azure Native. Network. Outputs. P2SConnection Configuration Response> List of all p2s connection configurations of the gateway.
- Dictionary<string, string>
Resource tags.
- Virtual
Hub Pulumi.Azure Native. Network. Outputs. Sub Resource Response The VirtualHub to which the gateway belongs.
- Vpn
Gateway intScale Unit The scale unit for this p2s vpn gateway.
- Vpn
Server Pulumi.Configuration Azure Native. Network. Outputs. Sub Resource Response 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.
- Provisioning
State string The provisioning state of the P2S VPN gateway resource.
- Type string
Resource type.
- Vpn
Client VpnConnection Health Client Connection Health Response All P2S VPN clients' connection health status.
- Custom
Dns []stringServers List of all customer specified DNS servers IP addresses.
- Id string
Resource ID.
- Is
Routing boolPreference Internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- P2SConnection
Configurations []P2SConnectionConfiguration Response List of all p2s connection configurations of the gateway.
- map[string]string
Resource tags.
- Virtual
Hub SubResource Response The VirtualHub to which the gateway belongs.
- Vpn
Gateway intScale Unit The scale unit for this p2s vpn gateway.
- Vpn
Server SubConfiguration Resource Response 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.
- provisioning
State String The provisioning state of the P2S VPN gateway resource.
- type String
Resource type.
- vpn
Client VpnConnection Health Client Connection Health Response All P2S VPN clients' connection health status.
- custom
Dns List<String>Servers List of all customer specified DNS servers IP addresses.
- id String
Resource ID.
- is
Routing BooleanPreference Internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- p2SConnection
Configurations List<P2SConnectionConfiguration Response> List of all p2s connection configurations of the gateway.
- Map<String,String>
Resource tags.
- virtual
Hub SubResource Response The VirtualHub to which the gateway belongs.
- vpn
Gateway IntegerScale Unit The scale unit for this p2s vpn gateway.
- vpn
Server SubConfiguration Resource Response 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.
- provisioning
State string The provisioning state of the P2S VPN gateway resource.
- type string
Resource type.
- vpn
Client VpnConnection Health Client Connection Health Response All P2S VPN clients' connection health status.
- custom
Dns string[]Servers List of all customer specified DNS servers IP addresses.
- id string
Resource ID.
- is
Routing booleanPreference Internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- p2SConnection
Configurations P2SConnectionConfiguration Response[] List of all p2s connection configurations of the gateway.
- {[key: string]: string}
Resource tags.
- virtual
Hub SubResource Response The VirtualHub to which the gateway belongs.
- vpn
Gateway numberScale Unit The scale unit for this p2s vpn gateway.
- vpn
Server SubConfiguration Resource Response 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_ Vpnconnection_ health Client Connection Health Response All P2S VPN clients' connection health status.
- custom_
dns_ Sequence[str]servers List of all customer specified DNS servers IP addresses.
- id str
Resource ID.
- is_
routing_ boolpreference_ internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- p2_
s_ Sequence[P2SConnectionconnection_ configurations Configuration Response] List of all p2s connection configurations of the gateway.
- Mapping[str, str]
Resource tags.
- virtual_
hub SubResource Response The VirtualHub to which the gateway belongs.
- vpn_
gateway_ intscale_ unit The scale unit for this p2s vpn gateway.
- vpn_
server_ Subconfiguration Resource Response 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.
- provisioning
State String The provisioning state of the P2S VPN gateway resource.
- type String
Resource type.
- vpn
Client Property MapConnection Health All P2S VPN clients' connection health status.
- custom
Dns List<String>Servers List of all customer specified DNS servers IP addresses.
- id String
Resource ID.
- is
Routing BooleanPreference Internet Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway.
- p2SConnection
Configurations List<Property Map> List of all p2s connection configurations of the gateway.
- Map<String>
Resource tags.
- virtual
Hub Property Map The VirtualHub to which the gateway belongs.
- vpn
Gateway NumberScale Unit The scale unit for this p2s vpn gateway.
- vpn
Server Property MapConfiguration The VpnServerConfiguration to which the p2sVpnGateway is attached to.
Supporting Types
AddressSpaceResponse
- Address
Prefixes List<string> A list of address blocks reserved for this virtual network in CIDR notation.
- Address
Prefixes []string A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes List<String> A list of address blocks reserved for this virtual network in CIDR notation.
- address
Prefixes 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.
- address
Prefixes 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.
- Provisioning
State string The provisioning state of the P2SConnectionConfiguration resource.
- Enable
Internet boolSecurity 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.
- Routing
Configuration Pulumi.Azure Native. Network. Inputs. Routing Configuration Response The Routing Configuration indicating the associated and propagated route tables on this connection.
- Vpn
Client Pulumi.Address Pool Azure Native. Network. Inputs. Address Space Response 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.
- Provisioning
State string The provisioning state of the P2SConnectionConfiguration resource.
- Enable
Internet boolSecurity 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.
- Routing
Configuration RoutingConfiguration Response The Routing Configuration indicating the associated and propagated route tables on this connection.
- Vpn
Client AddressAddress Pool Space Response 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.
- provisioning
State String The provisioning state of the P2SConnectionConfiguration resource.
- enable
Internet BooleanSecurity 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.
- routing
Configuration RoutingConfiguration Response The Routing Configuration indicating the associated and propagated route tables on this connection.
- vpn
Client AddressAddress Pool Space Response 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.
- provisioning
State string The provisioning state of the P2SConnectionConfiguration resource.
- enable
Internet booleanSecurity 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.
- routing
Configuration RoutingConfiguration Response The Routing Configuration indicating the associated and propagated route tables on this connection.
- vpn
Client AddressAddress Pool Space Response 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_ boolsecurity 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 RoutingConfiguration Response The Routing Configuration indicating the associated and propagated route tables on this connection.
- vpn_
client_ Addressaddress_ pool Space Response 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.
- provisioning
State String The provisioning state of the P2SConnectionConfiguration resource.
- enable
Internet BooleanSecurity 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.
- routing
Configuration Property Map The Routing Configuration indicating the associated and propagated route tables on this connection.
- vpn
Client Property MapAddress Pool The reference to the address space resource which represents Address space for P2S VpnClient.
PropagatedRouteTableResponse
- Ids
List<Pulumi.
Azure Native. Network. Inputs. Sub Resource Response> The list of resource ids of all the RouteTables.
- Labels List<string>
The list of labels.
- Ids
[]Sub
Resource Response The list of resource ids of all the RouteTables.
- Labels []string
The list of labels.
- ids
List<Sub
Resource Response> The list of resource ids of all the RouteTables.
- labels List<String>
The list of labels.
- ids
Sub
Resource Response[] The list of resource ids of all the RouteTables.
- labels string[]
The list of labels.
- ids
Sequence[Sub
Resource Response] 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
- Associated
Route Pulumi.Table Azure Native. Network. Inputs. Sub Resource Response The resource id RouteTable associated with this RoutingConfiguration.
- Propagated
Route Pulumi.Tables Azure Native. Network. Inputs. Propagated Route Table Response The list of RouteTables to advertise the routes to.
- Vnet
Routes Pulumi.Azure Native. Network. Inputs. Vnet Route Response List of routes that control routing from VirtualHub into a virtual network connection.
- Associated
Route SubTable Resource Response The resource id RouteTable associated with this RoutingConfiguration.
- Propagated
Route PropagatedTables Route Table Response The list of RouteTables to advertise the routes to.
- Vnet
Routes VnetRoute Response List of routes that control routing from VirtualHub into a virtual network connection.
- associated
Route SubTable Resource Response The resource id RouteTable associated with this RoutingConfiguration.
- propagated
Route PropagatedTables Route Table Response The list of RouteTables to advertise the routes to.
- vnet
Routes VnetRoute Response List of routes that control routing from VirtualHub into a virtual network connection.
- associated
Route SubTable Resource Response The resource id RouteTable associated with this RoutingConfiguration.
- propagated
Route PropagatedTables Route Table Response The list of RouteTables to advertise the routes to.
- vnet
Routes VnetRoute Response List of routes that control routing from VirtualHub into a virtual network connection.
- associated_
route_ Subtable Resource Response The resource id RouteTable associated with this RoutingConfiguration.
- propagated_
route_ Propagatedtables Route Table Response The list of RouteTables to advertise the routes to.
- vnet_
routes VnetRoute Response List of routes that control routing from VirtualHub into a virtual network connection.
- associated
Route Property MapTable The resource id RouteTable associated with this RoutingConfiguration.
- propagated
Route Property MapTables The list of RouteTables to advertise the routes to.
- vnet
Routes Property Map List of routes that control routing from VirtualHub into a virtual network connection.
StaticRouteResponse
- Address
Prefixes List<string> List of all address prefixes.
- Name string
The name of the StaticRoute that is unique within a VnetRoute.
- Next
Hop stringIp Address The ip address of the next hop.
- Address
Prefixes []string List of all address prefixes.
- Name string
The name of the StaticRoute that is unique within a VnetRoute.
- Next
Hop stringIp Address The ip address of the next hop.
- address
Prefixes List<String> List of all address prefixes.
- name String
The name of the StaticRoute that is unique within a VnetRoute.
- next
Hop StringIp Address The ip address of the next hop.
- address
Prefixes string[] List of all address prefixes.
- name string
The name of the StaticRoute that is unique within a VnetRoute.
- next
Hop stringIp Address 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_ strip_ address The ip address of the next hop.
- address
Prefixes List<String> List of all address prefixes.
- name String
The name of the StaticRoute that is unique within a VnetRoute.
- next
Hop StringIp Address 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
- Static
Routes List<Pulumi.Azure Native. Network. Inputs. Static Route Response> List of all Static Routes.
- Static
Routes []StaticRoute Response List of all Static Routes.
- static
Routes List<StaticRoute Response> List of all Static Routes.
- static
Routes StaticRoute Response[] List of all Static Routes.
- static_
routes Sequence[StaticRoute Response] List of all Static Routes.
- static
Routes List<Property Map> List of all Static Routes.
VpnClientConnectionHealthResponse
- Total
Egress doubleBytes Transferred Total of the Egress Bytes Transferred in this connection.
- Total
Ingress doubleBytes Transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- Allocated
Ip List<string>Addresses List of allocated ip addresses to the connected p2s vpn clients.
- Vpn
Client intConnections Count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
- Total
Egress float64Bytes Transferred Total of the Egress Bytes Transferred in this connection.
- Total
Ingress float64Bytes Transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- Allocated
Ip []stringAddresses List of allocated ip addresses to the connected p2s vpn clients.
- Vpn
Client intConnections Count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
- total
Egress DoubleBytes Transferred Total of the Egress Bytes Transferred in this connection.
- total
Ingress DoubleBytes Transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- allocated
Ip List<String>Addresses List of allocated ip addresses to the connected p2s vpn clients.
- vpn
Client IntegerConnections Count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
- total
Egress numberBytes Transferred Total of the Egress Bytes Transferred in this connection.
- total
Ingress numberBytes Transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- allocated
Ip string[]Addresses List of allocated ip addresses to the connected p2s vpn clients.
- vpn
Client numberConnections Count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
- total_
egress_ floatbytes_ transferred Total of the Egress Bytes Transferred in this connection.
- total_
ingress_ floatbytes_ transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- allocated_
ip_ Sequence[str]addresses List of allocated ip addresses to the connected p2s vpn clients.
- vpn_
client_ intconnections_ count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
- total
Egress NumberBytes Transferred Total of the Egress Bytes Transferred in this connection.
- total
Ingress NumberBytes Transferred Total of the Ingress Bytes Transferred in this P2S Vpn connection.
- allocated
Ip List<String>Addresses List of allocated ip addresses to the connected p2s vpn clients.
- vpn
Client NumberConnections Count The total of p2s vpn clients connected at this time to this P2SVpnGateway.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0