Job - Create

リファレンス

Service:: Automation

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

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

要求ヘッダー

名前	必須	型	説明
clientRequestId		string	この特定のクライアント要求を識別します。

要求本文

名前	型	説明
properties.parameters	object	ジョブのパラメーターを取得または設定します。
properties.runOn	string	ジョブを実行するグループ名を指定する runOn を取得または設定します。
properties.runbook	RunbookAssociationProperty	Runbook を取得または設定します。

応答

名前	型	説明
201 Created	Job	作成済み
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 job

Sample Request

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

Sample Response

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

定義

名前	説明
ErrorResponse	操作エラーのエラー応答
Job	ジョブの定義。
JobCreateParameters	ジョブの作成操作に指定されたパラメーター。
JobProvisioningState	ジョブの現在のプロビジョニング状態。
JobStatus	ジョブの状態を取得または設定します。
RunbookAssociationProperty	エンティティに関連付けられている Runbook プロパティ。

ErrorResponse

操作エラーのエラー応答

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

Job

ジョブの定義。

名前	型	説明
id	string	リソースの完全修飾リソース ID
name	string	リソースの名前
properties.creationTime	string	ジョブの作成時間を取得または設定します。
properties.endTime	string	ジョブの終了時刻を取得または設定します。
properties.exception	string	ジョブの例外を取得または設定します。
properties.jobId	string	ジョブの ID を取得または設定します。
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

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

名前	型	説明
properties.parameters	object	ジョブのパラメーターを取得または設定します。
properties.runOn	string	ジョブを実行するグループ名を指定する runOn を取得または設定します。
properties.runbook	RunbookAssociationProperty	Runbook を取得または設定します。

JobProvisioningState

ジョブの現在のプロビジョニング状態。

名前	型	説明
Failed	string
Processing	string
Succeeded	string
Suspended	string

JobStatus

ジョブの状態を取得または設定します。

名前	型	説明
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 プロパティ。

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

Share via