Replication Protection Container Mappings - Update

Reference

Service:: Recovery Services - Site Recovery

API Version:: 2024-04-01

The operation to update protection container mapping.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
fabricName	path	True	string	Fabric name.
mappingName	path	True	string	Protection container mapping name.
protectionContainerName	path	True	string	Protection container name.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
properties	UpdateProtectionContainerMappingInputProperties	Update protection container mapping input properties.

Responses

Name	Type	Description
200 OK	ProtectionContainerMapping	OK
202 Accepted		Accepted

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

Update protection container mapping.

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1?api-version=2024-04-01

{
  "properties": {
    "providerSpecificInput": {
      "instanceType": "A2A",
      "agentAutoUpdateStatus": "Enabled",
      "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1"
    }
  }
}

Sample response

Status code:: 200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01

{
  "id": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationFabrics/cloud1/replicationProtectionContainers/cloud_6d224fc6-f326-5d35-96de-fbf51efb3179/replicationProtectionContainerMappings/cloud1protectionprofile1",
  "name": "cloud1protectionprofile1",
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings",
  "properties": {
    "targetProtectionContainerId": "Microsoft Azure",
    "targetProtectionContainerFriendlyName": "Microsoft Azure",
    "health": "Normal",
    "healthErrorDetails": [],
    "policyId": "/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationPolicies/protectionprofile1",
    "state": "Paired",
    "sourceProtectionContainerFriendlyName": "cloud1",
    "sourceFabricFriendlyName": "cloud1",
    "targetFabricFriendlyName": "Microsoft Azure",
    "policyFriendlyName": "protectionprofile1",
    "providerSpecificDetails": {
      "instanceType": "A2A",
      "agentAutoUpdateStatus": "Enabled",
      "automationAccountArmId": "/subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/automationrg1/providers/Microsoft.Automation/automationAccounts/automationaccount1",
      "scheduleName": "cloud1protectionprofile1_a85ea38f-62a8-471b-93cc-69b74fd9578c",
      "jobScheduleName": "ffd503ec-5f88-4b58-97c8-841466e7aa47"
    }
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/Subscriptions/c183865e-6077-46f2-a3b1-deb0f4f4650a/resourceGroups/resourceGroupPS1/providers/Microsoft.RecoveryServices/vaults/vault1/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-04-01
Retry-After: 30

Definitions

Name	Description
A2AProtectionContainerMappingDetails	A2A provider specific settings.
A2AUpdateContainerMappingInput	A2A update protection container mapping.
AgentAutoUpdateStatus	A value indicating whether the auto update is enabled.
AutomationAccountAuthenticationType	A value indicating the type authentication to use for automation Account.
HealthError	Health Error.
HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
InMageRcmProtectionContainerMappingDetails	InMageRcm provider specific container mapping details.
InMageRcmUpdateContainerMappingInput	InMageRcm update protection container mapping.
InnerHealthError	Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
ProtectionContainerMapping	Protection container mapping object.
ProtectionContainerMappingProperties	Protection container mapping properties.
UpdateProtectionContainerMappingInput	Container pairing update input.
UpdateProtectionContainerMappingInputProperties	Container pairing update input.
VMwareCbtProtectionContainerMappingDetails	VMwareCbt provider specific container mapping details.

A2AProtectionContainerMappingDetails

A2A provider specific settings.

Name	Type	Default value	Description
agentAutoUpdateStatus	AgentAutoUpdateStatus		A value indicating whether the auto update is enabled.
automationAccountArmId	string		The automation account arm id.
automationAccountAuthenticationType	AutomationAccountAuthenticationType	RunAsAccount	A value indicating the type authentication to use for automation Account.
instanceType	string: A2A		Gets the class type. Overridden in derived classes.
jobScheduleName	string		The job schedule arm name.
scheduleName	string		The schedule arm name.

A2AUpdateContainerMappingInput

A2A update protection container mapping.

Name	Type	Default value	Description
agentAutoUpdateStatus	AgentAutoUpdateStatus		A value indicating whether the auto update is enabled.
automationAccountArmId	string		The automation account arm id.
automationAccountAuthenticationType	AutomationAccountAuthenticationType	RunAsAccount	A value indicating the type authentication to use for automation Account.
instanceType	string: A2A		The class type.

AgentAutoUpdateStatus

A value indicating whether the auto update is enabled.

Name	Type	Description
Disabled	string
Enabled	string

AutomationAccountAuthenticationType

A value indicating the type authentication to use for automation Account.

Name	Type	Description
RunAsAccount	string
SystemAssignedIdentity	string

HealthError

Health Error.

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
innerHealthErrors	InnerHealthError[]	The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

HealthErrorCustomerResolvability

Value indicating whether the health error is customer resolvable.

Name	Type	Description
Allowed	string
NotAllowed	string

InMageRcmProtectionContainerMappingDetails

InMageRcm provider specific container mapping details.

Name	Type	Description
enableAgentAutoUpgrade	string	A value indicating whether the flag for enable agent auto upgrade.
instanceType	string: InMageRcm	Gets the class type. Overridden in derived classes.

InMageRcmUpdateContainerMappingInput

InMageRcm update protection container mapping.

Name	Type	Description
enableAgentAutoUpgrade	string	A value indicating whether agent auto upgrade has to be enabled.
instanceType	string: InMageRcm	The class type.

InnerHealthError

Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Name	Type	Description
creationTimeUtc	string	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

ProtectionContainerMapping

Protection container mapping object.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	ProtectionContainerMappingProperties	The custom data.
type	string	Resource Type

ProtectionContainerMappingProperties

Protection container mapping properties.

Name	Type	Description
health	string	Health of pairing.
healthErrorDetails	HealthError[]	Health error.
policyFriendlyName	string	Friendly name of replication policy.
policyId	string	Policy ARM Id.
providerSpecificDetails	ProtectionContainerMappingProviderSpecificDetails: A2AProtectionContainerMappingDetails InMageRcmProtectionContainerMappingDetails VMwareCbtProtectionContainerMappingDetails	Provider specific provider details.
sourceFabricFriendlyName	string	Friendly name of source fabric.
sourceProtectionContainerFriendlyName	string	Friendly name of source protection container.
state	string	Association Status.
targetFabricFriendlyName	string	Friendly name of target fabric.
targetProtectionContainerFriendlyName	string	Friendly name of paired container.
targetProtectionContainerId	string	Paired protection container ARM ID.

UpdateProtectionContainerMappingInput

Container pairing update input.

Name	Type	Description
properties	UpdateProtectionContainerMappingInputProperties	Update protection container mapping input properties.

UpdateProtectionContainerMappingInputProperties