GenericResources Interface

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.52.0

Implements

SupportsGettingById<GenericResource> SupportsListingByResourceGroup<GenericResource> SupportsListingInResourceGroupByTag<GenericResource> HasManager<ResourceManager> SupportsCreating<Blank> SupportsDeletingById SupportsListing<GenericResource>

public interface GenericResources
extends SupportsListing<GenericResource>, SupportsListingByResourceGroup<GenericResource>, SupportsListingInResourceGroupByTag<GenericResource>, SupportsGettingById<GenericResource>, SupportsCreating<Blank>, SupportsDeletingById, HasManager<ResourceManager>

Entry point to generic resources management API.

Method Summary

Modifier and Type	Method and Description
abstract Accepted<Void>	beginDeleteById(String id) Begins deleting a resource from Azure, identifying it by its resource ID.
abstract Accepted<Void>	beginDeleteById(String id, String apiVersion) Begins deleting a resource from Azure, identifying it by its resource ID.
abstract boolean	checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Checks if a resource exists in a resource group.
abstract boolean	checkExistenceById(String id) Checks if a resource exists.
abstract boolean	checkExistenceById(String id, String apiVersion) Checks if a resource exists.
abstract void	delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Delete resource and all of its child resources.
abstract Mono<Void>	deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Delete resource and all of its child resources asynchronously.
abstract void	deleteById(String id) Deletes a resource from Azure, identifying it by its resource ID.
abstract void	deleteById(String id, String apiVersion) Deletes a resource from Azure, identifying it by its resource ID.
abstract Mono<Void>	deleteByIdAsync(String id) Asynchronously delete a resource from Azure, identifying it by its resource ID.
abstract Mono<Void>	deleteByIdAsync(String id, String apiVersion) Asynchronously delete a resource from Azure, identifying it by its resource ID.
abstract GenericResource	get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName) Returns a resource belonging to a resource group.
abstract GenericResource	get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Returns a resource belonging to a resource group.
abstract GenericResource	getById(String id) Gets the information about a resource from Azure based on the resource id.
abstract GenericResource	getById(String id, String apiVersion) Gets the information about a resource from Azure based on the resource id.
abstract Mono<GenericResource>	getByIdAsync(String id) Gets the information about a resource from Azure based on the resource id.
abstract Mono<GenericResource>	getByIdAsync(String id, String apiVersion) Gets the information about a resource from Azure based on the resource id.
abstract void	moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds) Move resources from one resource group to another.
abstract Mono<Void>	moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds) Move resources from one resource group to another asynchronously.
abstract void	validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds) Validates move resources from one resource group to another.
abstract Mono<Void>	validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds) Validates move resources from one resource group to another asynchronously.

Method Details

beginDeleteById

public abstract Accepted<Void> beginDeleteById(String id)

Begins deleting a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use beginDeleteById(String id, String apiVersion) instead.

Parameters:

id - the resource ID of the resource to delete

Returns:

the accepted deleting operation

beginDeleteById

public abstract Accepted<Void> beginDeleteById(String id, String apiVersion)

Begins deleting a resource from Azure, identifying it by its resource ID.

Parameters:

id - the resource ID of the resource to delete

apiVersion - the API version

Returns:

the accepted deleting operation

checkExistence

public abstract boolean checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)

Checks if a resource exists in a resource group.

Parameters:

resourceGroupName - the resource group's name

resourceProviderNamespace - the resource provider's namespace

parentResourcePath - the parent's resource path

resourceType - the type of the resource

resourceName - the name of the resource

apiVersion - the API version

Returns:

true if the resource exists; false otherwise

checkExistenceById

public abstract boolean checkExistenceById(String id)

Checks if a resource exists. For consistency across service versions, please use checkExistenceById(String id, String apiVersion) instead.

Parameters:

id - the ID of the resource.

Returns:

true if the resource exists; false otherwise

checkExistenceById

public abstract boolean checkExistenceById(String id, String apiVersion)

Checks if a resource exists.

Parameters:

id - the ID of the resource.

apiVersion - the API version

Returns:

true if the resource exists; false otherwise

delete

public abstract void delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)

Delete resource and all of its child resources.

Parameters:

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

resourceProviderNamespace - Resource identity.

