다음을 통해 공유


Protection Containers - Register

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.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}?api-version=2024-04-01

URI Parameters

Name In Required Type Description
containerName
path True

string

Name of the container to be registered.

fabricName
path True

string

Fabric name associated with the container.

resourceGroupName
path True

string

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

subscriptionId
path True

string

The subscription Id.

vaultName
path True

string

The name of the recovery services vault.

api-version
query True

string

Client Api Version.

Request Body

Name Type Description
eTag

string

Optional ETag.

location

string

Resource location.

properties ProtectionContainer:

ProtectionContainerResource properties

tags

object

Resource tags.

Responses

Name Type Description
200 OK

ProtectionContainerResource

OK

202 Accepted

Accepted

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account.

Examples

RegisterAzure Storage ProtectionContainers

Sample request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa?api-version=2024-04-01

{
  "properties": {
    "friendlyName": "swaggertestsa",
    "backupManagementType": "AzureStorage",
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
    "containerType": "StorageContainer",
    "acquireStorageAccountLock": "Acquire"
  }
}

Sample response

Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2019-05-13-preview
Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Retry-After: 60
{
  "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/swaggertestvault/backupFabrics/Azure/protectionContainers/StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
  "name": "StorageContainer;Storage;SwaggerTestRg;swaggertestsa",
  "properties": {
    "sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/SwaggerTestRg/providers/Microsoft.Storage/storageAccounts/swaggertestsa",
    "protectedItemCount": 0,
    "acquireStorageAccountLock": "Acquire",
    "friendlyName": "swaggertestsa",
    "backupManagementType": "AzureStorage",
    "registrationStatus": "Registered",
    "healthStatus": "Healthy",
    "containerType": "StorageContainer"
  }
}

Definitions

Name Description
AcquireStorageAccountLock

Whether storage account lock is to be acquired for this container or not.

AzureBackupServerContainer

AzureBackupServer (DPMVenus) workload-specific protection container.

AzureIaaSClassicComputeVMContainer

IaaS VM workload-specific backup item representing a classic virtual machine.

AzureIaaSComputeVMContainer

IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.

AzureSQLAGWorkloadContainerProtectionContainer

Container for SQL workloads under SQL Availability Group.

AzureSqlContainer

Azure Sql workload-specific container.

AzureStorageContainer

Azure Storage Account workload-specific container.

AzureVMAppContainerProtectionContainer

Container for SQL workloads under Azure Virtual Machines.

AzureWorkloadContainer

Container for the workloads running inside Azure Compute or Classic Compute.

AzureWorkloadContainerExtendedInfo

Extended information of the container.

BackupItemType

Type of backup items associated with this container.

BackupManagementType

Type of backup management for the backed up item.

CloudError

An error response from the Container Instance service.

CloudErrorBody

An error response from the Container Instance service.

ContainerIdentityInfo

Container identity information

DistributedNodesInfo

This is used to represent the various nodes of the distributed container.

DpmContainer

DPM workload-specific protection container.

DPMContainerExtendedInfo

Additional information of the DPMContainer.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

GenericContainer

Base class for generic container of backup items

GenericContainerExtendedInfo

Container extended information

IaaSVMContainer

IaaS VM workload-specific container.

InquiryInfo

Details about inquired protectable items under a given container.

InquiryValidation

Validation for inquired protectable items under a given container.

MabContainer

Container with items backed up using MAB backup engine.

MabContainerExtendedInfo

Additional information of the container.

MABContainerHealthDetails

MAB workload-specific Health Details.

OperationType

Re-Do Operation

ProtectionContainerResource

Base class for container with backup items. Containers with specific workloads are derived from this class.

WorkloadInquiryDetails

Details of an inquired protectable item.

WorkloadType

Type of workload for the backup management

AcquireStorageAccountLock

Whether storage account lock is to be acquired for this container or not.

Name Type Description
Acquire

string

NotAcquire

string

AzureBackupServerContainer

AzureBackupServer (DPMVenus) workload-specific protection container.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

canReRegister

boolean

Specifies whether the container is re-registrable.

containerId

string

ID of container.

containerType string:

AzureBackupServerContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

dpmAgentVersion

string

Backup engine Agent version

dpmServers

string[]

List of BackupEngines protecting the container

extendedInfo

DPMContainerExtendedInfo

Extended Info of the container.

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

protectedItemCount

integer

Number of protected items in the BackupEngine

protectionStatus

string

Protection status of the container.

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

upgradeAvailable

boolean

To check if upgrade available

AzureIaaSClassicComputeVMContainer

IaaS VM workload-specific backup item representing a classic virtual machine.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

Microsoft.ClassicCompute/virtualMachines

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

resourceGroup

string

Resource group name of Recovery Services Vault.

virtualMachineId

string

Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

