Job Agents - List By Server
获取服务器中作业代理的列表。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents?api-version=2023-08-01
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
resource
|
path | True |
string |
包含资源的资源组的名称。 可以从 Azure 资源管理器 API 或门户获取此值。 |
|
server
|
path | True |
string |
服务器的名称。 |
|
subscription
|
path | True |
string |
标识 Azure 订阅的订阅 ID。 |
|
api-version
|
query | True |
string |
要用于请求的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
已成功检索作业代理列表。 |
|
| Other Status Codes |
错误响应: ***
|
示例
List job agents in a server
示例请求
示例响应
{
"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": "JA200",
"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": "JA400",
"capacity": 400
},
"properties": {
"databaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/databases/db12"
}
}
]
}
定义
| 名称 | 说明 |
|---|---|
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Job |
Azure SQL 作业代理。 |
|
Job |
资源的 Azure Active Directory 标识配置。 |
|
Job |
作业代理标识类型 |
|
Job |
Azure SQL 作业代理的列表。 |
|
Job |
作业代理的状态。 |
|
Job |
资源的 Azure Active Directory 标识配置。 |
| Sku |
ARM 资源 SKU。 |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
JobAgent
Azure SQL 作业代理。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源 ID。 |
| identity |
作业代理的标识。 |
|
| location |
string |
资源位置。 |
| name |
string |
资源名称。 |
| properties.databaseId |
string (arm-id) |
要在其中存储作业元数据的数据库的资源 ID。 |
| properties.state |
作业代理的状态。 |
|
| sku |
SKU 的名称和层。 |
|
| tags |
object |
资源标记。 |
| type |
string |
资源类型。 |
JobAgentIdentity
资源的 Azure Active Directory 标识配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| tenantId |
string (uuid) |
作业代理标识租户 ID |
| type |
作业代理标识类型 |
|
| userAssignedIdentities |
<string,
Job |
要使用的用户分配标识的资源 ID |
JobAgentIdentityType
作业代理标识类型
| 值 | 说明 |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssignedUserAssigned |
JobAgentListResult
Azure SQL 作业代理的列表。
| 名称 | 类型 | 说明 |
|---|---|---|
| nextLink |
string |
用于检索下一页结果的链接。 |
| value |
Job |
结果数组。 |
JobAgentState
作业代理的状态。
| 值 | 说明 |
|---|---|
| Creating | |
| Ready | |
| Updating | |
| Deleting | |
| Disabled |
JobAgentUserAssignedIdentity
资源的 Azure Active Directory 标识配置。
| 名称 | 类型 | 说明 |
|---|---|---|
| clientId |
string (uuid) |
Azure Active Directory 客户端 ID。 |
| principalId |
string (uuid) |
Azure Active Directory 主体 ID。 |
Sku
ARM 资源 SKU。
| 名称 | 类型 | 说明 |
|---|---|---|
| capacity |
integer (int32) |
特定 SKU 的容量。 |
| family |
string |
如果服务具有不同代的硬件(对于同一 SKU,则可以在此处捕获)。 |
| name |
string |
SKU 的名称,通常为字母 + 数字代码,例如 P3。 |
| size |
string |
特定 SKU 的大小 |
| tier |
string |
特定 SKU 的层或版本,例如基本 SKU、高级版。 |