Package com.azure.resourcemanager.recoveryservicesbackup.fluent

Interface ProtectionContainersClient

public interface ProtectionContainersClient

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

Method Summary

Modifier and Type	Method	Description
ProtectionContainerResourceInner	get(String vaultName, String resourceGroupName, String fabricName, String containerName)	Gets details of the specific container registered to your Recovery Services Vault.
com.azure.core.http.rest.Response<ProtectionContainerResourceInner>	getWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, com.azure.core.util.Context context)	Gets details of the specific container registered to your Recovery Services Vault.
void	inquire(String vaultName, String resourceGroupName, String fabricName, String containerName)	This is an async operation and the results should be tracked using location header or Azure-async-url.
com.azure.core.http.rest.Response<Void>	inquireWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, String filter, com.azure.core.util.Context context)	This is an async operation and the results should be tracked using location header or Azure-async-url.
void	refresh(String vaultName, String resourceGroupName, String fabricName)	Discovers all the containers in the subscription that can be backed up to Recovery Services Vault.
com.azure.core.http.rest.Response<Void>	refreshWithResponse(String vaultName, String resourceGroupName, String fabricName, String filter, com.azure.core.util.Context context)	Discovers all the containers in the subscription that can be backed up to Recovery Services Vault.
ProtectionContainerResourceInner	register(String vaultName, String resourceGroupName, String fabricName, String containerName, ProtectionContainerResourceInner parameters)	Registers the container with Recovery Services vault.
com.azure.core.http.rest.Response<ProtectionContainerResourceInner>	registerWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, ProtectionContainerResourceInner parameters, com.azure.core.util.Context context)	Registers the container with Recovery Services vault.
void	unregister(String vaultName, String resourceGroupName, String fabricName, String containerName)	Unregisters the given container from your Recovery Services Vault.
com.azure.core.http.rest.Response<Void>	unregisterWithResponse(String vaultName, String resourceGroupName, String fabricName, String containerName, com.azure.core.util.Context context)	Unregisters the given container from your Recovery Services Vault.

Method Detail

get

ProtectionContainerResourceInner get(String vaultName,
                                     String resourceGroupName,
                                     String fabricName,
                                     String containerName)

Gets details of the specific container registered to your Recovery Services Vault.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Name of the fabric where the container belongs.

containerName - Name of the container whose details need to be fetched.

Returns:

details of the specific container registered to your Recovery Services 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.

getWithResponse

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

Gets details of the specific container registered to your Recovery Services Vault.

Parameters:

vaultName - The name of the recovery services vault.

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

fabricName - Name of the fabric where the container belongs.

containerName - Name of the container whose details need to be fetched.

context - The context to associate with this operation.

Returns:

details of the specific container registered to your Recovery Services Vault 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.

register

ProtectionContainerResourceInner register(String vaultName,
                                          String resourceGroupName,
                                          String fabricName,
                                          String containerName,
                                          ProtectionContainerResourceInner parameters)

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

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

containerName - Name of the container to be registered.

parameters - Request body for operation.

Returns:

base class for container with 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.

registerWithResponse

com.azure.core.http.rest.Response<ProtectionContainerResourceInner> registerWithResponse(String vaultName,
                                                                                         String resourceGroupName,
                                                                                         String fabricName,
                                                                                         String containerName,
                                                                                         ProtectionContainerResourceInner parameters,
                                                                                         com.azure.core.util.Context context)

Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.

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

containerName - Name of the container to be registered.

parameters - Request body for operation.

context - The context to associate with this operation.

Returns:

base class for container with 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.

unregister

void unregister(String vaultName,
                String resourceGroupName,
                String fabricName,
                String containerName)

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result 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 - Name of the fabric where the container belongs.

containerName - Name of the container which needs to be unregistered from the Recovery Services 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.

unregisterWithResponse

com.azure.core.http.rest.Response<Void> unregisterWithResponse(String vaultName,
                                                               String resourceGroupName,
                                                               String fabricName,
                                                               String containerName,
                                                               com.azure.core.util.Context context)

Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result 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 - Name of the fabric where the container belongs.

containerName - Name of the container which needs to be unregistered from the Recovery Services 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.

inquire

void inquire(String vaultName,
             String resourceGroupName,
             String fabricName,
             String containerName)

This is an async operation and the results should be tracked using location header or Azure-async-url.

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

containerName - Name of the container in which inquiry needs to be triggered.

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.

inquireWithResponse

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

This is an async operation and the results should be tracked using location header or Azure-async-url.

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

containerName - Name of the container in which inquiry needs to be triggered.

filter - OData filter options.

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.

refresh

void refresh(String vaultName,
             String resourceGroupName,
             String fabricName)

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult 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 the container.

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.

refreshWithResponse

com.azure.core.http.rest.Response<Void> refreshWithResponse(String vaultName,
                                                            String resourceGroupName,
                                                            String fabricName,
                                                            String filter,
                                                            com.azure.core.util.Context context)

Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult 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 the container.

filter - OData filter options.

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.