Volumes - Finalize External Replication

Service:

Azure NetApp Files

API Version:

2024-09-01

Finalize migration process
Finalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeExternalReplication?api-version=2024-09-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the NetApp account Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
poolName	path	True	string	The name of the capacity pool Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
volumeName	path	True	string	The name of the volume Regex pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
202 Accepted		Accepted Headers Location: string
Other Status Codes	ErrorResponse	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

Volumes_FinalizeExternalReplication

Sample request

HTTP

POST https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/finalizeExternalReplication?api-version=2024-09-01

Sample response

Status code:

202

Location: https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-09-01&operationResultResponseType=Location

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.