Job Agents - List By Server

サービス:

SQL Database

API バージョン:

2021-11-01

サーバー内のジョブ エージェントの一覧を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents?api-version=2021-11-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースを含むリソース グループの名前。 この値は、Azure Resource Manager API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求に使用する API バージョン。

応答

名前	型	説明
200 OK	JobAgentListResult	ジョブ エージェントの一覧が正常に取得されました。
Other Status Codes		エラー応答: *** 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソース グループとサブスクリプションに存在しません。 409 ServerDisabled - サーバーが無効になっています。

例

List job agents in a server

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents?api-version=2021-11-01

Java

/**
 * Samples for JobAgents ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobAgentsByServer.json
     */
    /**
     * Sample code: List job agents in a server.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobAgentsInAServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobAgents().listByServer("group1", "server1",
            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

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1",
      "name": "agent1",
      "type": "Microsoft.Sql/servers/jobAgents",
      "location": "southeastasia",
      "sku": {
        "name": "Agent",
        "capacity": 200
      },
      "properties": {
        "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/jobAgent2",
      "name": "jobAgent2",
      "type": "Microsoft.Sql/servers/jobAgents",
      "location": "southeastasia",
      "sku": {
        "name": "Agent",
        "capacity": 400
      },
      "properties": {
        "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db12"
      }
    }
  ]
}

定義

名前	説明
JobAgent	Azure SQL ジョブ エージェント。
JobAgentListResult	Azure SQL ジョブ エージェントの一覧。
JobAgentState	ジョブ エージェントの状態。
Sku	ARM リソース SKU。

JobAgent

Object

Azure SQL ジョブ エージェント。

名前	型	説明
id	string	リソース ID。
location	string	リソースの場所。
name	string	リソース名。
properties.databaseId	string (arm-id)	ジョブ メタデータを格納するデータベースのリソース ID。
properties.state	JobAgentState	ジョブ エージェントの状態。
sku	Sku	SKU の名前と層。
tags	object	リソース タグ。
type	string	リソースの種類。

JobAgentListResult

Object

Azure SQL ジョブ エージェントの一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	JobAgent[]	結果の配列。

JobAgentState

列挙

ジョブ エージェントの状態。

値	説明
Creating
Deleting
Disabled
Ready
Updating

Sku

Object

ARM リソース SKU。

名前	型	説明
capacity	integer (int32)	特定の SKU の容量。
family	string	同じ SKU に対して、サービスの世代が異なるハードウェアがある場合は、ここでキャプチャできます。
name	string	SKU の名前 。通常は、文字 + 番号コード (P3 など)。
size	string	特定の SKU のサイズ
tier	string	特定の SKU のレベルまたはエディション (Basic、Premium など)。