parentResourcePath - Resource identity.

resourceType - Resource identity.

resourceName - Resource identity.

apiVersion - the API version

deleteAsync

public abstract Mono<Void> deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)

Delete resource and all of its child resources asynchronously.

Parameters:

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

resourceProviderNamespace - Resource identity.

parentResourcePath - Resource identity.

resourceType - Resource identity.

resourceName - Resource identity.

apiVersion - the API version

Returns:

a representation of the deferred computation of this call

deleteById

public abstract void deleteById(String id)

Deletes a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use deleteById(String id, String apiVersion) instead.

Parameters:

id - the resource ID of the resource to delete

deleteById

public abstract void deleteById(String id, String apiVersion)

Deletes a resource from Azure, identifying it by its resource ID.

Parameters:

id - the resource ID of the resource to delete

apiVersion - the API version

deleteByIdAsync

public abstract Mono<Void> deleteByIdAsync(String id)

Asynchronously delete a resource from Azure, identifying it by its resource ID. For consistency across service versions, please use deleteByIdAsync(String id, String apiVersion) instead.

Parameters:

id - the resource ID of the resource to delete

Returns:

a representation of the deferred computation of this call

deleteByIdAsync

public abstract Mono<Void> deleteByIdAsync(String id, String apiVersion)

Asynchronously delete a resource from Azure, identifying it by its resource ID.

Parameters:

id - the resource ID of the resource to delete

apiVersion - the API version

Returns:

a representation of the deferred computation of this call

get

public abstract GenericResource get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName)

Returns a resource belonging to a resource group.

Parameters:

resourceGroupName - the resource group name

providerNamespace - the provider namespace

resourceType - the resource type

resourceName - the name of the resource

Returns:

the generic resource

get

public abstract GenericResource get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion)

Returns a resource belonging to a resource group.

Parameters:

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

resourceProviderNamespace - Resource identity.

parentResourcePath - Resource identity.

resourceType - Resource identity.

resourceName - Resource identity.

apiVersion - the API version

Returns:

the generic resource

getById

public abstract GenericResource getById(String id)

Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use getById(String id, String apiVersion) instead.

Parameters:

id - the id of the resource.

Returns:

an immutable representation of the resource

getById

public abstract GenericResource getById(String id, String apiVersion)

Gets the information about a resource from Azure based on the resource id.

Parameters:

id - the id of the resource.

apiVersion - the API version

Returns:

an immutable representation of the resource

getByIdAsync

public abstract Mono<GenericResource> getByIdAsync(String id)

Gets the information about a resource from Azure based on the resource id. For consistency across service versions, please use getByIdAsync(String id, String apiVersion) instead.

Parameters:

id - the id of the resource.

Returns:

a Mono that emits the found resource asynchronously

getByIdAsync

public abstract Mono<GenericResource> getByIdAsync(String id, String apiVersion)

Gets the information about a resource from Azure based on the resource id.

Parameters:

id - the id of the resource.

apiVersion - the API version

Returns:

a Mono that emits the found resource asynchronously

moveResources

public abstract void moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)

Move resources from one resource group to another.

Parameters:

sourceResourceGroupName - Source resource group name

targetResourceGroup - target resource group, can be in a different subscription

resourceIds - the list of IDs of the resources to move

moveResourcesAsync

public abstract Mono<Void> moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)

Move resources from one resource group to another asynchronously.

Parameters:

sourceResourceGroupName - Source resource group name

targetResourceGroup - target resource group, can be in a different subscription

resourceIds - the list of IDs of the resources to move

Returns:

a representation of the deferred computation of this call

validateMoveResources

public abstract void validateMoveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)

Validates move resources from one resource group to another. If validation fails, ManagementException is thrown.

Parameters:

sourceResourceGroupName - Source resource group name

targetResourceGroup - target resource group, can be in a different subscription

resourceIds - the list of IDs of the resources to move

validateMoveResourcesAsync

public abstract Mono<Void> validateMoveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resourceIds)

Validates move resources from one resource group to another asynchronously. If validation fails, ManagementException is thrown.

Parameters:

sourceResourceGroupName - Source resource group name

targetResourceGroup - target resource group, can be in a different subscription

resourceIds - the list of IDs of the resources to move

Returns:

a representation of the deferred computation of this call