Job Schedule - Create

參考

服務:: Automation

API 版本:: 2023-11-01

建立作業排程。

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

URI 參數

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

要求本文

名稱	必要	類型	Description
properties.runbook	True	RunbookAssociationProperty	取得或設定 Runbook。
properties.schedule	True	ScheduleAssociationProperty	取得或設定排程。
properties.parameters		object	取得或設定作業屬性的清單。
properties.runOn		string	取得或設定排程工作應該執行的混合式背景工作群組。

回應

名稱	類型	Description
201 Created	JobSchedule	建立時間
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 a job schedule

範例要求

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc?api-version=2023-11-01

{
  "properties": {
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runbook": {
      "name": "TestRunbook"
    },
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

範例回覆

狀態碼:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
  "properties": {
    "jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
    "runbook": {
      "name": "TestRunbook"
    },
    "schedule": {
      "name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
    },
    "runOn": null,
    "parameters": {
      "jobscheduletag01": "jobschedulevalue01",
      "jobscheduletag02": "jobschedulevalue02"
    }
  }
}

定義

名稱	Description
ErrorResponse	作業失敗的錯誤回應
JobSchedule	作業排程的定義。
JobScheduleCreateParameters	提供給建立作業排程作業的參數。
RunbookAssociationProperty	與實體相關聯的 Runbook 屬性。
ScheduleAssociationProperty	與實體相關聯的 schedule 屬性。

ErrorResponse

作業失敗的錯誤回應

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

JobSchedule

作業排程的定義。

名稱	類型	Description
id	string	取得資源的標識碼。
name	string	取得變數的名稱。
properties.jobScheduleId	string	取得或設定作業排程的標識碼。
properties.parameters	object	取得或設定作業排程的參數。
properties.runOn	string	取得或設定排程工作應該執行的混合式背景工作群組。
properties.runbook	RunbookAssociationProperty	取得或設定 Runbook。
properties.schedule	ScheduleAssociationProperty	取得或設定排程。
type	string	資源類型

JobScheduleCreateParameters

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

名稱	類型	Description
properties.parameters	object	取得或設定作業屬性的清單。
properties.runOn	string	取得或設定排程工作應該執行的混合式背景工作群組。
properties.runbook	RunbookAssociationProperty	取得或設定 Runbook。
properties.schedule	ScheduleAssociationProperty	取得或設定排程。

RunbookAssociationProperty

與實體相關聯的 Runbook 屬性。

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

ScheduleAssociationProperty

與實體相關聯的 schedule 屬性。

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

共用方式為