Database Operations - List By Database

サービス:

SQL Database

API バージョン:

2025-01-01

データベースに対して実行された操作の一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/operations?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前の大文字と小文字は区別されません。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	DatabaseOperationListResult	Azureの運用は無事に完了しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

List the database management operations

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations?api-version=2025-01-01

Java

/**
 * Samples for DatabaseOperations ListByDatabase.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/ListDatabaseOperations.json
     */
    /**
     * Sample code: List the database management operations.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void listTheDatabaseManagementOperations(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getDatabaseOperations().listByDatabase("Default-SQL-SouthEastAsia", "testsvr", "testdb",
            com.azure.core.util.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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python list_database_operations.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.database_operations.list_by_database(
        resource_group_name="Default-SQL-SouthEastAsia",
        server_name="testsvr",
        database_name="testdb",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-01-01/ListDatabaseOperations.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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a list of operations performed on the database.
 *
 * @summary gets a list of operations performed on the database.
 * x-ms-original-file: 2025-01-01/ListDatabaseOperations.json
 */
async function listTheDatabaseManagementOperations() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.databaseOperations.listByDatabase(
    "Default-SQL-SouthEastAsia",
    "testsvr",
    "testdb",
  )) {
    resArray.push(item);
  }

  console.log(resArray);
}

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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/ListDatabaseOperations.json
// this example is just showing the usage of "DatabaseOperations_ListByDatabase" 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 SqlDatabaseResource created on azure
// for more information of creating SqlDatabaseResource, please refer to the document of SqlDatabaseResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtestgroup";
string serverName = "testsvr";
string databaseName = "testdb";
ResourceIdentifier sqlDatabaseResourceId = SqlDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName);
SqlDatabaseResource sqlDatabase = client.GetSqlDatabaseResource(sqlDatabaseResourceId);

// invoke the operation and iterate over the result
await foreach (DatabaseOperationData item in sqlDatabase.GetDatabaseOperationsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "name": "11111111-1111-1111-1111-111111111111",
      "type": "Microsoft.Sql/servers/databases/operations",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/11111111-1111-1111-1111-111111111111",
      "properties": {
        "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_2', target ServiceLevelObjective 'SQLDB_HS_Gen5_2', target database MaxSize '32'GB",
        "databaseName": "testdb",
        "estimatedCompletionTime": "2023-02-17T14:30:30.71Z",
        "isCancellable": true,
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "percentComplete": 100,
        "serverName": "testsvr",
        "startTime": "2023-02-13T06:25:23.67Z",
        "state": "Succeeded"
      }
    },
    {
      "name": "55555555-5555-5555-5555-555555555555",
      "type": "Microsoft.Sql/servers/databases/operations",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555",
      "properties": {
        "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_BC_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB",
        "databaseName": "testdb",
        "estimatedCompletionTime": "2024-09-27T12:44:33.953Z",
        "isCancellable": true,
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "operationPhaseDetails": {
          "phase": "LogTransitionInProgress",
          "phaseInformation": {
            "currentStep": "1",
            "logTransitioningInProgress": "True",
            "totalSteps": "6"
          }
        },
        "percentComplete": 50,
        "serverName": "testsvr",
        "startTime": "2024-09-27T05:42:30.097Z",
        "state": "InProgress"
      }
    },
    {
      "name": "55555555-5555-5555-5555-555555555555",
      "type": "Microsoft.Sql/servers/databases/operations",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555",
      "properties": {
        "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB",
        "databaseName": "testdb",
        "estimatedCompletionTime": "2024-09-27T12:28:10.83Z",
        "isCancellable": true,
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "operationPhaseDetails": {
          "phase": "BuildingHyperscaleComponents",
          "phaseInformation": {
            "creatingPrimaryHyperscaleComponents": "True",
            "currentStep": "3",
            "totalSteps": "6"
          }
        },
        "percentComplete": 50,
        "serverName": "testsvr",
        "startTime": "2024-09-27T05:13:37.84Z",
        "state": "InProgress"
      }
    },
    {
      "name": "55555555-5555-5555-5555-555555555555",
      "type": "Microsoft.Sql/servers/databases/operations",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555",
      "properties": {
        "description": "'UpdateLogicalDatabase' on database 'testdb', Source ServiceLevelObjective 'SQLDB_GP_Gen5_6', target ServiceLevelObjective 'SQLDB_HS_Gen5_6', target database MaxSize '32'GB",
        "databaseName": "testdb",
        "estimatedCompletionTime": "2024-09-27T14:59:54.38Z",
        "isCancellable": true,
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "operationPhaseDetails": {
          "phase": "WaitingForCutover",
          "phaseInformation": {
            "currentStep": "5",
            "dataDelayInMb": "0",
            "performCutoverBy": "2024-09-30T07:43:55.08Z",
            "totalSteps": "6"
          }
        },
        "percentComplete": 50,
        "serverName": "testsvr",
        "startTime": "2024-09-27T07:31:56.087Z",
        "state": "InProgress"
      }
    },
    {
      "name": "55555555-5555-5555-5555-555555555555",
      "type": "Microsoft.Sql/servers/databases/operations",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/operations/55555555-5555-5555-5555-555555555555",
      "properties": {
        "description": "'UpdateLogicalDatabase' on database 'testdb'",
        "databaseName": "testdb",
        "errorCode": 40640,
        "errorDescription": "The server encountered an unexpected exception.",
        "errorSeverity": 20,
        "isUserError": true,
        "operation": "UpdateLogicalDatabase",
        "operationFriendlyName": "ALTER DATABASE",
        "percentComplete": 100,
        "serverName": "testsvr",
        "startTime": "2023-02-24T11:48:29.16Z",
        "state": "Failed"
      }
    }
  ]
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
DatabaseOperation	データベース操作。
DatabaseOperationListResult	DatabaseOperationのリスト操作の応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ManagementOperationState	操作の状態。
Phase	操作フェーズ。
PhaseDetails	フェーズでは、データベース操作のプロパティの詳細が表示されます。
systemData	リソースの作成と最後の変更に関連するメタデータ。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DatabaseOperation

Object

データベース操作。

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.databaseName	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.operation	string	操作の名前。
properties.operationFriendlyName	string	操作のフレンドリ名。
properties.operationPhaseDetails	PhaseDetails	操作フェーズの詳細。
properties.percentComplete	integer (int32)	操作が完了した割合。
properties.serverName	string	サーバーの名前。
properties.startTime	string (date-time)	操作の開始時刻。
properties.state	ManagementOperationState	操作の状態。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

DatabaseOperationListResult

Object

DatabaseOperationのリスト操作の応答。

名前	型	説明
nextLink	string (uri)	項目の次のページへのリンク
value	DatabaseOperation[]	このページのDatabaseOperation項目

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

ManagementOperationState

列挙

操作の状態。

値	説明
Pending	保留中
InProgress	進行中
Succeeded	成功しました
Failed	失敗
CancelInProgress	キャンセル進行中
Cancelled	キャンセル済み

Phase

列挙

操作フェーズ。

値	説明
LogTransitionInProgress	ログトランジション進行中
Copying	コピー
BuildingHyperscaleComponents	建物ハイパースケールコンポーネント
Catchup	巻き返し
WaitingForCutover	カットオーバーを待機する
CutoverInProgress	カットオーバー進行中

PhaseDetails

Object

フェーズでは、データベース操作のプロパティの詳細が表示されます。

名前	型	説明
phase	Phase	操作フェーズ。
phaseInformation	object	操作フェーズ情報。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。