Operation Progress - Get

Service:

MySQL

API Version:

2024-12-30

Get the operation result for a long running operation.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/operationProgress/{operationId}?api-version=2024-12-30

URI Parameters

Name	In	Required	Type	Description
locationName	path	True	string minLength: 1 pattern: ^[ \w]+$	The name of the location.
operationId	path	True	string minLength: 1	The ID of an ongoing async operation.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationProgressResult	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

OperationProgress_Get BackupAndExport

OperationProgress_Get ImportFromStorage

OperationProgress_Get BackupAndExport

Sample request

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/westus/operationProgress/00000000-0000-0000-0000-000000000000?api-version=2024-12-30

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python operation_progress_get_backup_and_export.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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.operation_progress.get(
        location_name="westus",
        operation_id="00000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/examples/OperationProgress_Get_BackupAndExport.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

Sample response

Status code:

200

{
  "name": "00000000-0000-0000-0000-000000000000",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/westus/operationProgress/00000000-0000-0000-0000-000000000000",
  "percentComplete": 10,
  "properties": {
    "backupMetadata": "{\"key1\":\"value1\",\"key2\":\"value2\"}",
    "dataTransferredInBytes": 102,
    "datasourceSizeInBytes": 1024,
    "objectType": "BackupAndExportResponse"
  },
  "startTime": "2023-11-29T07:34:02.328326Z",
  "status": "InProgress"
}

OperationProgress_Get ImportFromStorage

Sample request

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/westus/operationProgress/00000000-0000-0000-0000-000000000000?api-version=2024-12-30

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.mysqlflexibleservers import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-mysqlflexibleservers
# USAGE
    python operation_progress_get_import_from_storage.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 = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.operation_progress.get(
        location_name="westus",
        operation_id="00000000-0000-0000-0000-000000000000",
    )
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/stable/2024-12-30/examples/OperationProgress_Get_ImportFromStorage.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

Sample response

Status code:

200

{
  "name": "00000000-0000-0000-0000-000000000000",
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMySQL/locations/westus/operationProgress/00000000-0000-0000-0000-000000000000",
  "percentComplete": 10,
  "properties": {
    "estimatedCompletionTime": "2023-11-29T08:34:02.328326Z",
    "objectType": "ImportFromStorageResponse"
  },
  "startTime": "2023-11-29T07:34:02.328326Z",
  "status": "InProgress"
}

Definitions

Name	Description
BackupAndExportResponseType	BackupAndExport Response Properties
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ImportFromStorageResponseType	ImportFromStorage Response Properties
ObjectType	Identifies the type of source operation
OperationProgressResult	Represents Operation Results API Response
OperationStatusResult	The current status of an async operation.

BackupAndExportResponseType

Object

BackupAndExport Response Properties

Name	Type	Description
backupMetadata	string	Metadata related to backup to be stored for restoring resource in key-value pairs.
dataTransferredInBytes	integer (int64)	Data transferred in bytes
datasourceSizeInBytes	integer (int64)	Size of datasource in bytes
objectType	string: BackupAndExportResponse	Identifies the type of source operation

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ImportFromStorageResponseType

Object

ImportFromStorage Response Properties

Name	Type	Description
estimatedCompletionTime	string (date-time)	The estimated time of operation completion.
objectType	string: ImportFromStorageResponse	Identifies the type of source operation

ObjectType

Enumeration

Identifies the type of source operation

Value	Description
BackupAndExportResponse
ImportFromStorageResponse

OperationProgressResult

Object

Represents Operation Results API Response

Name	Type	Description
endTime	string (date-time)	The end time of the operation.
error	ErrorDetail	If present, details of the operation error.
id	string (arm-id)	Fully qualified ID for the async operation.
name	string	Name of the async operation.
operations	OperationStatusResult[]	The operations list.
percentComplete	number minimum: 0 maximum: 100	Percent of the operation that is complete.
properties	OperationProgressResponseType: BackupAndExportResponseType ImportFromStorageResponseType	The response properties specific to the operation
resourceId	string (arm-id)	Fully qualified ID of the resource against which the original async operation was started.
startTime	string (date-time)	The start time of the operation.
status	string	Operation status.

OperationStatusResult

Object

The current status of an async operation.

Name	Type	Description
endTime	string (date-time)	The end time of the operation.
error	ErrorDetail	If present, details of the operation error.
id	string (arm-id)	Fully qualified ID for the async operation.
name	string	Name of the async operation.
operations	OperationStatusResult[]	The operations list.
percentComplete	number minimum: 0 maximum: 100	Percent of the operation that is complete.
resourceId	string (arm-id)	Fully qualified ID of the resource against which the original async operation was started.
startTime	string (date-time)	The start time of the operation.
status	string	Operation status.