ProtectionContainers interface
Interface representing a ProtectionContainers.
Methods
| begin |
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. |
| begin |
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. |
| get(string, string, string, string, Protection |
Gets details of the specific container registered to your Recovery Services Vault. |
| inquire(string, string, string, string, Protection |
This is an async operation and the results should be tracked using location header or Azure-async-url. |
| refresh(string, string, string, Protection |
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. |
| unregister(string, string, string, string, Protection |
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. |
Method Details
beginRegister(string, string, string, string, ProtectionContainerResource, ProtectionContainersRegisterOptionalParams)
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.
function beginRegister(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, parameters: ProtectionContainerResource, options?: ProtectionContainersRegisterOptionalParams): Promise<SimplePollerLike<OperationState<ProtectionContainerResource>, ProtectionContainerResource>>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Fabric name associated with the container.
- containerName
-
string
Name of the container to be registered.
- parameters
- ProtectionContainerResource
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ProtectionContainerResource>, ProtectionContainerResource>>
beginRegisterAndWait(string, string, string, string, ProtectionContainerResource, ProtectionContainersRegisterOptionalParams)
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.
function beginRegisterAndWait(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, parameters: ProtectionContainerResource, options?: ProtectionContainersRegisterOptionalParams): Promise<ProtectionContainerResource>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Fabric name associated with the container.
- containerName
-
string
Name of the container to be registered.
- parameters
- ProtectionContainerResource
Request body for operation
The options parameters.
Returns
Promise<ProtectionContainerResource>
get(string, string, string, string, ProtectionContainersGetOptionalParams)
Gets details of the specific container registered to your Recovery Services Vault.
function get(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersGetOptionalParams): Promise<ProtectionContainerResource>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Name of the fabric where the container belongs.
- containerName
-
string
Name of the container whose details need to be fetched.
The options parameters.
Returns
Promise<ProtectionContainerResource>
inquire(string, string, string, string, ProtectionContainersInquireOptionalParams)
This is an async operation and the results should be tracked using location header or Azure-async-url.
function inquire(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersInquireOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Fabric Name associated with the container.
- containerName
-
string
Name of the container in which inquiry needs to be triggered.
The options parameters.
Returns
Promise<void>
refresh(string, string, string, ProtectionContainersRefreshOptionalParams)
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.
function refresh(vaultName: string, resourceGroupName: string, fabricName: string, options?: ProtectionContainersRefreshOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Fabric name associated the container.
The options parameters.
Returns
Promise<void>
unregister(string, string, string, string, ProtectionContainersUnregisterOptionalParams)
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.
function unregister(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersUnregisterOptionalParams): Promise<void>Parameters
- vaultName
-
string
The name of the recovery services vault.
- resourceGroupName
-
string
The name of the resource group where the recovery services vault is present.
- fabricName
-
string
Name of the fabric where the container belongs.
- containerName
-
string
Name of the container which needs to be unregistered from the Recovery Services Vault.
The options parameters.
Returns
Promise<void>