Job Agents - List By Server

Service:

SQL Database

API Version:

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 リソース マネージャー 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

Sample Request

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

import com.azure.core.util.Context;

/** 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", 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

Sample Response

Status code:

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

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

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

JobAgentListResult

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

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

JobAgentState

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

名前	型	説明
Creating	string
Deleting	string
Disabled	string
Ready	string
Updating	string

Sku

ARM リソース SKU。

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