Package com.azure.resourcemanager.network.fluent

Interface NatGatewaysClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<NatGatewayInner>, InnerSupportsListing<NatGatewayInner>

public interface NatGatewaysClient
extends InnerSupportsGet<NatGatewayInner>, InnerSupportsListing<NatGatewayInner>, InnerSupportsDelete<Void>

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

Method Summary

Modifier and Type	Method	Description
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<NatGatewayInner>,NatGatewayInner>	beginCreateOrUpdate(String resourceGroupName, String natGatewayName, NatGatewayInner parameters)	Creates or updates a nat gateway.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<NatGatewayInner>,NatGatewayInner>	beginCreateOrUpdate(String resourceGroupName, String natGatewayName, NatGatewayInner parameters, com.azure.core.util.Context context)	Creates or updates a nat gateway.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<NatGatewayInner>,NatGatewayInner>	beginCreateOrUpdateAsync(String resourceGroupName, String natGatewayName, NatGatewayInner parameters)	Creates or updates a nat gateway.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String natGatewayName)	Deletes the specified nat gateway.
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void>	beginDelete(String resourceGroupName, String natGatewayName, com.azure.core.util.Context context)	Deletes the specified nat gateway.
com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void>	beginDeleteAsync(String resourceGroupName, String natGatewayName)	Deletes the specified nat gateway.
NatGatewayInner	createOrUpdate(String resourceGroupName, String natGatewayName, NatGatewayInner parameters)	Creates or updates a nat gateway.
NatGatewayInner	createOrUpdate(String resourceGroupName, String natGatewayName, NatGatewayInner parameters, com.azure.core.util.Context context)	Creates or updates a nat gateway.
Mono<NatGatewayInner>	createOrUpdateAsync(String resourceGroupName, String natGatewayName, NatGatewayInner parameters)	Creates or updates a nat gateway.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	createOrUpdateWithResponseAsync(String resourceGroupName, String natGatewayName, NatGatewayInner parameters)	Creates or updates a nat gateway.
void	delete(String resourceGroupName, String natGatewayName)	Deletes the specified nat gateway.
void	delete(String resourceGroupName, String natGatewayName, com.azure.core.util.Context context)	Deletes the specified nat gateway.
Mono<Void>	deleteAsync(String resourceGroupName, String natGatewayName)	Deletes the specified nat gateway.
Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>>	deleteWithResponseAsync(String resourceGroupName, String natGatewayName)	Deletes the specified nat gateway.
NatGatewayInner	getByResourceGroup(String resourceGroupName, String natGatewayName)	Gets the specified nat gateway in a specified resource group.
Mono<NatGatewayInner>	getByResourceGroupAsync(String resourceGroupName, String natGatewayName)	Gets the specified nat gateway in a specified resource group.
Mono<NatGatewayInner>	getByResourceGroupAsync(String resourceGroupName, String natGatewayName, String expand)	Gets the specified nat gateway in a specified resource group.
com.azure.core.http.rest.Response<NatGatewayInner>	getByResourceGroupWithResponse(String resourceGroupName, String natGatewayName, String expand, com.azure.core.util.Context context)	Gets the specified nat gateway in a specified resource group.
Mono<com.azure.core.http.rest.Response<NatGatewayInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String natGatewayName, String expand)	Gets the specified nat gateway in a specified resource group.
com.azure.core.http.rest.PagedIterable<NatGatewayInner>	list()	Gets all the Nat Gateways in a subscription.
com.azure.core.http.rest.PagedIterable<NatGatewayInner>	list(com.azure.core.util.Context context)	Gets all the Nat Gateways in a subscription.
com.azure.core.http.rest.PagedFlux<NatGatewayInner>	listAsync()	Gets all the Nat Gateways in a subscription.
com.azure.core.http.rest.PagedIterable<NatGatewayInner>	listByResourceGroup(String resourceGroupName)	Gets all nat gateways in a resource group.
com.azure.core.http.rest.PagedIterable<NatGatewayInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Gets all nat gateways in a resource group.
com.azure.core.http.rest.PagedFlux<NatGatewayInner>	listByResourceGroupAsync(String resourceGroupName)	Gets all nat gateways in a resource group.
NatGatewayInner	updateTags(String resourceGroupName, String natGatewayName, TagsObject parameters)	Updates nat gateway tags.
Mono<NatGatewayInner>	updateTagsAsync(String resourceGroupName, String natGatewayName, TagsObject parameters)	Updates nat gateway tags.
com.azure.core.http.rest.Response<NatGatewayInner>	updateTagsWithResponse(String resourceGroupName, String natGatewayName, TagsObject parameters, com.azure.core.util.Context context)	Updates nat gateway tags.
Mono<com.azure.core.http.rest.Response<NatGatewayInner>>	updateTagsWithResponseAsync(String resourceGroupName, String natGatewayName, TagsObject parameters)	Updates nat gateway tags.

Method Detail

deleteWithResponseAsync

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

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName)

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName)

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName,
                                                                                                                  com.azure.core.util.Context context)

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName)

Deletes the specified nat gateway.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName)

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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 natGatewayName,
            com.azure.core.util.Context context)

Deletes the specified nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

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.

getByResourceGroupWithResponseAsync

