Job - List By Automation Account

服務:

Automation

API 版本:

2023-11-01

擷取作業清單。

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 參數

名稱	位於	必要	類型	Description
automationAccountName	path	True	string	自動化帳戶的名稱。
resourceGroupName	path	True	string	Azure 資源群組的名稱。 Regex 模式: ^[-\w\._]+$
subscriptionId	path	True	string	取得用來唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
api-version	query	True	string	用戶端 API 版本。
$filter	query		string	要套用至作業的篩選。

要求標頭

名稱	必要	類型	Description
clientRequestId		string	識別這個特定的用戶端要求。

回應

名稱	類型	Description
200 OK	JobListResultV2	確定
Other Status Codes	ErrorResponse	描述作業失敗原因的自動化錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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/ContoseAutomationAccount/jobs?api-version=2023-11-01

範例回覆

狀態碼:

200

{
  "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
}

定義

名稱	Description
ErrorResponse	作業失敗的錯誤回應
JobCollectionItem	作業集合項目屬性。
JobListResultV2	清單作業的回應模型。
JobStatus	取得或設定作業的狀態。
RunbookAssociationProperty	與實體相關聯的 Runbook 屬性。

ErrorResponse

作業失敗的錯誤回應

名稱	類型	Description
code	string	錯誤碼
message	string	指出作業失敗原因的錯誤訊息。

JobCollectionItem

作業集合項目屬性。

名稱	類型	Description
id	string	資源的完整資源標識碼
name	string	資源的名稱
properties.creationTime	string	工作的建立時間。
properties.endTime	string	工作的結束時間。
properties.jobId	string	作業的標識碼。
properties.lastModifiedTime	string	上次修改工作的時間。
properties.provisioningState	string	資源的布建狀態。
properties.runOn	string	指定執行作業的 runOn 組名。
properties.runbook	RunbookAssociationProperty	Runbook 關聯。
properties.startTime	string	工作的開始時間。
properties.status	JobStatus	工作的狀態。
type	string	資源類型。

JobListResultV2

清單作業的回應模型。

名稱	類型	Description
nextLink	string	下一頁的連結。
value	JobCollectionItem[]	作業清單。

JobStatus

取得或設定作業的狀態。

名稱	類型	Description
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 屬性。

名稱	類型	Description
name	string	取得或設定 Runbook 的名稱。