VpnSiteLinksOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:vpn_site_links> attribute.
Constructor
VpnSiteLinksOperations(*args, **kwargs)
Methods
| get |
Retrieves the details of a VPN site link. |
| list_by_vpn_site |
Lists all the vpnSiteLinks in a resource group for a vpn site. |
get
Retrieves the details of a VPN site link.
get(resource_group_name: str, vpn_site_name: str, vpn_site_link_name: str, **kwargs: Any) -> VpnSiteLink
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being retrieved. Required. |
|
vpn_site_link_name
Required
|
The name of the resource that is unique within a resource group. This name can be used to access the resource. Required. |
Returns
| Type | Description |
|---|---|
|
VpnSiteLink. The VpnSiteLink is compatible with MutableMapping |
Exceptions
| Type | Description |
|---|---|
list_by_vpn_site
Lists all the vpnSiteLinks in a resource group for a vpn site.
list_by_vpn_site(resource_group_name: str, vpn_site_name: str, **kwargs: Any) -> ItemPaged[VpnSiteLink]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being retrieved. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of VpnSiteLink |
Exceptions
| Type | Description |
|---|---|