Mono<com.azure.core.http.rest.Response<NatGatewayInner>> getByResourceGroupWithResponseAsync(String resourceGroupName,
                                                                                             String natGatewayName,
                                                                                             String expand)

Gets the specified nat gateway in a specified resource group.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

expand - Expands referenced resources.

Returns:

the specified nat gateway in a specified resource group 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<NatGatewayInner> getByResourceGroupAsync(String resourceGroupName,
                                              String natGatewayName,
                                              String expand)

Gets the specified nat gateway in a specified resource group.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

expand - Expands referenced resources.

Returns:

the specified nat gateway in a specified resource group 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<NatGatewayInner> getByResourceGroupAsync(String resourceGroupName,
                                              String natGatewayName)

Gets the specified nat gateway in a specified resource group.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<NatGatewayInner>

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

Returns:

the specified nat gateway in a specified resource group 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

NatGatewayInner getByResourceGroup(String resourceGroupName,
                                   String natGatewayName)

Gets the specified nat gateway in a specified resource group.

Specified by:

getByResourceGroup in interface InnerSupportsGet<NatGatewayInner>

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

Returns:

the specified nat gateway in a specified resource group.

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<NatGatewayInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                  String natGatewayName,
                                                                                  String expand,
                                                                                  com.azure.core.util.Context context)

Gets the specified nat gateway in a specified resource group.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

expand - Expands referenced resources.

context - The context to associate with this operation.

Returns:

the specified nat gateway in a specified resource group 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 natGatewayName,
                                                                                          NatGatewayInner parameters)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

Returns:

nat Gateway 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<NatGatewayInner>,NatGatewayInner> beginCreateOrUpdateAsync(String resourceGroupName,
                                                                                                                                                     String natGatewayName,
                                                                                                                                                     NatGatewayInner parameters)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

Returns:

the PollerFlux for polling of nat Gateway 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<NatGatewayInner>,NatGatewayInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                String natGatewayName,
                                                                                                                                                NatGatewayInner parameters)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

Returns:

the SyncPoller for polling of nat Gateway 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<NatGatewayInner>,NatGatewayInner> beginCreateOrUpdate(String resourceGroupName,
                                                                                                                                                String natGatewayName,
                                                                                                                                                NatGatewayInner parameters,
                                                                                                                                                com.azure.core.util.Context context)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

context - The context to associate with this operation.

Returns:

the SyncPoller for polling of nat Gateway 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<NatGatewayInner> createOrUpdateAsync(String resourceGroupName,
                                          String natGatewayName,
                                          NatGatewayInner parameters)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

Returns:

nat Gateway 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

NatGatewayInner createOrUpdate(String resourceGroupName,
                               String natGatewayName,
                               NatGatewayInner parameters)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

Returns:

nat Gateway 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

NatGatewayInner createOrUpdate(String resourceGroupName,
                               String natGatewayName,
                               NatGatewayInner parameters,
                               com.azure.core.util.Context context)

Creates or updates a nat gateway.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to the create or update nat gateway operation.

context - The context to associate with this operation.

Returns:

nat Gateway 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<NatGatewayInner>> updateTagsWithResponseAsync(String resourceGroupName,
                                                                                     String natGatewayName,
                                                                                     TagsObject parameters)

Updates nat gateway tags.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to update nat gateway tags.

Returns:

nat Gateway 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<NatGatewayInner> updateTagsAsync(String resourceGroupName,
                                      String natGatewayName,
                                      TagsObject parameters)

Updates nat gateway tags.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to update nat gateway tags.

Returns:

nat Gateway 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

NatGatewayInner updateTags(String resourceGroupName,
                           String natGatewayName,
                           TagsObject parameters)

Updates nat gateway tags.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to update nat gateway tags.

Returns:

nat Gateway 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<NatGatewayInner> updateTagsWithResponse(String resourceGroupName,
                                                                          String natGatewayName,
                                                                          TagsObject parameters,
                                                                          com.azure.core.util.Context context)

Updates nat gateway tags.

Parameters:

resourceGroupName - The name of the resource group.

natGatewayName - The name of the nat gateway.

parameters - Parameters supplied to update nat gateway tags.

context - The context to associate with this operation.

Returns:

nat Gateway 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.

listAsync

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

Gets all the Nat Gateways in a subscription.

Specified by:

listAsync in interface InnerSupportsListing<NatGatewayInner>

Returns:

all the Nat Gateways in a subscription 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<NatGatewayInner> list()

Gets all the Nat Gateways in a subscription.

Specified by:

list in interface InnerSupportsListing<NatGatewayInner>

Returns:

all the Nat Gateways in a subscription 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<NatGatewayInner> list(com.azure.core.util.Context context)

Gets all the Nat Gateways in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

all the Nat Gateways in a subscription 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.

listByResourceGroupAsync

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

Gets all nat gateways in a resource group.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<NatGatewayInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

all nat gateways in a resource group 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<NatGatewayInner> listByResourceGroup(String resourceGroupName)

Gets all nat gateways in a resource group.

Specified by:

listByResourceGroup in interface InnerSupportsListing<NatGatewayInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

all nat gateways in a resource group 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<NatGatewayInner> listByResourceGroup(String resourceGroupName,
                                                                            com.azure.core.util.Context context)

Gets all nat gateways in a resource group.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

all nat gateways in a resource group 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.