Job - List By Automation Account

リファレンス

Service:: Automation

API Version:: 2023-11-01

ジョブの一覧を取得します。

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

With optional parameters:

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

URI パラメーター

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

要求ヘッダー

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

応答

名前	型	説明
200 OK	JobListResultV2	OK
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	ユーザーアカウントの借用

例

List jobs by automation account

Sample Request

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

Sample Response

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

定義

名前	説明
ErrorResponse	操作エラーのエラー応答
JobCollectionItem	ジョブコレクション項目のプロパティ。
JobListResultV2	リストジョブ操作の応答モデル。
JobStatus	ジョブの状態を取得または設定します。
RunbookAssociationProperty	エンティティに関連付けられている Runbook プロパティ。

ErrorResponse

操作エラーのエラー応答

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

JobCollectionItem

ジョブコレクション項目のプロパティ。

名前	型	説明
id	string	リソースの完全修飾リソース ID
name	string	リソースの名前
properties.creationTime	string	ジョブの作成時刻。
properties.endTime	string	ジョブの終了時刻。
properties.jobId	string	ジョブの ID。
properties.lastModifiedTime	string	ジョブの最終更新時刻。
properties.provisioningState	string	リソースのプロビジョニング状態。
properties.runOn	string	ジョブが実行された runOn グループ名を指定します。
properties.runbook	RunbookAssociationProperty	Runbook の関連付け。
properties.startTime	string	ジョブの開始時刻。
properties.status	JobStatus	ジョブの状態。
type	string	リソースの型。

JobListResultV2

リストジョブ操作の応答モデル。

名前	型	説明
nextLink	string	次のページへのリンク。
value	JobCollectionItem[]	ジョブの一覧。

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