Validate resources in Azure

  • 5 minutes

You assessed all the development resources that are in the incorrect production resource group. You think they can move without problems, but you want to test it first.

In this unit, you learn how to validate that a move will be successful. You also learn how to use the Azure REST API validate move operation to test and validate your moves.

Prepare to test your move

Before attempting to move a resource, you can test whether it will be successful by calling the validate move operation from the Azure REST API. This test is especially useful if you're trying to move resources by using (for example) Azure PowerShell or the Azure CLI. You can use these tools to script moves with minimal human interaction. Testing a move doesn't affect your resources. The operation only tests whether your move operation would succeed based on the options you provide.

If you're trying to move resources through the Azure portal, you don't need to validate the move before attempting it. The Azure portal does an automatic validation before allowing you to move resources.

A REST API is a programmatic interface that you can call by sending HTTP requests. Programmers often call REST APIs in their custom code from clients such as mobile apps. To call a specific Azure REST method, such as the validate move operation, you can use the Azure CLI:

az rest --method post --uri <enter the correct REST operation URI here>

To formulate the correct REST URI to call, and to provide the other necessary details, you must obtain the following information:

  • Your Azure subscription ID.
  • The name of the resource group currently holding your resources.
  • The resource ID for each of the resources in your original resource group.
  • The resource ID for the destination resource group where you want to move your resources.
  • Your account access token.

When you use the Azure CLI to call an Azure REST API operation, you don't have to provide a subscription ID or an access token. The CLI includes these values automatically.

Test the validity of your move

Let's have a high-level look at the process for validating a move by using the REST API.

You can send a POST request with the following details:

POST https://management.azure.com/subscriptions/<your-subscription-id>/resourceGroups/<your-source-group>/validateMoveResources?api-version=2019-05-10
Authorization: Bearer <your-access-token>
Content-type: application/json

The body of your POST request must contain the following information:

{
 "resources": ["<your-resource-id-1>", "<your-resource-id-2>", "<your-resource-id-3>"],
 "targetResourceGroup": "/subscriptions/<your-subscription-id>/resourceGroups/<your-target-group>"
}

To submit this POST request with the correct body by using the Azure CLI, run this command:

az rest --method post \
   --uri https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/<your-source-group>/validateMoveResources?api-version=2019-05-10 \
   --body "{\"resources\": [\"<your-resource-id-1>\", \"<your-resource-id-2>\", \"<your-resource-id-3>\"], \"targetResourceGroup\": \"/subscriptions/<your-subscription-id>/resourceGroups/<your-target-group>\"}" \
   --verbose

If your request is accepted, the API returns a status code of 202:

Response Code: 202
cache-control: no-cache
pragma: no-cache
expires: -1
location: https://management.azure.com/subscriptions/<your-subscription-id>/operationresults/<your-operation-id>?api-version=2018-02-01
retry-after: 15

At this stage, the response shows that the API accepts your request, but it hasn't validated whether your move will be successful. This response gives you a location URL. Use this location URL to test your move. Wait for the amount of time shown in the retry-after value in the request validation before attempting to test your validation. In this example, the value is 15 seconds.

After waiting for the specified time, send a GET request to the location URL:

GET <location-url>
Authorization: Bearer <your-access-token>

To submit this GET request by using the Azure CLI, run this command:

az rest --method get --uri <location-url>

If your move validates as successful, you get a 204 status code. Otherwise, you receive the following error message, indicating that your move won't be successful:

{"error":{"code":"ResourceMoveProviderValidationFailed","message":"<message>"...}}

Check your knowledge

1.

In which of the following situations would a validation test happen automatically?

2.

In which of the following situations do you need to obtain an access token before you can validate a move?