你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Job - List By Automation Account
检索作业列表。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?api-version=2023-11-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?$filter={$filter}&api-version=2023-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
automation
|
path | True |
string |
自动化帐户的名称。 |
resource
|
path | True |
string |
Azure 资源组的名称。 正则表达式模式: |
subscription
|
path | True |
string |
获取唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
$filter
|
query |
string |
要应用于操作的筛选器。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
clientRequestId |
string |
标识此特定客户端请求。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
描述操作失败原因的自动化错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
List jobs by automation account
示例请求
GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs?api-version=2023-11-01
示例响应
{
"value": [
{
"id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job1",
"name": "job1",
"type": "Microsoft.Automation/AutomationAccounts/Jobs",
"properties": {
"jobId": "45203a94-a8cb-47c3-8ce4-4dcc3a5f7d23",
"runbook": {
"name": "TestRunbook"
},
"provisioningState": "Succeeded",
"status": "New",
"creationTime": "2017-03-30T05:53:30.243+00:00",
"startTime": null,
"lastModifiedTime": "2017-03-30T05:53:30.243+00:00",
"endTime": null
}
},
{
"id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/job2",
"name": "job2",
"type": "Microsoft.Automation/AutomationAccounts/Jobs",
"properties": {
"jobId": "7584055f-5118-460a-a2dd-5176c9c8efe9",
"runbook": {
"name": "TestRunbook"
},
"provisioningState": "Succeeded",
"status": "Completed",
"creationTime": "2017-03-30T05:46:49.37+00:00",
"startTime": "2017-03-30T05:47:35.2+00:00",
"lastModifiedTime": "2017-03-30T05:48:38.857+00:00",
"endTime": "2017-03-30T05:48:38.857+00:00"
}
}
],
"nextLink": null
}
定义
名称 | 说明 |
---|---|
Error |
操作失败的错误响应 |
Job |
作业集合项属性。 |
Job |
列表作业操作的响应模型。 |
Job |
获取或设置作业的状态。 |
Runbook |
与实体关联的 Runbook 属性。 |
ErrorResponse
操作失败的错误响应
名称 | 类型 | 说明 |
---|---|---|
code |
string |
错误代码 |
message |
string |
指示操作失败原因的错误消息。 |
JobCollectionItem
作业集合项属性。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源的完全限定资源 ID |
name |
string |
资源的名称 |
properties.creationTime |
string |
作业的创建时间。 |
properties.endTime |
string |
作业的结束时间。 |
properties.jobId |
string |
作业的 ID。 |
properties.lastModifiedTime |
string |
作业的上次修改时间。 |
properties.provisioningState |
string |
资源的预配状态。 |
properties.runOn |
string |
指定执行作业的 runOn 组名称。 |
properties.runbook |
Runbook 关联。 |
|
properties.startTime |
string |
作业的开始时间。 |
properties.status |
作业的状态。 |
|
type |
string |
资源类型。 |
JobListResultV2
列表作业操作的响应模型。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
指向下一页的链接。 |
value |
作业列表。 |
JobStatus
获取或设置作业的状态。
名称 | 类型 | 说明 |
---|---|---|
Activating |
string |
|
Blocked |
string |
|
Completed |
string |
|
Disconnected |
string |
|
Failed |
string |
|
New |
string |
|
Removing |
string |
|
Resuming |
string |
|
Running |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Suspended |
string |
|
Suspending |
string |
RunbookAssociationProperty
与实体关联的 Runbook 属性。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
获取或设置 Runbook 的名称。 |