通过

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

Job Agents - Get

  • 参考
服务:
SQL Database
API 版本:
2023-08-01

获取作业代理。

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

URI 参数

名称 在 必需 类型 说明
jobAgentName
 path True

string

要检索的作业代理的名称。
resourceGroupName
 path True

string

包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。
serverName
 path True

string

服务器的名称。
subscriptionId
 path True

string

标识 Azure 订阅的订阅 ID。
api-version
 query True

string

要用于请求的 API 版本。

响应

名称 类型 说明
200 OK

JobAgent

已成功检索指定的作业代理。
Other Status Codes

ErrorResponse

错误响应： ***

  • 400 ManagedInstanceStoppingOrStopped - 实例处于停止/停止状态时提交的冲突作

  • 400 ManagedInstanceStarting - 实例处于启动状态时提交的冲突作

  • 404 ServerNotInSubscriptionResourceGroup - 指定的服务器在指定的资源组和订阅中不存在。

  • 404 SubscriptionDoesNotHaveServer - 找不到请求的服务器

  • 404 JobAgentNotFound - 指定的作业代理在指定的逻辑服务器中不存在。

  • 409 ServerDisabled - 服务器已禁用。

示例

Get a job agent

示例请求

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

示例响应

状态代码:
200 
{
  "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": "JA400",
    "capacity": 400
  },
  "properties": {
    "databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db1"
  }
}

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
JobAgent

Azure SQL 作业代理。
JobAgentIdentity

资源的 Azure Active Directory 标识配置。
JobAgentIdentityType

作业代理标识类型
JobAgentState

作业代理的状态。
JobAgentUserAssignedIdentity

资源的 Azure Active Directory 标识配置。
Sku

ARM 资源 SKU。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

JobAgent

Object

Azure SQL 作业代理。

名称 类型 说明
id

string

资源 ID。
identity

JobAgentIdentity

作业代理的标识。
location

string

资源位置。
name

string

资源名称。
properties.databaseId

string (arm-id)

要在其中存储作业元数据的数据库的资源 ID。
properties.state

JobAgentState

作业代理的状态。
sku

Sku

SKU 的名称和层。
tags

object

资源标记。
type

string

资源类型。

JobAgentIdentity

Object

资源的 Azure Active Directory 标识配置。

名称 类型 说明
tenantId

string (uuid)

作业代理标识租户 ID
type

JobAgentIdentityType

作业代理标识类型
userAssignedIdentities

<string,  JobAgentUserAssignedIdentity>

要使用的用户分配标识的资源 ID

JobAgentIdentityType

枚举

作业代理标识类型

值 说明
None
SystemAssigned
SystemAssignedUserAssigned
UserAssigned

JobAgentState

枚举

作业代理的状态。

值 说明
Creating
Deleting
Disabled
Ready
Updating

JobAgentUserAssignedIdentity

Object

资源的 Azure Active Directory 标识配置。

名称 类型 说明
clientId

string (uuid)

Azure Active Directory 客户端 ID。
principalId

string (uuid)

Azure Active Directory 主体 ID。

Sku

Object

ARM 资源 SKU。

名称 类型 说明
capacity

integer (int32)

特定 SKU 的容量。
family

string

如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name

string

SKU 的名称，通常为字母 + 数字代码，例如 P3。
size

string

特定 SKU 的大小
tier

string

特定 SKU 的层或版本，例如基本 SKU、高级版。