com.microsoft.azure.management.resources

Interface GenericResources

All Superinterfaces:

HasManager<com.microsoft.azure.management.resources.implementation.ResourceManager>, SupportsCreating<GenericResource.DefinitionStages.Blank>, SupportsDeletingById, SupportsGettingById<GenericResource>, SupportsListing<GenericResource>, SupportsListingByResourceGroup<GenericResource>, SupportsListingInResourceGroupByTag<GenericResource>

public interface GenericResources
extends SupportsListing<GenericResource>, SupportsListingByResourceGroup<GenericResource>, SupportsListingInResourceGroupByTag<GenericResource>, SupportsGettingById<GenericResource>, SupportsCreating<GenericResource.DefinitionStages.Blank>, SupportsDeletingById, HasManager<com.microsoft.azure.management.resources.implementation.ResourceManager>

Entry point to generic resources management API.

Method Summary

Modifier and Type	Method and Description
boolean	checkExistence(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Checks if a resource exists in a resource group.
boolean	checkExistenceById(String id) Checks if a resource exists.
boolean	checkExistenceById(String id, String apiVersion) Checks if a resource exists.
void	delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Delete resource and all of its child resources.
void	delete(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion) Force delete resource and all of its child resources.
rx.Completable	deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Delete resource and all of its child resources asynchronously.
rx.Completable	deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion) Force delete resource and all of its child resources asynchronously.
com.microsoft.rest.ServiceFuture<Void>	deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, boolean forceDeletion, com.microsoft.rest.ServiceCallback<Void> callback) Force delete resource and all of its child resources asynchronously.
com.microsoft.rest.ServiceFuture<Void>	deleteAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion, com.microsoft.rest.ServiceCallback<Void> callback) Delete resource and all of its child resources asynchronously.
void	deleteById(String id) Deletes a resource from Azure, identifying it by its resource ID.
void	deleteById(String id, String apiVersion) Deletes a resource from Azure, identifying it by its resource ID.
rx.Completable	deleteByIdAsync(String id) Asynchronously delete a resource from Azure, identifying it by its resource ID.
rx.Completable	deleteByIdAsync(String id, String apiVersion) Asynchronously delete a resource from Azure, identifying it by its resource ID.
GenericResource	get(String resourceGroupName, String providerNamespace, String resourceType, String resourceName) Returns a resource belonging to a resource group.
GenericResource	get(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String apiVersion) Returns a resource belonging to a resource group.
GenericResource	getById(String id) Gets the information about a resource from Azure based on the resource id.
GenericResource	getById(String id, String apiVersion) Gets the information about a resource from Azure based on the resource id.
rx.Observable<GenericResource>	getByIdAsync(String id) Gets the information about a resource from Azure based on the resource id.
rx.Observable<GenericResource>	getByIdAsync(String id, String apiVersion) Gets the information about a resource from Azure based on the resource id.
void	moveResources(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources) Move resources from one resource group to another.
rx.Completable	moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources) Move resources from one resource group to another asynchronously.
com.microsoft.rest.ServiceFuture<Void>	moveResourcesAsync(String sourceResourceGroupName, ResourceGroup targetResourceGroup, List<String> resources, com.microsoft.rest.ServiceCallback<Void> callback) Move resources from one resource group to another asynchronously.

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing

list, listAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingByResourceGroup

listByResourceGroup, listByResourceGroupAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsListingInResourceGroupByTag

listByTag, listByTagAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById

getByIdAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating

define

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById

deleteByIdAsync

Methods inherited from interface com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager

manager

Method Detail

deleteById

void deleteById(String id)

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

Specified by:

deleteById in interface SupportsDeletingById

Parameters:

id - the resource ID of the resource to delete

deleteByIdAsync

rx.Completable deleteByIdAsync(String id)

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

Specified by:

deleteByIdAsync in interface SupportsDeletingById

Parameters:

id - the resource ID of the resource to delete

Returns:

a representation of the deferred computation of this call

getById

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, String) instead.

Specified by:

getById in interface SupportsGettingById<GenericResource>

Parameters:

id - the id of the resource.

Returns:

an immutable representation of the resource

getByIdAsync

rx.Observable<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, String) instead.

Specified by:

getByIdAsync in interface SupportsGettingById<GenericResource>

Parameters:

id - the id of the resource.

Returns:

an immutable representation of the resource

deleteById

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

rx.Completable 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

getById

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

rx.Observable<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:

an immutable representation of the resource

checkExistence

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

boolean checkExistenceById(String id)

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

Parameters:

id - the ID of the resource.

Returns:

true if the resource exists; false otherwise

checkExistenceById

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

get

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

get

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

moveResources

void moveResources(String sourceResourceGroupName,
                   ResourceGroup targetResourceGroup,
                   List<String> resources)

Move resources from one resource group to another.

Parameters:

sourceResourceGroupName - Source resource group name

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

resources - the list of IDs of the resources to move

moveResourcesAsync

rx.Completable moveResourcesAsync(String sourceResourceGroupName,
                                  ResourceGroup targetResourceGroup,
                                  List<String> resources)

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

resources - the list of IDs of the resources to move

Returns:

a representation of the deferred computation of this call

moveResourcesAsync

com.microsoft.rest.ServiceFuture<Void> moveResourcesAsync(String sourceResourceGroupName,
                                                          ResourceGroup targetResourceGroup,
                                                          List<String> resources,
                                                          com.microsoft.rest.ServiceCallback<Void> callback)

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

resources - the list of IDs of the resources to move

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

delete

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

rx.Completable 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

deleteAsync

com.microsoft.rest.ServiceFuture<Void> deleteAsync(String resourceGroupName,
                                                   String resourceProviderNamespace,
                                                   String parentResourcePath,
                                                   String resourceType,
                                                   String resourceName,
                                                   String apiVersion,
                                                   com.microsoft.rest.ServiceCallback<Void> callback)

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 String value

callback - the callback to call on success or failure

Returns:

a handle to cancel the request

delete

void delete(String resourceGroupName,
            String resourceProviderNamespace,
            String parentResourcePath,
            String resourceType,
            String resourceName,
            String apiVersion,
            boolean forceDeletion)

Force delete resource and all of its child resources. This is only available to limited resource types.

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

forceDeletion - the force delete parameter

deleteAsync

rx.Completable deleteAsync(String resourceGroupName,
                           String resourceProviderNamespace,
                           String parentResourcePath,
                           String resourceType,
                           String resourceName,
                           String apiVersion,
                           boolean forceDeletion)

Force delete resource and all of its child resources asynchronously. This is only available to limited resource types.

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

forceDeletion - the force delete parameter

Returns:

a representation of the deferred computation of this call

deleteAsync

com.microsoft.rest.ServiceFuture<Void> deleteAsync(String resourceGroupName,
                                                   String resourceProviderNamespace,
                                                   String parentResourcePath,
                                                   String resourceType,
                                                   String resourceName,
                                                   String apiVersion,
                                                   boolean forceDeletion,
                                                   com.microsoft.rest.ServiceCallback<Void> callback)

Force delete resource and all of its child resources asynchronously. This is only available to limited resource types.

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

forceDeletion - the force delete parameter

callback - the callback to call on success or failure

Returns:

a handle to cancel the request