virtualMachineVersion

string

Specifies whether the container represents a Classic or an Azure Resource Manager VM.

AzureIaaSComputeVMContainer

IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

Microsoft.Compute/virtualMachines

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

resourceGroup

string

Resource group name of Recovery Services Vault.

virtualMachineId

string

Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

virtualMachineVersion

string

Specifies whether the container represents a Classic or an Azure Resource Manager VM.

AzureSQLAGWorkloadContainerProtectionContainer

Container for SQL workloads under SQL Availability Group.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

SQLAGWorkLoadContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

extendedInfo

AzureWorkloadContainerExtendedInfo

Additional details of a workload container.

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

lastUpdatedTime

string

Time stamp when this container was updated.

operationType

OperationType

Re-Do Operation

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

sourceResourceId

string

ARM ID of the virtual machine represented by this Azure Workload Container

workloadType

WorkloadType

Workload type for which registration was sent.

AzureSqlContainer

Azure Sql workload-specific container.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

AzureSqlContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

AzureStorageContainer

Azure Storage Account workload-specific container.

Name Type Description
acquireStorageAccountLock

AcquireStorageAccountLock

Whether storage account lock is to be acquired for this container or not.

backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

StorageContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

protectedItemCount

integer

Number of items backed up in this container.

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

resourceGroup

string

Resource group name of Recovery Services Vault.

sourceResourceId

string

Fully qualified ARM url.

storageAccountVersion

string

Storage account version.

AzureVMAppContainerProtectionContainer

Container for SQL workloads under Azure Virtual Machines.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

VMAppContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

extendedInfo

AzureWorkloadContainerExtendedInfo

Additional details of a workload container.

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

lastUpdatedTime

string

Time stamp when this container was updated.

operationType

OperationType

Re-Do Operation

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

sourceResourceId

string

ARM ID of the virtual machine represented by this Azure Workload Container

workloadType

WorkloadType

Workload type for which registration was sent.

AzureWorkloadContainer

Container for the workloads running inside Azure Compute or Classic Compute.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

AzureWorkloadContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

extendedInfo

AzureWorkloadContainerExtendedInfo

Additional details of a workload container.

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

lastUpdatedTime

string

Time stamp when this container was updated.

operationType

OperationType

Re-Do Operation

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

sourceResourceId

string

ARM ID of the virtual machine represented by this Azure Workload Container

workloadType

WorkloadType

Workload type for which registration was sent.

AzureWorkloadContainerExtendedInfo

Extended information of the container.

Name Type Description
hostServerName

string

Host Os Name in case of Stand Alone and Cluster Name in case of distributed container.

inquiryInfo

InquiryInfo

Inquiry Status for the container.

nodesList

DistributedNodesInfo[]

List of the nodes in case of distributed container.

BackupItemType

Type of backup items associated with this container.

Name Type Description
AzureFileShare

string

AzureSqlDb

string

Client

string

Exchange

string

FileFolder

string

GenericDataSource

string

Invalid

string

SAPAseDatabase

string

SAPHanaDBInstance

string

SAPHanaDatabase

string

SQLDB

string

SQLDataBase

string

Sharepoint

string

SystemState

string

VM

string

VMwareVM

string

BackupManagementType

Type of backup management for the backed up item.

Name Type Description
AzureBackupServer

string

AzureIaasVM

string

AzureSql

string

AzureStorage

string

AzureWorkload

string

DPM

string

DefaultBackup

string

Invalid

string

MAB

string

CloudError

An error response from the Container Instance service.

Name Type Description
error

CloudErrorBody

The error object.

CloudErrorBody

An error response from the Container Instance service.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

An identifier for the error. Codes are invariant and are intended to be consumed programmatically.

details

CloudErrorBody[]

A list of additional details about the error.

message

string

A message describing the error, intended to be suitable for display in a user interface.

target

string

The target of the particular error. For example, the name of the property in error.

ContainerIdentityInfo

Container identity information

Name Type Description
aadTenantId

string

Protection container identity - AAD Tenant

audience

string

Protection container identity - Audience

servicePrincipalClientId

string

Protection container identity - AAD Service Principal

uniqueName

string

Unique name of the container

DistributedNodesInfo

This is used to represent the various nodes of the distributed container.

Name Type Description
errorDetail

ErrorDetail

Error Details if the Status is non-success.

nodeName

string

Name of the node under a distributed container.

sourceResourceId

string

ARM resource id of the node

status

string

Status of this Node. Failed | Succeeded

DpmContainer

DPM workload-specific protection container.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

canReRegister

boolean

Specifies whether the container is re-registrable.

containerId

string

ID of container.

containerType string:

DPMContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

dpmAgentVersion

string

Backup engine Agent version

dpmServers

string[]

