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

Job - List By Automation Account

服务:: Automation

API 版本:: 2024-10-23

检索作业列表。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?api-version=2024-10-23

具有可选参数:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs?$filter={$filter}&api-version=2024-10-23

URI 参数

名称	在	必需	类型	说明
automationAccountName	path	True	string	自动化帐户的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure 资源组的名称。
subscriptionId	path	True	string	获取唯一标识Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	要对操作应用的筛选器。

请求头

名称	必需	类型	说明
clientRequestId		string	标识此特定的客户端请求。

响应

名称	类型	说明
200 OK	JobListResultV2	好的
Other Status Codes	ErrorResponse	描述操作失败原因的自动化错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List jobs by automation account

示例请求

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/jobs?api-version=2024-10-23

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/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,
        "jobRuntimeEnvironment": {
          "runtimeEnvironmentName": "environmentName"
        }
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContosoAutomationAccount/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",
        "jobRuntimeEnvironment": {
          "runtimeEnvironmentName": "environmentName"
        }
      }
    }
  ],
  "nextLink": null
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorResponse	操作失败的错误响应
JobCollectionItem	作业集合项属性。
JobListResultV2	列表作业作的响应模型。
JobRuntimeEnvironment	与实体关联的 Runbook 属性。
JobStatus	获取或设置作业的状态。
RunbookAssociationProperty	与实体关联的 Runbook 属性。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

ErrorResponse

Object

操作失败的错误响应

名称	类型	说明
code	string	错误代码
message	string	指示操作失败的原因的错误消息。

JobCollectionItem

Object

作业集合项属性。

名称	类型	说明
id	string (arm-id)	资源的完全限定的资源 ID。例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.creationTime	string (date-time)	作业的创建时间。
properties.endTime	string (date-time)	作业的结束时间。
properties.jobId	string (uuid)	作业的 ID。
properties.jobRuntimeEnvironment	JobRuntimeEnvironment	运行时环境属性
properties.lastModifiedTime	string (date-time)	作业的上次修改时间。
properties.provisioningState	string	资源的预配状态。
properties.runOn	string	指定执行作业的 runOn 组名称。
properties.runbook	RunbookAssociationProperty	Runbook 关联。
properties.startTime	string (date-time)	作业的开始时间。
properties.startedBy	string	获取或设置从其开始的作业。
properties.status	JobStatus	作业的状态。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

JobListResultV2

Object

列表作业作的响应模型。

名称	类型	说明
nextLink	string	指向下一页的链接。
value	JobCollectionItem[]	作业列表。

JobRuntimeEnvironment

Object

与实体关联的 Runbook 属性。

名称	类型	说明
runtimeEnvironmentName	string	运行时环境的名称。

JobStatus

枚举

获取或设置作业的状态。

值	说明
New
Activating
Running
Completed
Failed
Stopped
Blocked
Suspended
Disconnected
Suspending
Stopping
Resuming
Removing

RunbookAssociationProperty

Object

与实体关联的 Runbook 属性。

名称	类型	说明
name	string	获取或设置 Runbook 的名称。

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

通过

Job - List By Automation Account

URI 参数

请求头

响应

安全性

azure_auth

作用域

示例

List jobs by automation account

示例请求

示例响应

定义

createdByType

ErrorResponse

JobCollectionItem

JobListResultV2

JobRuntimeEnvironment

JobStatus

RunbookAssociationProperty

systemData