Job Executions - List By Job

ジョブの実行を一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions?api-version=2021-02-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions?createTimeMin={createTimeMin}&createTimeMax={createTimeMax}&endTimeMin={endTimeMin}&endTimeMax={endTimeMax}&isActive={isActive}&$skip={$skip}&$top={$top}&api-version=2021-02-01-preview

URI パラメーター

Name In Required Type Description
jobAgentName
path True
  • string

ジョブ エージェントの名前。

jobName
path True
  • string

取得するジョブの名前。

resourceGroupName
path True
  • string

リソースが含まれているリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。

serverName
path True
  • string

サーバーの名前。

subscriptionId
path True
  • string

Azure サブスクリプションを識別するサブスクリプション ID。

api-version
query True
  • string

要求で使用する API のバージョン。

$skip
query
  • integer
int64

スキップするコレクション内の要素の数。

$top
query
  • integer
int64

コレクションから返す要素の数。

createTimeMax
query
  • string
date-time

指定した場合は、指定した時刻より前に作成されたジョブ実行のみが含まれます。

createTimeMin
query
  • string
date-time

指定した場合は、指定した時刻以降に作成されたジョブ実行のみが含まれます。

endTimeMax
query
  • string
date-time

指定した場合、指定された時刻より前に完了したジョブの実行のみが含まれます。

endTimeMin
query
  • string
date-time

指定した場合は、指定した時刻以降に完了したジョブの実行のみが含まれます。

isActive
query
  • boolean

指定した場合、アクティブまたは完了したジョブの実行のみが含まれます。

応答

Name Type Description
200 OK

ジョブの実行が正常に取得されました。

Other Status Codes

エラー応答: ***

  • 404 JobAgentNotFound - 指定されたジョブ エージェントが指定された論理サーバーに存在しません。

  • 404 ResourceNotFound - 要求されたリソースが見つかりませんでした。

  • 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした

  • 404 ServerNotInSubscriptionResourceGroup - 指定されたリソース グループとサブスクリプションに指定されたサーバーが存在しません。

List a job's executions.

Sample Request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions?api-version=2021-02-01-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "5A86BF65-43AC-F258-2524-9E92992F97CA",
        "lifecycle": "Created",
        "provisioningState": "Created",
        "createTime": "2017-03-21T19:02:00.8707045Z",
        "startTime": "2017-03-21T19:12:00.8707045Z",
        "endTime": "2017-03-21T19:22:00.8707045Z",
        "currentAttempts": 0,
        "currentAttemptStartTime": "2017-03-21T19:12:00.8707045Z",
        "lastMessage": "Job execution created."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/5555-6666-7777-8888-999999999999",
      "name": "5555-6666-7777-8888-999999999999",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    },
    {
      "properties": {
        "jobVersion": 1,
        "jobExecutionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "lifecycle": "Succeeded",
        "provisioningState": "Succeeded",
        "createTime": "2017-12-15T19:02:00.8707045Z",
        "startTime": "2017-12-15T19:12:00.8707045Z",
        "endTime": "2017-12-15T19:22:00.8707045Z",
        "currentAttempts": 1,
        "lastMessage": "Job execution succeeded."
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/executions"
    }
  ],
  "nextLink": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/executions?api-version=2017-03-01-preview&%24skip=2"
}

定義

JobExecution

ジョブの実行

JobExecutionLifecycle

ジョブ実行の詳細な状態。

JobExecutionListResult

ジョブの実行の一覧。

JobExecutionTarget

ジョブ実行が実行されるターゲット。

JobTargetType

対象の型です。

ProvisioningState

ジョブ実行の ARM プロビジョニング状態。

JobExecution

ジョブの実行

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.createTime
  • string

ジョブの実行が作成された時刻。

properties.currentAttemptStartTime
  • string

現在の試行の開始時刻。

properties.currentAttempts
  • integer

ジョブの実行が試行された回数。

properties.endTime
  • string

ジョブの実行が完了した時刻。

properties.jobExecutionId
  • string

ジョブ実行の一意識別子。

properties.jobVersion
  • integer

ジョブのバージョン番号。

properties.lastMessage
  • string

最後の状態またはエラー メッセージ。

properties.lifecycle

ジョブ実行の詳細な状態。

properties.provisioningState

ジョブ実行の ARM プロビジョニング状態。

properties.startTime
  • string

ジョブの実行が開始された時刻。

properties.stepId
  • integer

ジョブ ステップ ID。

properties.stepName
  • string

ジョブ ステップ名。

properties.target

この実行が実行されるターゲット。

type
  • string

リソースの種類。

JobExecutionLifecycle

ジョブ実行の詳細な状態。

Name Type Description
Canceled
  • string
Created
  • string
Failed
  • string
InProgress
  • string
Skipped
  • string
Succeeded
  • string
SucceededWithSkipped
  • string
TimedOut
  • string
WaitingForChildJobExecutions
  • string
WaitingForRetry
  • string

JobExecutionListResult

ジョブの実行の一覧。

Name Type Description
nextLink
  • string

結果の次のページを取得するためのリンク。

value

結果の配列。

JobExecutionTarget

ジョブ実行が実行されるターゲット。

Name Type Description
databaseName
  • string

データベース名。

serverName
  • string

サーバー名。

type

対象の型です。

JobTargetType

対象の型です。

Name Type Description
SqlDatabase
  • string
SqlElasticPool
  • string
SqlServer
  • string
SqlShardMap
  • string
TargetGroup
  • string

ProvisioningState

ジョブ実行の ARM プロビジョニング状態。

Name Type Description
Canceled
  • string
Created
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string