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 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	可識別 Azure 訂用帳戶的訂用帳戶識別碼。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
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"
      }
    }
  ]
}

定義

名稱	Description
JobAgent	Azure SQL 作業代理程式。
JobAgentListResult	Azure SQL 作業代理程式的清單。
JobAgentState	作業代理程序的狀態。
Sku	ARM 資源 SKU。

JobAgent

Azure SQL 作業代理程式。

名稱	類型	Description
id	string	資源識別碼。
location	string	資源位置。
name	string	資源名稱。
properties.databaseId	string	要儲存作業元數據的資料庫資源標識碼。
properties.state	JobAgentState	作業代理程序的狀態。
sku	Sku	SKU 的名稱和層級。
tags	object	資源標籤。
type	string	資源類型。

JobAgentListResult

Azure SQL 作業代理程式的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	JobAgent[]	結果陣列。

JobAgentState

作業代理程序的狀態。

名稱	類型	Description
Creating	string
Deleting	string
Disabled	string
Ready	string
Updating	string

Sku

ARM 資源 SKU。

名稱	類型	Description
capacity	integer	特定 SKU 的容量。
family	string	如果服務有不同的硬體世代，則針對相同的 SKU，則可以在這裡擷取。
name	string	SKU 的名稱，通常是字母 + 編號代碼，例如 P3。
size	string	特定 SKU 的大小
tier	string	特定 SKU 的層級或版本，例如基本、進階。