P2SVpnGatewaysOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:p2_svpn_gateways> attribute.

Constructor

P2SVpnGatewaysOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.
begin_delete	Deletes a virtual wan p2s vpn gateway.
begin_disconnect_p2_s_vpn_connections	Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.
begin_generate_vpn_profile	Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.
begin_get_p2_s_vpn_connection_health	Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
begin_get_p2_s_vpn_connection_health_detailed	Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.
begin_reset	Resets the primary of the p2s vpn gateway in the specified resource group.
begin_update_tags	Updates virtual wan p2s vpn gateway tags.
get	Retrieves the details of a virtual wan p2s vpn gateway.
list	Lists all the P2SVpnGateways in a subscription.
list_by_resource_group	Lists all the P2SVpnGateways in a resource group.

begin_create_or_update

Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.

begin_create_or_update(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: _models.P2SVpnGateway, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.P2SVpnGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.
p2_s_vpn_gateway_parameters Required	P2SVpnGateway or P2SVpnGateway or IO[bytes] Parameters supplied to create or Update a virtual wan p2s vpn gateway. Is either a P2SVpnGateway type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[P2SVpnGateway]	An instance of LROPoller that returns P2SVpnGateway. The P2SVpnGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a virtual wan p2s vpn gateway.

begin_delete(resource_group_name: str, gateway_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_disconnect_p2_s_vpn_connections

Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.

begin_disconnect_p2_s_vpn_connections(resource_group_name: str, p2_s_vpn_gateway_name: str, request: _models.P2SVpnConnectionRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
p2_s_vpn_gateway_name Required	str The name of the P2S Vpn Gateway. Required.
request Required	P2SVpnConnectionRequest or P2SVpnConnectionRequest or IO[bytes] The parameters are supplied to disconnect p2s vpn connections. Is either a P2SVpnConnectionRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_generate_vpn_profile

Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.

begin_generate_vpn_profile(resource_group_name: str, gateway_name: str, parameters: _models.P2SVpnProfileParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnProfileResponse]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.
parameters Required	P2SVpnProfileParameters or P2SVpnProfileParameters or IO[bytes] Parameters supplied to the generate P2SVpnGateway VPN client package operation. Is either a P2SVpnProfileParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[VpnProfileResponse]	An instance of LROPoller that returns VpnProfileResponse. The VpnProfileResponse is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_get_p2_s_vpn_connection_health

Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

begin_get_p2_s_vpn_connection_health(resource_group_name: str, gateway_name: str, **kwargs: Any) -> LROPoller[P2SVpnGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
LROPoller[P2SVpnGateway]	An instance of LROPoller that returns P2SVpnGateway. The P2SVpnGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_get_p2_s_vpn_connection_health_detailed

Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.

begin_get_p2_s_vpn_connection_health_detailed(resource_group_name: str, gateway_name: str, request: _models.P2SVpnConnectionHealthRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.P2SVpnConnectionHealth]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.
request Required	P2SVpnConnectionHealthRequest or P2SVpnConnectionHealthRequest or IO[bytes] Request parameters supplied to get p2s vpn connections detailed health. Is either a P2SVpnConnectionHealthRequest type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[P2SVpnConnectionHealth]	An instance of LROPoller that returns P2SVpnConnectionHealth. The P2SVpnConnectionHealth is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_reset

Resets the primary of the p2s vpn gateway in the specified resource group.

begin_reset(resource_group_name: str, gateway_name: str, **kwargs: Any) -> LROPoller[P2SVpnGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
LROPoller[P2SVpnGateway]	An instance of LROPoller that returns P2SVpnGateway. The P2SVpnGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_update_tags

Updates virtual wan p2s vpn gateway tags.

begin_update_tags(resource_group_name: str, gateway_name: str, p2_s_vpn_gateway_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.P2SVpnGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.
p2_s_vpn_gateway_parameters Required	TagsObject or TagsObject or IO[bytes] Parameters supplied to update a virtual wan p2s vpn gateway tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[P2SVpnGateway]	An instance of LROPoller that returns P2SVpnGateway. The P2SVpnGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Retrieves the details of a virtual wan p2s vpn gateway.

get(resource_group_name: str, gateway_name: str, **kwargs: Any) -> P2SVpnGateway

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
gateway_name Required	str The name of the gateway. Required.

Returns

Type	Description
P2SVpnGateway	P2SVpnGateway. The P2SVpnGateway is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Lists all the P2SVpnGateways in a subscription.

list(**kwargs: Any) -> ItemPaged[P2SVpnGateway]

Returns

Type	Description
ItemPaged[P2SVpnGateway]	An iterator like instance of P2SVpnGateway

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Lists all the P2SVpnGateways in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> ItemPaged[P2SVpnGateway]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.

Returns

Type	Description
ItemPaged[P2SVpnGateway]	An iterator like instance of P2SVpnGateway

Exceptions

Type	Description
HttpResponseError

フィードバック

このページはお役に立ちましたか?