ProtectionContainers | @azure/arm-recoveryservicesbackup

Interface representing a ProtectionContainers.

Hierarchy

ProtectionContainers

Implemented by

ProtectionContainersImpl

Index

Methods

get

get(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersGetOptionalParams): Promise<ProtectionContainersGetResponse>

- Defined in operationsInterfaces/protectionContainers.ts:31
Gets details of the specific container registered to your Recovery Services Vault.

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.
- Optional options: ProtectionContainersGetOptionalParams
  
  The options parameters.
Returns Promise<ProtectionContainersGetResponse>

inquire

inquire(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersInquireOptionalParams): Promise<void>

- Defined in operationsInterfaces/protectionContainers.ts:89
This is an async operation and the results should be tracked using location header or Azure-async-url.

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.
- Optional options: ProtectionContainersInquireOptionalParams
  
  The options parameters.
Returns Promise<void>

refresh

refresh(vaultName: string, resourceGroupName: string, fabricName: string, options?: ProtectionContainersRefreshOptionalParams): Promise<void>

- Defined in operationsInterfaces/protectionContainers.ts:106
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: 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.
- Optional options: ProtectionContainersRefreshOptionalParams
  
  The options parameters.
Returns Promise<void>

register

register(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, parameters: ProtectionContainerResource, options?: ProtectionContainersRegisterOptionalParams): Promise<ProtectionContainersRegisterResponse>

- Defined in operationsInterfaces/protectionContainers.ts:51
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: 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
- Optional options: ProtectionContainersRegisterOptionalParams
  
  The options parameters.
Returns Promise<ProtectionContainersRegisterResponse>

unregister

unregister(vaultName: string, resourceGroupName: string, fabricName: string, containerName: string, options?: ProtectionContainersUnregisterOptionalParams): Promise<void>

- Defined in operationsInterfaces/protectionContainers.ts:72
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: 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.
- Optional options: ProtectionContainersUnregisterOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

get

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

containerName: string

Optional options: ProtectionContainersGetOptionalParams

Returns Promise<ProtectionContainersGetResponse>

inquire

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

containerName: string

Optional options: ProtectionContainersInquireOptionalParams

Returns Promise<void>

refresh

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

Optional options: ProtectionContainersRefreshOptionalParams

Returns Promise<void>

register

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

containerName: string

parameters: ProtectionContainerResource

Optional options: ProtectionContainersRegisterOptionalParams

Returns Promise<ProtectionContainersRegisterResponse>

unregister

Parameters

vaultName: string

resourceGroupName: string

fabricName: string

containerName: string

Optional options: ProtectionContainersUnregisterOptionalParams

Returns Promise<void>