Managed Instance Operations - Get

服務:

SQL Database

API 版本:

2025-01-01

取得受控實例上的管理作業。

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

URI 參數

名稱	位於	必要	類型	Description
managedInstanceName	path	True	string	受控實例的名稱。
operationId	path	True	string (uuid)
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。 名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	ManagedInstanceOperation	Azure 運作順利完成。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Gets the managed instance management operation

範例要求

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=2025-01-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python get_managed_instance_operation.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.managed_instance_operations.get(
        resource_group_name="sqlcrudtest-7398",
        managed_instance_name="sqlcrudtest-4645",
        operation_id="00000000-1111-2222-3333-444444444444",
    )
    print(response)


# x-ms-original-file: 2025-01-01/GetManagedInstanceOperation.json
if __name__ == "__main__":
    main()

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/GetManagedInstanceOperation.json
// this example is just showing the usage of "ManagedInstanceOperations_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceOperationResource created on azure
// for more information of creating ManagedInstanceOperationResource, please refer to the document of ManagedInstanceOperationResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string managedInstanceName = "sqlcrudtest-4645";
Guid operationId = Guid.Parse("00000000-1111-2222-3333-444444444444");
ResourceIdentifier managedInstanceOperationResourceId = ManagedInstanceOperationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, operationId);
ManagedInstanceOperationResource managedInstanceOperation = client.GetManagedInstanceOperationResource(managedInstanceOperationResourceId);

// invoke the operation
ManagedInstanceOperationResource result = await managedInstanceOperation.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ManagedInstanceOperationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

範例回覆

狀態碼:

200

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

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤附加資訊。
ErrorDetail	錯誤詳細資料。
ErrorResponse	錯誤回應
ManagedInstanceOperation	受控實例作業。
ManagedInstanceOperationParametersPair	受控實例作業的參數。
ManagedInstanceOperationSteps	受控實例作業的步驟。
ManagementOperationState	作業狀態。
systemData	與建立和上次修改資源相關的元數據。
UpsertManagedServerOperationParameters
UpsertManagedServerOperationStepWithEstimatesAndDuration
UpsertManagedServerOperationStepWithEstimatesAndDurationStatus

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤附加資訊。

名稱	類型	Description
info	object	附加資訊。
type	string	其他資訊類型。

ErrorDetail

Object

錯誤詳細資料。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤附加資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳情
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	錯誤物件。

ManagedInstanceOperation

Object

受控實例作業。

名稱	類型	Description
id	string (arm-id)	資源的完整資源標識碼。 例如，“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	資源的名稱
properties.description	string	作業描述。
properties.errorCode	integer (int32)	作業錯誤碼。
properties.errorDescription	string	作業錯誤描述。
properties.errorSeverity	integer (int32)	作業錯誤嚴重性。
properties.estimatedCompletionTime	string (date-time)	作業的預估完成時間。
properties.isCancellable	boolean	是否可以取消作業。
properties.isUserError	boolean	錯誤是否為用戶錯誤。
properties.managedInstanceName	string	執行作業的受控實例名稱。
properties.operation	string	作業的名稱。
properties.operationFriendlyName	string	作業的易記名稱。
properties.operationParameters	ManagedInstanceOperationParametersPair	作業參數。
properties.operationSteps	ManagedInstanceOperationSteps	作業步驟。
properties.percentComplete	integer (int32)	作業完成的百分比。
properties.startTime	string (date-time)	作業開始時間。
properties.state	ManagementOperationState	作業狀態。
systemData	systemData	Azure Resource Manager 包含 createdBy 與 modifiedBy 資訊的元資料。
type	string	資源的類型。 例如：「Microsoft。運算/虛擬機器」或「Microsoft」。儲存/儲存帳號」

ManagedInstanceOperationParametersPair

Object

受控實例作業的參數。

名稱	類型	Description
currentParameters	UpsertManagedServerOperationParameters	目前的參數。
requestedParameters	UpsertManagedServerOperationParameters	要求的參數。

ManagedInstanceOperationSteps

Object

受控實例作業的步驟。

名稱	類型	Description
currentStep	integer (int32)	目前作業步驟的數目。
stepsList	UpsertManagedServerOperationStepWithEstimatesAndDuration[]	作業步驟清單。
totalSteps	string	作業步驟總數。

ManagementOperationState

列舉型別

作業狀態。

值	Description
Pending	等待中
InProgress	進行中
Succeeded	成功
Failed	失敗
CancelInProgress	取消進行中
Cancelled	已取消

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	資源上次修改的時間戳記 （UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

UpsertManagedServerOperationParameters

Object

名稱	類型	Description
family	string
storageSizeInGB	integer (int32)
tier	string
vCores	integer (int32)

UpsertManagedServerOperationStepWithEstimatesAndDuration

Object

名稱	類型	Description
name	string
order	integer (int32)
status	UpsertManagedServerOperationStepWithEstimatesAndDurationStatus
stepEndTime	string (date-time)
stepStartTime	string (date-time)
timeElapsed	string

UpsertManagedServerOperationStepWithEstimatesAndDurationStatus

列舉型別

值	Description
NotStarted	尚未開始
InProgress	進行中
SlowedDown	慢下來
Completed	已完成
Failed	失敗
Canceled	已取消