List of BackupEngines protecting the container

extendedInfo

DPMContainerExtendedInfo

Extended Info of the container.

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

protectedItemCount

integer

Number of protected items in the BackupEngine

protectionStatus

string

Protection status of the container.

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

upgradeAvailable

boolean

To check if upgrade available

DPMContainerExtendedInfo

Additional information of the DPMContainer.

Name Type Description
lastRefreshedAt

string

Last refresh time of the DPMContainer.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

Name Type Description
code

string

Error code.

message

string

Error Message related to the Code.

recommendations

string[]

List of recommendation strings.

GenericContainer

Base class for generic container of backup items

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

GenericContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

extendedInformation

GenericContainerExtendedInfo

Extended information (not returned in List container API calls)

fabricName

string

Name of the container's fabric

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

GenericContainerExtendedInfo

Container extended information

Name Type Description
containerIdentityInfo

ContainerIdentityInfo

Container identity information

rawCertData

string

Public key of container cert

serviceEndpoints

object

Azure Backup Service Endpoints for the container

IaaSVMContainer

IaaS VM workload-specific container.

Name Type Description
backupManagementType

BackupManagementType

Type of backup management for the container.

containerType string:

IaasVMContainer

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

protectableObjectType

string

Type of the protectable object associated with this container

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

resourceGroup

string

Resource group name of Recovery Services Vault.

virtualMachineId

string

Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container.

virtualMachineVersion

string

Specifies whether the container represents a Classic or an Azure Resource Manager VM.

InquiryInfo

Details about inquired protectable items under a given container.

Name Type Description
errorDetail

ErrorDetail

Error Details if the Status is non-success.

inquiryDetails

WorkloadInquiryDetails[]

Inquiry Details which will have workload specific details. For e.g. - For SQL and oracle this will contain different details.

status

string

Inquiry Status for this container such as InProgress | Failed | Succeeded

InquiryValidation

Validation for inquired protectable items under a given container.

Name Type Description
additionalDetail

string

Error Additional Detail in case the status is non-success.

errorDetail

ErrorDetail

Error Detail in case the status is non-success.

protectableItemCount

object

Dictionary to store the count of ProtectableItems with key POType.

status

string

Status for the Inquiry Validation.

MabContainer

Container with items backed up using MAB backup engine.

Name Type Description
agentVersion

string

Agent version of this container.

backupManagementType

BackupManagementType

Type of backup management for the container.

canReRegister

boolean

Can the container be registered one more time.

containerHealthState

string

Health state of mab container.

containerId

integer

ContainerID represents the container.

containerType string:

Windows

Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer

extendedInfo

MabContainerExtendedInfo

Additional information for this container

friendlyName

string

Friendly name of the container.

healthStatus

string

Status of health of the container.

mabContainerHealthDetails

MABContainerHealthDetails[]

Health details on this mab container.

protectableObjectType

string

Type of the protectable object associated with this container

protectedItemCount

integer

Number of items backed up in this container.

registrationStatus

string

Status of registration of the container with the Recovery Services Vault.

MabContainerExtendedInfo

Additional information of the container.

Name Type Description
backupItemType

BackupItemType

Type of backup items associated with this container.

backupItems

string[]

List of backup items associated with this container.

lastBackupStatus

string

Latest backup status of this container.

lastRefreshedAt

string

Time stamp when this container was refreshed.

policyName

string

Backup policy associated with this container.

MABContainerHealthDetails

MAB workload-specific Health Details.

Name Type Description
code

integer

Health Code

message

string

Health Message

recommendations

string[]

Health Recommended Actions

title

string

Health Title

OperationType

Re-Do Operation

Name Type Description
Invalid

string

Register

string

Reregister

string

ProtectionContainerResource

Base class for container with backup items. Containers with specific workloads are derived from this class.

Name Type Description
eTag

string

Optional ETag.

id

string

Resource Id represents the complete path to the resource.

location

string

Resource location.

name

string

Resource name associated with the resource.

properties ProtectionContainer:

ProtectionContainerResource properties

tags

object

Resource tags.

type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

WorkloadInquiryDetails

Details of an inquired protectable item.

Name Type Description
inquiryValidation

InquiryValidation

Inquiry validation such as permissions and other backup validations.

itemCount

integer

Contains the protectable item Count inside this Container.

type

string

Type of the Workload such as SQL, Oracle etc.

WorkloadType

Type of workload for the backup management

Name Type Description
AzureFileShare

string

AzureSqlDb

string

Client

string

Exchange

string

FileFolder

string

GenericDataSource

string

Invalid

string

SAPAseDatabase

string

SAPHanaDBInstance

string

SAPHanaDatabase

string

SQLDB

string

SQLDataBase

string

Sharepoint

string

SystemState

string

VM

string

VMwareVM

string