Share via

ResourceGroupsClient Interface

  • Reference
Package:
com.azure.resourcemanager.resources.fluent
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-resources:2.44.0

public interface ResourceGroupsClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName)

Deletes a resource group.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String forceDeletionTypes, Context context)

Deletes a resource group.
abstract PollerFlux<PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName)

Deletes a resource group.
abstract PollerFlux<PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group.
abstract SyncPoller<PollResult<ResourceGroupExportResultInner>,ResourceGroupExportResultInner> beginExportTemplate(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.
abstract SyncPoller<PollResult<ResourceGroupExportResultInner>,ResourceGroupExportResultInner> beginExportTemplate(String resourceGroupName, ExportTemplateRequest parameters, Context context)

Captures the specified resource group as a template.
abstract PollerFlux<PollResult<ResourceGroupExportResultInner>,ResourceGroupExportResultInner> beginExportTemplateAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.
abstract boolean checkExistence(String resourceGroupName)

Checks whether a resource group exists.
abstract Mono<Boolean> checkExistenceAsync(String resourceGroupName)

Checks whether a resource group exists.
abstract Response<Boolean> checkExistenceWithResponse(String resourceGroupName, Context context)

Checks whether a resource group exists.
abstract Mono<Response<Boolean>> checkExistenceWithResponseAsync(String resourceGroupName)

Checks whether a resource group exists.
abstract ResourceGroupInner createOrUpdate(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.
abstract Mono<ResourceGroupInner> createOrUpdateAsync(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.
abstract Response<ResourceGroupInner> createOrUpdateWithResponse(String resourceGroupName, ResourceGroupInner parameters, Context context)

Creates or updates a resource group.
abstract Mono<Response<ResourceGroupInner>> createOrUpdateWithResponseAsync(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.
abstract void delete(String resourceGroupName)

Deletes a resource group.
abstract void delete(String resourceGroupName, String forceDeletionTypes, Context context)

Deletes a resource group.
abstract Mono<Void> deleteAsync(String resourceGroupName)

Deletes a resource group.
abstract Mono<Void> deleteAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group.
abstract Mono<Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group.
abstract ResourceGroupExportResultInner exportTemplate(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.
abstract ResourceGroupExportResultInner exportTemplate(String resourceGroupName, ExportTemplateRequest parameters, Context context)

Captures the specified resource group as a template.
abstract Mono<ResourceGroupExportResultInner> exportTemplateAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.
abstract Mono<Response<Flux<ByteBuffer>>> exportTemplateWithResponseAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.
abstract ResourceGroupInner get(String resourceGroupName)

Gets a resource group.
abstract Mono<ResourceGroupInner> getAsync(String resourceGroupName)

Gets a resource group.
abstract Response<ResourceGroupInner> getWithResponse(String resourceGroupName, Context context)

Gets a resource group.
abstract Mono<Response<ResourceGroupInner>> getWithResponseAsync(String resourceGroupName)

Gets a resource group.
abstract PagedIterable<ResourceGroupInner> list()

Gets all the resource groups for a subscription.
abstract PagedIterable<ResourceGroupInner> list(String filter, Integer top, Context context)

Gets all the resource groups for a subscription.
abstract PagedFlux<ResourceGroupInner> listAsync()

Gets all the resource groups for a subscription.
abstract PagedFlux<ResourceGroupInner> listAsync(String filter, Integer top)

Gets all the resource groups for a subscription.
abstract ResourceGroupInner update(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group.
abstract Mono<ResourceGroupInner> updateAsync(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group.
abstract Response<ResourceGroupInner> updateWithResponse(String resourceGroupName, ResourceGroupPatchable parameters, Context context)

Updates a resource group.
abstract Mono<Response<ResourceGroupInner>> updateWithResponseAsync(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group.

Method Details

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller,Void> beginDelete(String resourceGroupName, String forceDeletionTypes, Context context)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.
forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDeleteAsync

public abstract PollerFlux,Void> beginDeleteAsync(String resourceGroupName)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

beginDeleteAsync

public abstract PollerFlux,Void> beginDeleteAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.
forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.

Returns:

the PollerFlux<T,U> for polling of long-running operation.

beginExportTemplate

public abstract SyncPoller,ResourceGroupExportResultInner> beginExportTemplate(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.

Returns:

the SyncPoller<T,U> for polling of resource group export result.

beginExportTemplate

public abstract SyncPoller,ResourceGroupExportResultInner> beginExportTemplate(String resourceGroupName, ExportTemplateRequest parameters, Context context)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of resource group export result.

beginExportTemplateAsync

public abstract PollerFlux,ResourceGroupExportResultInner> beginExportTemplateAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.

Returns:

the PollerFlux<T,U> for polling of resource group export result.

checkExistence

public abstract boolean checkExistence(String resourceGroupName)

Checks whether a resource group exists.

Parameters:

resourceGroupName - The name of the resource group to check. The name is case insensitive.

Returns:

whether resource exists.

checkExistenceAsync

public abstract Mono checkExistenceAsync(String resourceGroupName)

Checks whether a resource group exists.

Parameters:

resourceGroupName - The name of the resource group to check. The name is case insensitive.

Returns:

whether resource exists on successful completion of Mono.

checkExistenceWithResponse

public abstract Response checkExistenceWithResponse(String resourceGroupName, Context context)

Checks whether a resource group exists.

Parameters:

resourceGroupName - The name of the resource group to check. The name is case insensitive.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

checkExistenceWithResponseAsync

public abstract Mono> checkExistenceWithResponseAsync(String resourceGroupName)

Checks whether a resource group exists.

Parameters:

resourceGroupName - The name of the resource group to check. The name is case insensitive.

Returns:

whether resource exists along with Response<T> on successful completion of Mono.

createOrUpdate

public abstract ResourceGroupInner createOrUpdate(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.

Parameters:

resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
parameters - Parameters supplied to the create or update a resource group.

Returns:

resource group information.

createOrUpdateAsync

public abstract Mono createOrUpdateAsync(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.

Parameters:

resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
parameters - Parameters supplied to the create or update a resource group.

Returns:

resource group information on successful completion of Mono.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, ResourceGroupInner parameters, Context context)

Creates or updates a resource group.

Parameters:

resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
parameters - Parameters supplied to the create or update a resource group.
context - The context to associate with this operation.

Returns:

resource group information along with Response<T>.

createOrUpdateWithResponseAsync

public abstract Mono> createOrUpdateWithResponseAsync(String resourceGroupName, ResourceGroupInner parameters)

Creates or updates a resource group.

Parameters:

resourceGroupName - The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.
parameters - Parameters supplied to the create or update a resource group.

Returns:

resource group information along with Response<T> on successful completion of Mono.

delete

public abstract void delete(String resourceGroupName)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.

delete

public abstract void delete(String resourceGroupName, String forceDeletionTypes, Context context)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.
forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.
context - The context to associate with this operation.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.

Returns:

A Mono that completes when a successful response is received.

deleteAsync

public abstract Mono deleteAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.
forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.

Returns:

A Mono that completes when a successful response is received.

deleteWithResponseAsync

public abstract Mono>> deleteWithResponseAsync(String resourceGroupName, String forceDeletionTypes)

Deletes a resource group. When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.

Parameters:

resourceGroupName - The name of the resource group to delete. The name is case insensitive.
forceDeletionTypes - The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets.

Returns:

the Response<T> on successful completion of Mono.

exportTemplate

public abstract ResourceGroupExportResultInner exportTemplate(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.

Returns:

resource group export result.

exportTemplate

public abstract ResourceGroupExportResultInner exportTemplate(String resourceGroupName, ExportTemplateRequest parameters, Context context)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.
context - The context to associate with this operation.

Returns:

resource group export result.

exportTemplateAsync

public abstract Mono exportTemplateAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.

Returns:

resource group export result on successful completion of Mono.

exportTemplateWithResponseAsync

public abstract Mono>> exportTemplateWithResponseAsync(String resourceGroupName, ExportTemplateRequest parameters)

Captures the specified resource group as a template.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
parameters - Parameters for exporting the template.

Returns:

resource group export result along with Response<T> on successful completion of Mono.

get

public abstract ResourceGroupInner get(String resourceGroupName)

Gets a resource group.

Parameters:

resourceGroupName - The name of the resource group to get. The name is case insensitive.

Returns:

a resource group.

getAsync

public abstract Mono getAsync(String resourceGroupName)

Gets a resource group.

Parameters:

resourceGroupName - The name of the resource group to get. The name is case insensitive.

Returns:

a resource group on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, Context context)

Gets a resource group.

Parameters:

resourceGroupName - The name of the resource group to get. The name is case insensitive.
context - The context to associate with this operation.

Returns:

a resource group along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String resourceGroupName)

Gets a resource group.

Parameters:

resourceGroupName - The name of the resource group to get. The name is case insensitive.

Returns:

a resource group along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list()

Gets all the resource groups for a subscription.

Returns:

all the resource groups for a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String filter, Integer top, Context context)

Gets all the resource groups for a subscription.

Parameters:

filter - The filter to apply on the operation.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'.
top - The number of results to return. If null is passed, returns all resource groups.
context - The context to associate with this operation.

Returns:

all the resource groups for a subscription as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync()

Gets all the resource groups for a subscription.

Returns:

all the resource groups for a subscription as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String filter, Integer top)

Gets all the resource groups for a subscription.

Parameters:

filter - The filter to apply on the operation.<br><br>You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'.
top - The number of results to return. If null is passed, returns all resource groups.

Returns:

all the resource groups for a subscription as paginated response with PagedFlux<T>.

update

public abstract ResourceGroupInner update(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group. Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Parameters:

resourceGroupName - The name of the resource group to update. The name is case insensitive.
parameters - Parameters supplied to update a resource group.

Returns:

resource group information.

updateAsync

public abstract Mono updateAsync(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group. Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Parameters:

resourceGroupName - The name of the resource group to update. The name is case insensitive.
parameters - Parameters supplied to update a resource group.

Returns:

resource group information on successful completion of Mono.

updateWithResponse

public abstract Response updateWithResponse(String resourceGroupName, ResourceGroupPatchable parameters, Context context)

Updates a resource group. Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Parameters:

resourceGroupName - The name of the resource group to update. The name is case insensitive.
parameters - Parameters supplied to update a resource group.
context - The context to associate with this operation.

Returns:

resource group information along with Response<T>.

updateWithResponseAsync

public abstract Mono> updateWithResponseAsync(String resourceGroupName, ResourceGroupPatchable parameters)

Updates a resource group. Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.

Parameters:

resourceGroupName - The name of the resource group to update. The name is case insensitive.
parameters - Parameters supplied to update a resource group.

Returns:

resource group information along with Response<T> on successful completion of Mono.

Applies to