com.microsoft.azure.management.network

Interface VirtualNetworkGatewayOperations

All Known Implementing Classes:

VirtualNetworkGatewayOperationsImpl

public interface VirtualNetworkGatewayOperations

The Network Resource Provider API includes operations for managing the Virtual network Gateway for your subscription.

Method Summary

Modifier and Type	Method and Description
VirtualNetworkGatewayPutResponse	beginCreateOrUpdating(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.
Future<VirtualNetworkGatewayPutResponse>	beginCreateOrUpdatingAsync(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.
UpdateOperationResponse	beginDeleting(String resourceGroupName, String virtualNetworkGatewayName) The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.
Future<UpdateOperationResponse>	beginDeletingAsync(String resourceGroupName, String virtualNetworkGatewayName) The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.
VirtualNetworkGatewayPutResponse	beginReset(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the specified resource group through Network resource provider.
Future<VirtualNetworkGatewayPutResponse>	beginResetAsync(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the specified resource group through Network resource provider.
AzureAsyncOperationResponse	createOrUpdate(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.
Future<AzureAsyncOperationResponse>	createOrUpdateAsync(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.
OperationResponse	delete(String resourceGroupName, String virtualNetworkGatewayName) The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.
Future<OperationResponse>	deleteAsync(String resourceGroupName, String virtualNetworkGatewayName) The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.
VirtualNetworkGatewayGetResponse	get(String resourceGroupName, String virtualNetworkGatewayName) The Get VirtualNetworkGateway operation retrieves information about the specified virtual network gateway through Network resource provider.
Future<VirtualNetworkGatewayGetResponse>	getAsync(String resourceGroupName, String virtualNetworkGatewayName) The Get VirtualNetworkGateway operation retrieves information about the specified virtual network gateway through Network resource provider.
VirtualNetworkGatewayListResponse	list(String resourceGroupName) The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.
Future<VirtualNetworkGatewayListResponse>	listAsync(String resourceGroupName) The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.
AzureAsyncOperationResponse	reset(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in the specified resource group through Network resource provider.
Future<AzureAsyncOperationResponse>	resetAsync(String resourceGroupName, String virtualNetworkGatewayName, VirtualNetworkGateway parameters) The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in the specified resource group through Network resource provider.

Method Detail

beginCreateOrUpdating

VirtualNetworkGatewayPutResponse beginCreateOrUpdating(String resourceGroupName,
                                                       String virtualNetworkGatewayName,
                                                       VirtualNetworkGateway parameters)
                                                throws IOException,
                                                       ServiceException

The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Create or update Virtual Network Gateway operation through Network resource provider.

Returns:

Response for PutVirtualNetworkGateway Api servive call

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginCreateOrUpdatingAsync

Future<VirtualNetworkGatewayPutResponse> beginCreateOrUpdatingAsync(String resourceGroupName,
                                                                    String virtualNetworkGatewayName,
                                                                    VirtualNetworkGateway parameters)

The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Create or update Virtual Network Gateway operation through Network resource provider.

Returns:

Response for PutVirtualNetworkGateway Api servive call

beginDeleting

UpdateOperationResponse beginDeleting(String resourceGroupName,
                                      String virtualNetworkGatewayName)
                               throws IOException,
                                      ServiceException

The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

If the resource provide needs to return an error to any operation, it should return the appropriate HTTP error code and a message body as can be seen below.The message should be localized per the Accept-Language header specified in the original request such thatit could be directly be exposed to users

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginDeletingAsync

Future<UpdateOperationResponse> beginDeletingAsync(String resourceGroupName,
                                                   String virtualNetworkGatewayName)

The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

If the resource provide needs to return an error to any operation, it should return the appropriate HTTP error code and a message body as can be seen below.The message should be localized per the Accept-Language header specified in the original request such thatit could be directly be exposed to users

beginReset

VirtualNetworkGatewayPutResponse beginReset(String resourceGroupName,
                                            String virtualNetworkGatewayName,
                                            VirtualNetworkGateway parameters)
                                     throws IOException,
                                            ServiceException

The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Reset Virtual Network Gateway operation through Network resource provider.

Returns:

Response for PutVirtualNetworkGateway Api servive call

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

beginResetAsync

Future<VirtualNetworkGatewayPutResponse> beginResetAsync(String resourceGroupName,
                                                         String virtualNetworkGatewayName,
                                                         VirtualNetworkGateway parameters)

The Reset VirtualNetworkGateway operation resets the primary of the virtual network gatewayin the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Reset Virtual Network Gateway operation through Network resource provider.

Returns:

Response for PutVirtualNetworkGateway Api servive call

createOrUpdate

AzureAsyncOperationResponse createOrUpdate(String resourceGroupName,
                                           String virtualNetworkGatewayName,
                                           VirtualNetworkGateway parameters)
                                    throws InterruptedException,
                                           ExecutionException,
                                           IOException

The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Create or update Virtual Network Gateway operation through Network resource provider.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

IOException - Thrown if there was an error setting up tracing for the request.

createOrUpdateAsync

Future<AzureAsyncOperationResponse> createOrUpdateAsync(String resourceGroupName,
                                                        String virtualNetworkGatewayName,
                                                        VirtualNetworkGateway parameters)

The Put VirtualNetworkGateway operation creates/updates a virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Create or update Virtual Network Gateway operation through Network resource provider.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

delete

OperationResponse delete(String resourceGroupName,
                         String virtualNetworkGatewayName)
                  throws InterruptedException,
                         ExecutionException,
                         IOException

The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

A standard service response including an HTTP status code and request ID.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

IOException - Thrown if there was an error setting up tracing for the request.

deleteAsync

Future<OperationResponse> deleteAsync(String resourceGroupName,
                                      String virtualNetworkGatewayName)

The Delete VirtualNetworkGateway operation deletes the specifed virtual network Gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

A standard service response including an HTTP status code and request ID.

get

VirtualNetworkGatewayGetResponse get(String resourceGroupName,
                                     String virtualNetworkGatewayName)
                              throws IOException,
                                     ServiceException

The Get VirtualNetworkGateway operation retrieves information about the specified virtual network gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

Response for GetVitualNetworkgateway Api servive call.

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

getAsync

Future<VirtualNetworkGatewayGetResponse> getAsync(String resourceGroupName,
                                                  String virtualNetworkGatewayName)

The Get VirtualNetworkGateway operation retrieves information about the specified virtual network gateway through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

Returns:

Response for GetVitualNetworkgateway Api servive call.

list

VirtualNetworkGatewayListResponse list(String resourceGroupName)
                                throws IOException,
                                       ServiceException

The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.

Parameters:

resourceGroupName - Required. The name of the resource group.

Returns:

Response for ListVirtualNetworkGateways Api service call

Throws:

IOException - Signals that an I/O exception of some sort has occurred. This class is the general class of exceptions produced by failed or interrupted I/O operations.

ServiceException - Thrown if an unexpected response is found.

listAsync

Future<VirtualNetworkGatewayListResponse> listAsync(String resourceGroupName)

The List VirtualNetworkGateways opertion retrieves all the virtual network gateways stored.

Parameters:

resourceGroupName - Required. The name of the resource group.

Returns:

Response for ListVirtualNetworkGateways Api service call

reset

AzureAsyncOperationResponse reset(String resourceGroupName,
                                  String virtualNetworkGatewayName,
                                  VirtualNetworkGateway parameters)
                           throws InterruptedException,
                                  ExecutionException,
                                  IOException

The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Reset Virtual Network Gateway operation through Network resource provider.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.

Throws:

InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity. Occasionally a method may wish to test whether the current thread has been interrupted, and if so, to immediately throw this exception. The following code can be used to achieve this effect:

ExecutionException - Thrown when attempting to retrieve the result of a task that aborted by throwing an exception. This exception can be inspected using the Throwable.getCause() method.

IOException - Thrown if there was an error setting up tracing for the request.

resetAsync

Future<AzureAsyncOperationResponse> resetAsync(String resourceGroupName,
                                               String virtualNetworkGatewayName,
                                               VirtualNetworkGateway parameters)

The Reset VirtualNetworkGateway operation resets the primary of the virtual network gateway in the specified resource group through Network resource provider.

Parameters:

resourceGroupName - Required. The name of the resource group.

virtualNetworkGatewayName - Required. The name of the virtual network gateway.

parameters - Required. Parameters supplied to the Begin Reset Virtual Network Gateway operation through Network resource provider.

Returns:

The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is inprogress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure.