VpnLinkConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:vpn_link_connections> attribute.

Constructor

VpnLinkConnectionsOperations(*args, **kwargs)

Methods

begin_get_ike_sas	Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.
begin_reset_connection	Resets the VpnLink connection specified.
begin_set_or_init_default_shared_key	Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.
get_all_shared_keys	Lists all shared keys of VpnLink connection specified.
get_default_shared_key	Gets the shared key of VpnLink connection specified.
list_by_vpn_connection	Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.
list_default_shared_key	Gets the value of the shared key of VpnLink connection specified.

begin_get_ike_sas

Lists IKE Security Associations for Vpn Site Link Connection in the specified resource group.

begin_get_ike_sas(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_name: str, **kwargs: Any) -> LROPoller[str]

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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_reset_connection

Resets the VpnLink connection specified.

begin_reset_connection(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_set_or_init_default_shared_key

Sets or auto generates the shared key based on the user input. If users give a shared key value, it does the set operation. If key length is given, the operation creates a random key of the pre-defined length.

begin_set_or_init_default_shared_key(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_name: str, connection_shared_key_parameters: _models.ConnectionSharedKeyResult, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConnectionSharedKeyResult]

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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.
connection_shared_key_parameters Required	ConnectionSharedKeyResult or <xref:JSON> or IO[bytes] Parameters supplied to set or auto generate the shared key for the vpn link connection. Is one of the following types: ConnectionSharedKeyResult, JSON, IO[bytes] Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_all_shared_keys

Lists all shared keys of VpnLink connection specified.

get_all_shared_keys(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_name: str, **kwargs: Any) -> ItemPaged[ConnectionSharedKeyResult]

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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_default_shared_key

Gets the shared key of VpnLink connection specified.

get_default_shared_key(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_name: str, **kwargs: Any) -> ConnectionSharedKeyResult

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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.

Returns

Type	Description
ConnectionSharedKeyResult	ConnectionSharedKeyResult. The ConnectionSharedKeyResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_vpn_connection

Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.

list_by_vpn_connection(resource_group_name: str, gateway_name: str, connection_name: str, **kwargs: Any) -> ItemPaged[VpnSiteLinkConnection]

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.
connection_name Required	str The name of the vpn connection. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_default_shared_key

Gets the value of the shared key of VpnLink connection specified.

list_default_shared_key(resource_group_name: str, gateway_name: str, connection_name: str, link_connection_name: str, **kwargs: Any) -> ConnectionSharedKeyResult

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 vpn gateway. Required.
connection_name Required	str The name of the vpn connection. Required.
link_connection_name Required	str The name of the vpn link connection. Required.

Returns

Type	Description
ConnectionSharedKeyResult	ConnectionSharedKeyResult. The ConnectionSharedKeyResult is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

Commenti e suggerimenti

Questa pagina è stata utile?