你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Job Agents - List By Server

获取服务器中作业代理的列表。

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

示例请求

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

示例响应

{
  "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 的层或版本,例如基本 SKU、高级 SKU。