Package com.azure.resourcemanager.containerservice.fluent

Interface SnapshotsClient

All Superinterfaces:

InnerSupportsDelete<Void>, InnerSupportsGet<SnapshotInner>, InnerSupportsListing<SnapshotInner>

public interface SnapshotsClient
extends InnerSupportsGet<SnapshotInner>, InnerSupportsListing<SnapshotInner>, InnerSupportsDelete<Void>

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

Method Summary

Modifier and Type	Method	Description
SnapshotInner	createOrUpdate(String resourceGroupName, String resourceName, SnapshotInner parameters)	Creates or updates a snapshot.
Mono<SnapshotInner>	createOrUpdateAsync(String resourceGroupName, String resourceName, SnapshotInner parameters)	Creates or updates a snapshot.
com.azure.core.http.rest.Response<SnapshotInner>	createOrUpdateWithResponse(String resourceGroupName, String resourceName, SnapshotInner parameters, com.azure.core.util.Context context)	Creates or updates a snapshot.
Mono<com.azure.core.http.rest.Response<SnapshotInner>>	createOrUpdateWithResponseAsync(String resourceGroupName, String resourceName, SnapshotInner parameters)	Creates or updates a snapshot.
void	delete(String resourceGroupName, String resourceName)	Deletes a snapshot.
Mono<Void>	deleteAsync(String resourceGroupName, String resourceName)	Deletes a snapshot.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Deletes a snapshot.
Mono<com.azure.core.http.rest.Response<Void>>	deleteWithResponseAsync(String resourceGroupName, String resourceName)	Deletes a snapshot.
SnapshotInner	getByResourceGroup(String resourceGroupName, String resourceName)	Gets a snapshot.
Mono<SnapshotInner>	getByResourceGroupAsync(String resourceGroupName, String resourceName)	Gets a snapshot.
com.azure.core.http.rest.Response<SnapshotInner>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Gets a snapshot.
Mono<com.azure.core.http.rest.Response<SnapshotInner>>	getByResourceGroupWithResponseAsync(String resourceGroupName, String resourceName)	Gets a snapshot.
com.azure.core.http.rest.PagedIterable<SnapshotInner>	list()	Gets a list of snapshots in the specified subscription.
com.azure.core.http.rest.PagedIterable<SnapshotInner>	list(com.azure.core.util.Context context)	Gets a list of snapshots in the specified subscription.
com.azure.core.http.rest.PagedFlux<SnapshotInner>	listAsync()	Gets a list of snapshots in the specified subscription.
com.azure.core.http.rest.PagedIterable<SnapshotInner>	listByResourceGroup(String resourceGroupName)	Lists snapshots in the specified subscription and resource group.
com.azure.core.http.rest.PagedIterable<SnapshotInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Lists snapshots in the specified subscription and resource group.
com.azure.core.http.rest.PagedFlux<SnapshotInner>	listByResourceGroupAsync(String resourceGroupName)	Lists snapshots in the specified subscription and resource group.
SnapshotInner	updateTags(String resourceGroupName, String resourceName, TagsObject parameters)	Updates tags on a snapshot.
Mono<SnapshotInner>	updateTagsAsync(String resourceGroupName, String resourceName, TagsObject parameters)	Updates tags on a snapshot.
com.azure.core.http.rest.Response<SnapshotInner>	updateTagsWithResponse(String resourceGroupName, String resourceName, TagsObject parameters, com.azure.core.util.Context context)	Updates tags on a snapshot.
Mono<com.azure.core.http.rest.Response<SnapshotInner>>	updateTagsWithResponseAsync(String resourceGroupName, String resourceName, TagsObject parameters)	Updates tags on a snapshot.

Method Detail

listAsync

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

Gets a list of snapshots in the specified subscription.

Specified by:

listAsync in interface InnerSupportsListing<SnapshotInner>

Returns:

a list of snapshots in the specified 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<SnapshotInner> list()

Gets a list of snapshots in the specified subscription.

Specified by:

list in interface InnerSupportsListing<SnapshotInner>

Returns:

a list of snapshots in the specified 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<SnapshotInner> list(com.azure.core.util.Context context)

Gets a list of snapshots in the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

a list of snapshots in the specified 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<SnapshotInner> listByResourceGroupAsync(String resourceGroupName)

