Job - Create

參考

服務:: Automation

API 版本:: 2023-11-01

建立 Runbook 的作業。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}?api-version=2023-11-01

URI 參數

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

要求標頭

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

要求本文

名稱	類型	Description
properties.parameters	object	取得或設定作業的參數。
properties.runOn	string	取得或設定 runOn，指定要執行作業的組名。
properties.runbook	RunbookAssociationProperty	取得或設定 Runbook。

回應

名稱	類型	Description
201 Created	Job	建立時間
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	模擬您的用戶帳戶

範例

Create job

範例要求

HTTP

PUT https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo?api-version=2023-11-01

{
  "properties": {
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "key01": "value01",
      "key02": "value02"
    },
    "runOn": ""
  }
}

範例回覆

狀態碼:: 201

{
  "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName",
  "name": "foo",
  "type": "Microsoft.Automation/AutomationAccounts/Jobs",
  "properties": {
    "jobId": "5b8a3960-e8ab-45f6-bec6-567df8467d1a",
    "runbook": {
      "name": "TestRunbook"
    },
    "provisioningState": "Processing",
    "creationTime": "2018-02-01T05:53:30.243+00:00",
    "endTime": null,
    "exception": null,
    "lastModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "lastStatusModifiedTime": "2018-02-01T05:53:30.243+00:00",
    "startTime": null,
    "status": "New",
    "statusDetails": "None",
    "parameters": {
      "tag01": "value01",
      "tag02": "value02"
    },
    "runOn": ""
  }
}

定義

名稱	Description
ErrorResponse	作業失敗的錯誤回應
Job	作業的定義。
JobCreateParameters	提供給建立作業作業的參數。
JobProvisioningState	作業目前的布建狀態。
JobStatus	取得或設定作業的狀態。
RunbookAssociationProperty	與實體相關聯的 Runbook 屬性。

ErrorResponse

作業失敗的錯誤回應

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

Job

作業的定義。

名稱	類型	Description
id	string	資源的完整資源標識碼
name	string	資源的名稱
properties.creationTime	string	取得或設定作業的建立時間。
properties.endTime	string	取得或設定作業的結束時間。
properties.exception	string	取得或設定作業的例外狀況。
properties.jobId	string	取得或設定作業的標識碼。
properties.lastModifiedTime	string	取得或設定作業的上次修改時間。
properties.lastStatusModifiedTime	string	取得或設定作業的最後一個狀態修改時間。
properties.parameters	object	取得或設定作業的參數。
properties.provisioningState	JobProvisioningState	作業目前的布建狀態。
properties.runOn	string	取得或設定 runOn，指定要執行作業的組名。
properties.runbook	RunbookAssociationProperty	取得或設定 Runbook。
properties.startTime	string	取得或設定作業的開始時間。
properties.startedBy	string	取得或設定啟動的作業。
properties.status	JobStatus	取得或設定作業的狀態。
properties.statusDetails	string	取得或設定作業的狀態詳細數據。
type	string	資源類型。

JobCreateParameters

提供給建立作業作業的參數。

名稱	類型	Description
properties.parameters	object	取得或設定作業的參數。
properties.runOn	string	取得或設定 runOn，指定要執行作業的組名。
properties.runbook	RunbookAssociationProperty	取得或設定 Runbook。

JobProvisioningState

作業目前的布建狀態。

名稱	類型	Description
Failed	string
Processing	string
Succeeded	string
Suspended	string

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 的名稱。

共用方式為