Package com.azure.resourcemanager.recoveryservicesbackup.models

Interface ProtectedItems

public interface ProtectedItems

Resource collection API of ProtectedItems.

Method Summary

Modifier and Type	Method	Description
ProtectedItemResource.DefinitionStages.Blank	define(String name)	Begins definition for a new ProtectedItemResource resource.
void	delete(String vaultName, String resourceGroupName, String fabricName, String containerName, String protectedItemName)	Used to disable backup of an item within a container.
void	deleteById(String id)	Used to disable backup of an item within a container.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Used to disable backup of an item within a container.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, String protectedItemName, com.azure.core.util.Context context)	Used to disable backup of an item within a container.
ProtectedItemResource	get(String vaultName, String resourceGroupName, String fabricName, String containerName, String protectedItemName)	Provides the details of the backed up item.
ProtectedItemResource	getById(String id)	Provides the details of the backed up item.
com.azure.core.http.rest.Response<ProtectedItemResource>	getByIdWithResponse(String id, String filter, com.azure.core.util.Context context)	Provides the details of the backed up item.
com.azure.core.http.rest.Response<ProtectedItemResource>	getWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, String protectedItemName, String filter, com.azure.core.util.Context context)	Provides the details of the backed up item.

Method Detail

get

ProtectedItemResource get(String vaultName,
                          String resourceGroupName,
                          String fabricName,
                          String containerName,
                          String protectedItemName)

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Fabric name associated with the backed up item.

containerName - Container name associated with the backed up item.

protectedItemName - Backed up item name whose details are to be fetched.

Returns:

base class for backup items.

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.

getWithResponse

com.azure.core.http.rest.Response<ProtectedItemResource> getWithResponse(String vaultName,
                                                                         String resourceGroupName,
                                                                         String fabricName,
                                                                         String containerName,
                                                                         String protectedItemName,
                                                                         String filter,
                                                                         com.azure.core.util.Context context)

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Fabric name associated with the backed up item.

containerName - Container name associated with the backed up item.

protectedItemName - Backed up item name whose details are to be fetched.

filter - OData filter options.

context - The context to associate with this operation.

Returns:

base class for backup items 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.

delete

void delete(String vaultName,
            String resourceGroupName,
            String fabricName,
            String containerName,
            String protectedItemName)

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Fabric name associated with the backed up item.

containerName - Container name associated with the backed up item.

protectedItemName - Backed up item to be deleted.

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 vaultName,
                                                           String resourceGroupName,
                                                           String fabricName,
                                                           String containerName,
                                                           String protectedItemName,
                                                           com.azure.core.util.Context context)

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Fabric name associated with the backed up item.

containerName - Container name associated with the backed up item.

protectedItemName - Backed up item to be deleted.

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.

getById

ProtectedItemResource getById(String id)

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Parameters:

id - the resource ID.

Returns:

base class for backup items 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.

getByIdWithResponse

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

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

Parameters:

id - the resource ID.

filter - OData filter options.

context - The context to associate with this operation.

Returns:

base class for backup items 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.

deleteById

void deleteById(String id)

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

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)

Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.

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

ProtectedItemResource.DefinitionStages.Blank define(String name)

Begins definition for a new ProtectedItemResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ProtectedItemResource definition.