Package com.azure.resourcemanager.network.fluent

Interface VpnSitesClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<VpnSiteInner>, InnerSupportsListing<VpnSiteInner>

public interface VpnSitesClient
extends InnerSupportsGet<VpnSiteInner>, InnerSupportsListing<VpnSiteInner>, InnerSupportsDelete<Void>

An instance of this class provides access to all the operations defined in VpnSitesClient.

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner>	beginCreateOrUpdate(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner>	beginCreateOrUpdate(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters, com.azure.core.util.Context context)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner>	beginCreateOrUpdateAsync(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String vpnSiteName)	Deletes a VpnSite.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String vpnSiteName, com.azure.core.util.Context context)	Deletes a VpnSite.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void>	beginDeleteAsync(String resourceGroupName, String vpnSiteName)	Deletes a VpnSite.
VpnSiteInner	createOrUpdate(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
VpnSiteInner	createOrUpdate(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters, com.azure.core.util.Context context)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
Mono<VpnSiteInner>	createOrUpdateAsync(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	createOrUpdateWithResponseAsync(String resourceGroupName, String vpnSiteName, VpnSiteInner vpnSiteParameters)	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
void	delete(String resourceGroupName, String vpnSiteName)	Deletes a VpnSite.
void	delete(String resourceGroupName, String vpnSiteName, com.azure.core.util.Context context)	Deletes a VpnSite.
Mono<Void>	deleteAsync(String resourceGroupName, String vpnSiteName)	Deletes a VpnSite.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	deleteWithResponseAsync(String resourceGroupName, String vpnSiteName)	Deletes a VpnSite.
VpnSiteInner	getByResourceGroup(String resourceGroupName, String vpnSiteName)	Retrieves the details of a VPN site.
Mono<VpnSiteInner>	getByResourceGroupAsync(String resourceGroupName, String vpnSiteName)	Retrieves the details of a VPN site.
com.azure.core.http.rest.Response<VpnSiteInner>	getByResourceGroupWithResponse(String resourceGroupName, String vpnSiteName, com.azure.core.util.Context context)	Retrieves the details of a VPN site.
Mono<com.azure.core.http.rest.Response<VpnSiteInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String vpnSiteName)	Retrieves the details of a VPN site.
com.azure.core.http.rest.PagedIterable<VpnSiteInner>	list()	Lists all the VpnSites in a subscription.
com.azure.core.http.rest.PagedIterable<VpnSiteInner>	list(com.azure.core.util.Context context)	Lists all the VpnSites in a subscription.
com.azure.core.http.rest.PagedFlux<VpnSiteInner>	listAsync()	Lists all the VpnSites in a subscription.
com.azure.core.http.rest.PagedIterable<VpnSiteInner>	listByResourceGroup(String resourceGroupName)	Lists all the vpnSites in a resource group.
com.azure.core.http.rest.PagedIterable<VpnSiteInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Lists all the vpnSites in a resource group.
com.azure.core.http.rest.PagedFlux<VpnSiteInner>	listByResourceGroupAsync(String resourceGroupName)	Lists all the vpnSites in a resource group.
VpnSiteInner	updateTags(String resourceGroupName, String vpnSiteName, TagsObject vpnSiteParameters)	Updates VpnSite tags.
Mono<VpnSiteInner>	updateTagsAsync(String resourceGroupName, String vpnSiteName, TagsObject vpnSiteParameters)	Updates VpnSite tags.
com.azure.core.http.rest.Response<VpnSiteInner>	updateTagsWithResponse(String resourceGroupName, String vpnSiteName, TagsObject vpnSiteParameters, com.azure.core.util.Context context)	Updates VpnSite tags.
Mono<com.azure.core.http.rest.Response<VpnSiteInner>>	updateTagsWithResponseAsync(String resourceGroupName, String vpnSiteName, TagsObject vpnSiteParameters)	Updates VpnSite tags.

Method Detail

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<VpnSiteInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                          String vpnSiteName)

Retrieves the details of a VPN site.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being retrieved.

Returns:

vpnSite Resource along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupAsync

Mono<VpnSiteInner> getByResourceGroupAsync(String resourceGroupName,
                                           String vpnSiteName)

Retrieves the details of a VPN site.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<VpnSiteInner>

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being retrieved.

Returns:

vpnSite Resource on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

VpnSiteInner getByResourceGroup(String resourceGroupName,
                                String vpnSiteName)

Retrieves the details of a VPN site.

Specified by:

getByResourceGroup in interface InnerSupportsGet<VpnSiteInner>

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being retrieved.

Returns:

vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<VpnSiteInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                               String vpnSiteName,
                                                                               com.azure.core.util.Context context)

Retrieves the details of a VPN site.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being retrieved.

context - The context to associate with this operation.

Returns:

vpnSite Resource along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                          String vpnSiteName,
                                                                                          VpnSiteInner vpnSiteParameters)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

Returns:

vpnSite Resource along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdateAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner> beginCreateOrUpdateAsync(String resourceGroupName,
                                                                                                                                               String vpnSiteName,
                                                                                                                                               VpnSiteInner vpnSiteParameters)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

