Global Schedules - Retarget

Updates a schedule's target resource Id. This operation can take a while to complete.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget?api-version=2018-09-15

URI Parameters

Name In Required Type Description
name
path True

string

The name of the schedule.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription ID.

api-version
query True

string

Client API version.

Request Body

Name Type Description
currentResourceId

string

The resource Id of the virtual machine on which the schedule operates

targetResourceId

string

The resource Id of the virtual machine that the schedule should be retargeted to

Responses

Name Type Description
200 OK

OK

202 Accepted

Accepted

Other Status Codes

CloudError

BadRequest

Security

azure_auth

OAuth2 Implicit Grant

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

Scopes

Name Description
user_impersonation Access Microsoft Azure

Examples

GlobalSchedules_Retarget

Sample Request

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/resourceGroupName/providers/Microsoft.DevTestLab/schedules/{scheduleName}/retarget?api-version=2018-09-15

{
  "targetResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{currentLab}",
  "currentResourceId": "/subscriptions/{subscriptionId}/resourcegroups/resourceGroupName/providers/microsoft.devtestlab/labs/{targetLab}"
}

Sample Response

location: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroup/{resourceGroupName}/providers/Microsoft.DevTestLabs/locations/{location}

Definitions

Name Description
CloudError

Error from a REST request.

CloudErrorBody

Body of an error from a REST request.

RetargetScheduleProperties

Properties for retargeting a virtual machine schedule.

CloudError

Error from a REST request.

Name Type Description
error

CloudErrorBody

The cloud error that occurred

CloudErrorBody

Body of an error from a REST request.

Name Type Description
code

string

The error code.

details

CloudErrorBody[]

Inner errors.

message

string

The error message.

target

string

The error target.

RetargetScheduleProperties

Properties for retargeting a virtual machine schedule.

Name Type Description
currentResourceId

string

The resource Id of the virtual machine on which the schedule operates

targetResourceId

string

The resource Id of the virtual machine that the schedule should be retargeted to