Lists snapshots in the specified subscription and resource group.

Specified by:

listByResourceGroupAsync in interface InnerSupportsListing<SnapshotInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the response from the List Snapshots operation 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<SnapshotInner> listByResourceGroup(String resourceGroupName)

Lists snapshots in the specified subscription and resource group.

Specified by:

listByResourceGroup in interface InnerSupportsListing<SnapshotInner>

Parameters:

resourceGroupName - The name of the resource group.

Returns:

the response from the List Snapshots operation 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<SnapshotInner> listByResourceGroup(String resourceGroupName,
                                                                          com.azure.core.util.Context context)

Lists snapshots in the specified subscription and resource group.

Parameters:

resourceGroupName - The name of the resource group.

context - The context to associate with this operation.

Returns:

the response from the List Snapshots operation 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.

getByResourceGroupWithResponseAsync

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

Gets a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

Returns:

a snapshot 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<SnapshotInner> getByResourceGroupAsync(String resourceGroupName,
                                            String resourceName)

Gets a snapshot.

Specified by:

getByResourceGroupAsync in interface InnerSupportsGet<SnapshotInner>

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

Returns:

a snapshot 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

SnapshotInner getByResourceGroup(String resourceGroupName,
                                 String resourceName)

Gets a snapshot.

Specified by:

getByResourceGroup in interface InnerSupportsGet<SnapshotInner>

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

Returns:

a snapshot.

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

Gets a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

context - The context to associate with this operation.

Returns:

a snapshot 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<SnapshotInner>> createOrUpdateWithResponseAsync(String resourceGroupName,
                                                                                       String resourceName,
                                                                                       SnapshotInner parameters)

Creates or updates a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - The snapshot to create or update.

Returns:

a node pool snapshot 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.

createOrUpdateAsync

Mono<SnapshotInner> createOrUpdateAsync(String resourceGroupName,
                                        String resourceName,
                                        SnapshotInner parameters)

Creates or updates a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - The snapshot to create or update.

Returns:

a node pool snapshot 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

SnapshotInner createOrUpdate(String resourceGroupName,
                             String resourceName,
                             SnapshotInner parameters)

Creates or updates a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - The snapshot to create or update.

Returns:

a node pool snapshot 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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<SnapshotInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                            String resourceName,
                                                                            SnapshotInner parameters,
                                                                            com.azure.core.util.Context context)

Creates or updates a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - The snapshot to create or update.

context - The context to associate with this operation.

Returns:

a node pool snapshot 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.

updateTagsWithResponseAsync

Mono<com.azure.core.http.rest.Response<SnapshotInner>> updateTagsWithResponseAsync(String resourceGroupName,
                                                                                   String resourceName,
                                                                                   TagsObject parameters)

Updates tags on a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - Parameters supplied to the Update snapshot Tags operation.

Returns:

a node pool snapshot 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<SnapshotInner> updateTagsAsync(String resourceGroupName,
                                    String resourceName,
                                    TagsObject parameters)

Updates tags on a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - Parameters supplied to the Update snapshot Tags operation.

Returns:

a node pool snapshot 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

SnapshotInner updateTags(String resourceGroupName,
                         String resourceName,
                         TagsObject parameters)

Updates tags on a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - Parameters supplied to the Update snapshot Tags operation.

Returns:

a node pool snapshot 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<SnapshotInner> updateTagsWithResponse(String resourceGroupName,
                                                                        String resourceName,
                                                                        TagsObject parameters,
                                                                        com.azure.core.util.Context context)

Updates tags on a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

parameters - Parameters supplied to the Update snapshot Tags operation.

context - The context to associate with this operation.

Returns:

a node pool snapshot 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<Void>> deleteWithResponseAsync(String resourceGroupName,
                                                                      String resourceName)

Deletes a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

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.

deleteAsync

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

Deletes a snapshot.

Specified by:

deleteAsync in interface InnerSupportsDelete<Void>

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

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

Deletes a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster 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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String resourceName,
                                                           com.azure.core.util.Context context)

Deletes a snapshot.

Parameters:

resourceGroupName - The name of the resource group.

resourceName - The name of the managed cluster resource.

context - The context to associate with this operation.

Returns:

the 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.