Workload Classifiers - Get

サービス:

SQL Database

API バージョン:

2025-01-01

ワークロード分類子を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/workloadGroups/{workloadGroupName}/workloadClassifiers/{workloadClassifierName}?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 である必要があります。
workloadClassifierName	path	True	string	ワークロード分類子の名前。
workloadGroupName	path	True	string	ワークロード グループの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	WorkloadClassifier	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	ユーザー アカウントを偽装する

例

Gets a workload classifier for a data warehouse

要求のサンプル

HTTP

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

Java

/**
 * Samples for WorkloadClassifiers Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/GetWorkloadClassifier.json
     */
    /**
     * Sample code: Gets a workload classifier for a data warehouse.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void
        getsAWorkloadClassifierForADataWarehouse(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getWorkloadClassifiers().getWithResponse("Default-SQL-SouthEastAsia", "testsvr",
            "testdb", "wlm_workloadgroup", "wlm_classifier", 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 get_workload_classifier.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.workload_classifiers.get(
        resource_group_name="Default-SQL-SouthEastAsia",
        server_name="testsvr",
        database_name="testdb",
        workload_group_name="wlm_workloadgroup",
        workload_classifier_name="wlm_classifier",
    )
    print(response)


# x-ms-original-file: 2025-01-01/GetWorkloadClassifier.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 workload classifier
 *
 * @summary gets a workload classifier
 * x-ms-original-file: 2025-01-01/GetWorkloadClassifier.json
 */
async function getsAWorkloadClassifierForADataWarehouse() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.workloadClassifiers.get(
    "Default-SQL-SouthEastAsia",
    "testsvr",
    "testdb",
    "wlm_workloadgroup",
    "wlm_classifier",
  );
  console.log(result);
}

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/GetWorkloadClassifier.json
// this example is just showing the usage of "WorkloadClassifiers_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 WorkloadClassifierResource created on azure
// for more information of creating WorkloadClassifierResource, please refer to the document of WorkloadClassifierResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string serverName = "testsvr";
string databaseName = "testdb";
string workloadGroupName = "wlm_workloadgroup";
string workloadClassifierName = "wlm_classifier";
ResourceIdentifier workloadClassifierResourceId = WorkloadClassifierResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, workloadGroupName, workloadClassifierName);
WorkloadClassifierResource workloadClassifier = client.GetWorkloadClassifierResource(workloadClassifierResourceId);

// invoke the operation
WorkloadClassifierResource result = await workloadClassifier.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
WorkloadClassifierData 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": "wlm_classifier",
  "type": "Microsoft.Sql/servers/databases/workloadGroups/workloadClassifiers",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb/workloadGroups/wlm_workloadgroup/workloadClassifiers/wlm_classifier",
  "properties": {
    "context": "test_context",
    "endTime": "14:00",
    "importance": "high",
    "label": "test_label",
    "memberName": "dbo",
    "startTime": "12:00"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。
WorkloadClassifier	データ ウェアハウスのワークロード分類子操作

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

systemData

Object

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

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

WorkloadClassifier

Object

データ ウェアハウスのワークロード分類子操作

名前	型	説明
id	string (arm-id)	リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	リソースの名前
properties.context	string	ワークロード分類子コンテキスト。
properties.endTime	string	分類のワークロード分類子の終了時刻。
properties.importance	string	ワークロード分類子の重要度。
properties.label	string	ワークロード分類子ラベル。
properties.memberName	string	ワークロード分類子メンバー名。
properties.startTime	string	分類のワークロード分類子の開始時刻。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」