Managed Instance Operations - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a management operation on a managed instance.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/operations/{operationId}?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
managedInstanceName	path	True	string	The name of the managed instance.
operationId	path	True	string uuid
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	ManagedInstanceOperation	Successfully retrieved the specified managed instance operation.
Other Status Codes		*** Error Responses: *** 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Gets the managed instance management operation

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/00000000-1111-2222-3333-444444444444?api-version=2021-11-01

Java

import com.azure.core.util.Context;
import java.util.UUID;

/** Samples for ManagedInstanceOperations Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetManagedInstanceOperation.json
     */
    /**
     * Sample code: Gets the managed instance management operation.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsTheManagedInstanceManagementOperation(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceOperations().getWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", UUID.fromString("00000000-1111-2222-3333-444444444444"), Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "properties": {
    "managedInstanceName": "sqlcrudtest-4645",
    "operation": "UpsertManagedServer",
    "operationFriendlyName": "UPDATE MANAGED SERVER",
    "percentComplete": 100,
    "startTime": "2019-12-06T11:08:44.49Z",
    "state": "Cancelled",
    "isCancellable": false,
    "operationSteps": {
      "totalSteps": "6",
      "currentStep": 2,
      "stepsList": [
        {
          "order": 1,
          "name": "Request validation",
          "status": "Completed",
          "stepEndTime": "2019-12-06T11:08:45.57Z",
          "stepStartTime": "2019-12-06T11:08:44.49Z",
          "timeElapsed": "0"
        },
        {
          "order": 2,
          "name": "Virtual Cluster resize/creation",
          "status": "Completed",
          "stepEndTime": "2019-12-06T11:23:05.47Z",
          "stepStartTime": "2019-12-06T11:08:46.05Z",
          "timeElapsed": "14"
        },
        {
          "order": 3,
          "name": "New SQL Instance Startup",
          "status": "Canceled",
          "stepEndTime": "2019-12-06T11:23:11.51Z",
          "stepStartTime": "2019-12-06T11:23:05.55Z",
          "timeElapsed": "0"
        },
        {
          "order": 4,
          "name": "Seeding database files",
          "status": "NotStarted"
        },
        {
          "order": 5,
          "name": "Preparing Failover and Failover",
          "status": "NotStarted"
        },
        {
          "order": 6,
          "name": "Old SQL Instance cleanup",
          "status": "NotStarted"
        }
      ]
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/11111111-1111-1111-1111-111111111111",
  "name": "11111111-1111-1111-1111-111111111111",
  "type": "Microsoft.Sql/managedInstances/operations"
}

Definitions

Name	Description
ManagedInstanceOperation	A managed instance operation.
ManagedInstanceOperationParametersPair	The parameters of a managed instance operation.
ManagedInstanceOperationSteps	The steps of a managed instance operation.
ManagementOperationState	The operation state.
status
UpsertManagedServerOperationParameters
UpsertManagedServerOperationStepWithEstimatesAndDuration

ManagedInstanceOperation

A managed instance operation.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.description	string	The operation description.
properties.errorCode	integer	The operation error code.
properties.errorDescription	string	The operation error description.
properties.errorSeverity	integer	The operation error severity.
properties.estimatedCompletionTime	string	The estimated completion time of the operation.
properties.isCancellable	boolean	Whether the operation can be cancelled.
properties.isUserError	boolean	Whether or not the error is a user error.
properties.managedInstanceName	string	The name of the managed instance the operation is being performed on.
properties.operation	string	The name of operation.
properties.operationFriendlyName	string	The friendly name of operation.
properties.operationParameters	ManagedInstanceOperationParametersPair	The operation parameters.
properties.operationSteps	ManagedInstanceOperationSteps	The operation steps.
properties.percentComplete	integer	The percentage of the operation completed.
properties.startTime	string	The operation start time.
properties.state	ManagementOperationState	The operation state.
type	string	Resource type.

ManagedInstanceOperationParametersPair

The parameters of a managed instance operation.

Name	Type	Description
currentParameters	UpsertManagedServerOperationParameters	The current parameters.
requestedParameters	UpsertManagedServerOperationParameters	The requested parameters.

ManagedInstanceOperationSteps

The steps of a managed instance operation.

Name	Type	Description
currentStep	integer	The number of current operation steps.
stepsList	UpsertManagedServerOperationStepWithEstimatesAndDuration[]	The operation steps list.
totalSteps	string	The total number of operation steps.

ManagementOperationState

The operation state.

Name	Type	Description
CancelInProgress	string
Cancelled	string
Failed	string
InProgress	string
Pending	string
Succeeded	string

status

Name	Type	Description
Canceled	string
Completed	string
Failed	string
InProgress	string
NotStarted	string
SlowedDown	string

UpsertManagedServerOperationParameters

Name	Type	Description
family	string
storageSizeInGB	integer
tier	string
vCores	integer

UpsertManagedServerOperationStepWithEstimatesAndDuration

Name	Type	Description
name	string
order	integer
status	status
stepEndTime	string
stepStartTime	string
timeElapsed	string