Package com.azure.resourcemanager.dataprotection.models

Interface BackupVaults

public interface BackupVaults

Resource collection API of BackupVaults.

Method Summary

Modifier and Type	Method	Description
CheckNameAvailabilityResult	checkNameAvailability(String resourceGroupName, String location, CheckNameAvailabilityRequest parameters)	API to check for resource name availability.
com.azure.core.http.rest.Response<CheckNameAvailabilityResult>	checkNameAvailabilityWithResponse(String resourceGroupName, String location, CheckNameAvailabilityRequest parameters, com.azure.core.util.Context context)	API to check for resource name availability.
BackupVaultResource.DefinitionStages.Blank	define(String name)	Begins definition for a new BackupVaultResource resource.
void	deleteById(String id)	Deletes a BackupVault resource from the resource group.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a BackupVault resource from the resource group.
void	deleteByResourceGroup(String resourceGroupName, String vaultName)	Deletes a BackupVault resource from the resource group.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String vaultName, com.azure.core.util.Context context)	Deletes a BackupVault resource from the resource group.
BackupVaultResource	getById(String id)	Returns a resource belonging to a resource group.
com.azure.core.http.rest.Response<BackupVaultResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Returns a resource belonging to a resource group.
BackupVaultResource	getByResourceGroup(String resourceGroupName, String vaultName)	Returns a resource belonging to a resource group.
com.azure.core.http.rest.Response<BackupVaultResource>	getByResourceGroupWithResponse(String resourceGroupName, String vaultName, com.azure.core.util.Context context)	Returns a resource belonging to a resource group.
com.azure.core.http.rest.PagedIterable<BackupVaultResource>	list()	Returns resource collection belonging to a subscription.
com.azure.core.http.rest.PagedIterable<BackupVaultResource>	list(com.azure.core.util.Context context)	Returns resource collection belonging to a subscription.
com.azure.core.http.rest.PagedIterable<BackupVaultResource>	listByResourceGroup(String resourceGroupName)	Returns resource collection belonging to a resource group.
com.azure.core.http.rest.PagedIterable<BackupVaultResource>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Returns resource collection belonging to a resource group.

Method Detail

list

com.azure.core.http.rest.PagedIterable<BackupVaultResource> list()

Returns resource collection belonging to a subscription.

Returns:

backupVaultResourceList.

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<BackupVaultResource> list(com.azure.core.util.Context context)

Returns resource collection belonging to a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

backupVaultResourceList.

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<BackupVaultResource> listByResourceGroup(String resourceGroupName)

Returns resource collection belonging to a resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

Returns:

backupVaultResourceList.

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

Returns resource collection belonging to a resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

context - The context to associate with this operation.

Returns:

backupVaultResourceList.

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

BackupVaultResource getByResourceGroup(String resourceGroupName,
                                       String vaultName)

Returns a resource belonging to a resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

vaultName - The name of the backup vault.

Returns:

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

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<BackupVaultResource> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                      String vaultName,
                                                                                      com.azure.core.util.Context context)

Returns a resource belonging to a resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

vaultName - The name of the backup vault.

context - The context to associate with this operation.

Returns:

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

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String vaultName)

Deletes a BackupVault resource from the resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

vaultName - The name of the backup vault.

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

Deletes a BackupVault resource from the resource group.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

vaultName - The name of the backup vault.

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.

checkNameAvailability

CheckNameAvailabilityResult checkNameAvailability(String resourceGroupName,
                                                  String location,
                                                  CheckNameAvailabilityRequest parameters)

API to check for resource name availability.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

location - The location in which uniqueness will be verified.

parameters - Check name availability request.

Returns:

checkNameAvailabilityResult.

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.

checkNameAvailabilityWithResponse

com.azure.core.http.rest.Response<CheckNameAvailabilityResult> checkNameAvailabilityWithResponse(String resourceGroupName,
                                                                                                 String location,
                                                                                                 CheckNameAvailabilityRequest parameters,
                                                                                                 com.azure.core.util.Context context)

API to check for resource name availability.

Parameters:

resourceGroupName - The name of the resource group where the backup vault is present.

location - The location in which uniqueness will be verified.

parameters - Check name availability request.

context - The context to associate with this operation.

Returns:

checkNameAvailabilityResult.

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.

getById

BackupVaultResource getById(String id)

Returns a resource belonging to a resource group.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

com.azure.core.http.rest.Response<BackupVaultResource> getByIdWithResponse(String id,
                                                                           com.azure.core.util.Context context)

Returns a resource belonging to a resource group.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

deleteById

void deleteById(String id)

Deletes a BackupVault resource from the resource group.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Deletes a BackupVault resource from the resource group.

Parameters:

id - the resource ID.

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.

define

BackupVaultResource.DefinitionStages.Blank define(String name)

Begins definition for a new BackupVaultResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new BackupVaultResource definition.