Returns:

the PollerFlux for polling of vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                          String vpnSiteName,
                                                                                                                                          VpnSiteInner vpnSiteParameters)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

Returns:

the SyncPoller for polling of vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginCreateOrUpdate

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<VpnSiteInner>,VpnSiteInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                          String vpnSiteName,
                                                                                                                                          VpnSiteInner vpnSiteParameters,
                                                                                                                                          com.azure.core.util.Context context)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateAsync

Mono<VpnSiteInner> createOrUpdateAsync(String resourceGroupName,
                                       String vpnSiteName,
                                       VpnSiteInner vpnSiteParameters)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

Returns:

vpnSite Resource on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

VpnSiteInner createOrUpdate(String resourceGroupName,
                            String vpnSiteName,
                            VpnSiteInner vpnSiteParameters)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

Returns:

vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

VpnSiteInner createOrUpdate(String resourceGroupName,
                            String vpnSiteName,
                            VpnSiteInner vpnSiteParameters,
                            com.azure.core.util.Context context)

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being created or updated.

vpnSiteParameters - Parameters supplied to create or update VpnSite.

context - The context to associate with this operation.

Returns:

vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTagsWithResponseAsync

Mono<com.azure.core.http.rest.Response<VpnSiteInner>> updateTagsWithResponseAsync(String resourceGroupName,
                                                                                  String vpnSiteName,
                                                                                  TagsObject vpnSiteParameters)

Updates VpnSite tags.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being updated.

vpnSiteParameters - Parameters supplied to update VpnSite tags.

Returns:

vpnSite Resource along with Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTagsAsync

Mono<VpnSiteInner> updateTagsAsync(String resourceGroupName,
                                   String vpnSiteName,
                                   TagsObject vpnSiteParameters)

Updates VpnSite tags.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being updated.

vpnSiteParameters - Parameters supplied to update VpnSite tags.

Returns:

vpnSite Resource on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTags

VpnSiteInner updateTags(String resourceGroupName,
                        String vpnSiteName,
                        TagsObject vpnSiteParameters)

Updates VpnSite tags.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being updated.

vpnSiteParameters - Parameters supplied to update VpnSite tags.

Returns:

vpnSite Resource.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTagsWithResponse

com.azure.core.http.rest.Response<VpnSiteInner> updateTagsWithResponse(String resourceGroupName,
                                                                       String vpnSiteName,
                                                                       TagsObject vpnSiteParameters,
                                                                       com.azure.core.util.Context context)

Updates VpnSite tags.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being updated.

vpnSiteParameters - Parameters supplied to update VpnSite tags.

context - The context to associate with this operation.

Returns:

vpnSite Resource along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponseAsync

Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName,
                                                                                  String vpnSiteName)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

Returns:

the Response on successful completion of Mono.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDeleteAsync

com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName,
                                                                                                                       String vpnSiteName)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

Returns:

the PollerFlux for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String vpnSiteName)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

beginDelete

com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName,
                                                                                                                  String vpnSiteName,
                                                                                                                  com.azure.core.util.Context context)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of long-running operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteAsync

Mono<Void> deleteAsync(String resourceGroupName,
                       String vpnSiteName)

Deletes a VpnSite.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

Returns:

A Mono that completes when a successful response is received.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String vpnSiteName)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String vpnSiteName,
            com.azure.core.util.Context context)

Deletes a VpnSite.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

vpnSiteName - The name of the VpnSite being deleted.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroupAsync

com.azure.core.http.rest.PagedFlux<VpnSiteInner> listByResourceGroupAsync(String resourceGroupName)

Lists all the vpnSites in a resource group.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<VpnSiteInner>

Parameters:

resourceGroupName - The resource group name of the VpnSite.

Returns:

result of the request to list VpnSites as paginated response with PagedFlux.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<VpnSiteInner> listByResourceGroup(String resourceGroupName)

Lists all the vpnSites in a resource group.

Specified by:

listByResourceGroup in interface InnerSupportsListing<VpnSiteInner>

Parameters:

resourceGroupName - The resource group name of the VpnSite.

Returns:

result of the request to list VpnSites as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<VpnSiteInner> listByResourceGroup(String resourceGroupName,
                                                                         com.azure.core.util.Context context)

Lists all the vpnSites in a resource group.

Parameters:

resourceGroupName - The resource group name of the VpnSite.

context - The context to associate with this operation.

Returns:

result of the request to list VpnSites as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listAsync

com.azure.core.http.rest.PagedFlux<VpnSiteInner> listAsync()

Lists all the VpnSites in a subscription.

Specified by:

listAsync in interface InnerSupportsListing<VpnSiteInner>

Returns:

result of the request to list VpnSites as paginated response with PagedFlux.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<VpnSiteInner> list()

Lists all the VpnSites in a subscription.

Specified by:

list in interface InnerSupportsListing<VpnSiteInner>

Returns:

result of the request to list VpnSites as paginated response with PagedIterable.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

list

com.azure.core.http.rest.PagedIterable<VpnSiteInner> list(com.azure.core.util.Context context)

Lists all the VpnSites in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

result of the request to list VpnSites as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.