Job Schedule - Create

リファレンス

Service:: Automation

API Version:: 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 パラメーター

名前	/	必須	型	説明
automationAccountName	path	True	string	Automation アカウントの名前。
jobScheduleId	path	True	string uuid	ジョブスケジュール名。
resourceGroupName	path	True	string	Azure リソースグループの名前。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報を取得します。サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
properties.runbook	True	RunbookAssociationProperty	Runbook を取得または設定します。
properties.schedule	True	ScheduleAssociationProperty	スケジュールを取得または設定します。
properties.parameters		object	ジョブのプロパティの一覧を取得または設定します。
properties.runOn		string	スケジュールされたジョブを実行するハイブリッドワーカーグループを取得または設定します。

応答

名前	型	説明
201 Created	JobSchedule	作成済み
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するオートメーションエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

Create a job schedule

Sample Request

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

Sample Response

Status code:: 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"
    }
  }
}

定義

名前	説明
ErrorResponse	操作エラーのエラー応答
JobSchedule	ジョブスケジュールの定義。
JobScheduleCreateParameters	ジョブスケジュールの作成操作に指定されたパラメーター。
RunbookAssociationProperty	エンティティに関連付けられている Runbook プロパティ。
ScheduleAssociationProperty	エンティティに関連付けられている schedule プロパティ。

ErrorResponse

操作エラーのエラー応答

名前	型	説明
code	string	エラーコード
message	string	操作が失敗した理由を示すエラーメッセージ。

JobSchedule

ジョブスケジュールの定義。

名前	型	説明
id	string	リソースの ID を取得します。
name	string	変数の名前を取得します。
properties.jobScheduleId	string	ジョブスケジュールの ID を取得または設定します。
properties.parameters	object	ジョブスケジュールのパラメーターを取得または設定します。
properties.runOn	string	スケジュールされたジョブを実行するハイブリッドワーカーグループを取得または設定します。
properties.runbook	RunbookAssociationProperty	Runbook を取得または設定します。
properties.schedule	ScheduleAssociationProperty	スケジュールを取得または設定します。
type	string	リソースの種類

JobScheduleCreateParameters

ジョブスケジュールの作成操作に指定されたパラメーター。

名前	型	説明
properties.parameters	object	ジョブのプロパティの一覧を取得または設定します。
properties.runOn	string	スケジュールされたジョブを実行するハイブリッドワーカーグループを取得または設定します。
properties.runbook	RunbookAssociationProperty	Runbook を取得または設定します。
properties.schedule	ScheduleAssociationProperty	スケジュールを取得または設定します。

RunbookAssociationProperty

エンティティに関連付けられている Runbook プロパティ。

名前	型	説明
name	string	Runbook の名前を取得または設定します。

ScheduleAssociationProperty

エンティティに関連付けられている schedule プロパティ。

名前	型	説明
name	string	スケジュールの名前を取得または設定します。

Share via