VpnSitesOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:vpn_sites> attribute.
Constructor
VpnSitesOperations(*args, **kwargs)Methods
| begin_create_or_update |
Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite. |
| begin_delete |
Deletes a VpnSite. |
| get |
Retrieves the details of a VPN site. |
| list |
Lists all the VpnSites in a subscription. |
| list_by_resource_group |
Lists all the vpnSites in a resource group. |
| update_tags |
Updates VpnSite tags. |
begin_create_or_update
Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
begin_create_or_update(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.VpnSite, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VpnSite]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnSite. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being created or updated. Required. |
|
vpn_site_parameters
Required
|
Parameters supplied to create or update VpnSite. Is either a VpnSite type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either VpnSite or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes a VpnSite.
begin_delete(resource_group_name: str, vpn_site_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnSite. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being deleted. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Retrieves the details of a VPN site.
get(resource_group_name: str, vpn_site_name: str, **kwargs: Any) -> VpnSiteParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnSite. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being retrieved. Required. |
Returns
| Type | Description |
|---|---|
|
VpnSite or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Lists all the VpnSites in a subscription.
list(**kwargs: Any) -> Iterable[VpnSite]Returns
| Type | Description |
|---|---|
|
An iterator like instance of either VpnSite or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_resource_group
Lists all the vpnSites in a resource group.
list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[VpnSite]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnSite. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either VpnSite or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update_tags
Updates VpnSite tags.
update_tags(resource_group_name: str, vpn_site_name: str, vpn_site_parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.VpnSiteParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The resource group name of the VpnSite. Required. |
|
vpn_site_name
Required
|
The name of the VpnSite being updated. Required. |
|
vpn_site_parameters
Required
|
Parameters supplied to update VpnSite tags. Is either a TagsObject type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
VpnSite or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>