VpnLinkConnectionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:vpn_link_connections> attribute.
- Inheritance
-
builtins.objectVpnLinkConnectionsOperations
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
|
The name of the resource group. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either str or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The resource group name of the VpnGateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
|
connection_shared_key_parameters
Required
|
Parameters supplied to set or auto generate the shared key for the vpn link connection. Is either a ConnectionSharedKeyResult type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either ConnectionSharedKeyResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[ConnectionSharedKeyResult]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ConnectionSharedKeyResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ConnectionSharedKeyResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
Returns
| Type | Description |
|---|---|
|
ConnectionSharedKeyResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> Iterable[VpnSiteLinkConnection]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the vpn gateway. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either VpnSiteLinkConnection or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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) -> ConnectionSharedKeyResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
gateway_name
Required
|
The name of the gateway. Required. |
|
connection_name
Required
|
The name of the vpn connection. Required. |
|
link_connection_name
Required
|
The name of the vpn link connection. Required. |
Returns
| Type | Description |
|---|---|
|
ConnectionSharedKeyResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>
Azure SDK for Python