Job Executions - List By Agent

リファレンス

サービス:: SQL Database

API バージョン:: 2021-11-01

ジョブエージェント内のすべての実行をListsします。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions?api-version=2021-11-01

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
jobAgentName	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	指定した場合、アクティブまたは完了したジョブの実行のみが含まれます。

応答

名前	型	説明
200 OK	JobExecutionListResult	ジョブの実行が正常に取得されました。
Other Status Codes		エラー応答: *** 404 JobAgentNotFound - 指定されたジョブエージェントが、指定された論理サーバーに存在しません。 404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした 404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。

名前

型

説明

200 OK

JobExecutionListResult

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

Other Status Codes

エラー応答: ***

404 JobAgentNotFound - 指定されたジョブエージェントが、指定された論理サーバーに存在しません。
404 SubscriptionDoesNotHaveServer - 要求されたサーバーが見つかりませんでした
404 ServerNotInSubscriptionResourceGroup - 指定されたサーバーが、指定されたリソースグループとサブスクリプションに存在しません。

例

List all job executions in a job agent with filtering.

List all job executions in a job agent.

List all job executions in a job agent with filtering.

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/executions?createTimeMin=2017-03-21T19:00:00Z&createTimeMax=2017-03-21T19:05:00Z&endTimeMin=2017-03-21T19:20:00Z&endTimeMax=2017-03-21T19:25:00Z&isActive=False&api-version=2021-11-01


import java.time.OffsetDateTime;

/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgentWithFilter.
     * json
     */
    /**
     * Sample code: List all job executions in a job agent with filtering.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listAllJobExecutionsInAJobAgentWithFiltering(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1",
            OffsetDateTime.parse("2017-03-21T19:00:00Z"), OffsetDateTime.parse("2017-03-21T19:05:00Z"),
            OffsetDateTime.parse("2017-03-21T19:20:00Z"), OffsetDateTime.parse("2017-03-21T19:25:00Z"), false, null,
            null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "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/job2/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//executions?api-version=2017-03-01-preview&%24skip=2"
}

List all job executions in a job agent.

要求のサンプル

HTTP
Java

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


/**
 * Samples for JobExecutions ListByAgent.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobExecutionsByAgent.json
     */
    /**
     * Sample code: List all job executions in a job agent.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAllJobExecutionsInAJobAgent(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobExecutions().listByAgent("group1", "server1", "agent1", null,
            null, null, null, null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

応答のサンプル

状態コード:: 200

{
  "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/job2/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//executions?api-version=2017-03-01-preview&%24skip=2"
}

定義

名前	説明
JobExecution	ジョブの実行
JobExecutionLifecycle	ジョブ実行の詳細な状態。
JobExecutionListResult	ジョブの実行の一覧。
JobExecutionTarget	ジョブ実行が実行されるターゲット。
JobTargetType	対象の型です。
ProvisioningState	ジョブ実行の ARM プロビジョニング状態。

JobExecution

ジョブの実行

名前	型	説明
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	JobExecutionLifecycle	ジョブ実行の詳細な状態。
properties.provisioningState	ProvisioningState	ジョブ実行の ARM プロビジョニング状態。
properties.startTime	string	ジョブの実行が開始された時刻。
properties.stepId	integer	ジョブステップ ID。
properties.stepName	string	ジョブステップ名。
properties.target	JobExecutionTarget	この実行が実行されるターゲット。
type	string	リソースの種類。

JobExecutionLifecycle

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

名前	型	説明
Canceled	string
Created	string
Failed	string
InProgress	string
Skipped	string
Succeeded	string
SucceededWithSkipped	string
TimedOut	string
WaitingForChildJobExecutions	string
WaitingForRetry	string

JobExecutionListResult

ジョブの実行の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	JobExecution[]	結果の配列。

JobExecutionTarget

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

名前	型	説明
databaseName	string	データベース名。
serverName	string	サーバー名。
type	JobTargetType	対象の型です。

JobTargetType

対象の型です。

名前	型	説明
SqlDatabase	string
SqlElasticPool	string
SqlServer	string
SqlShardMap	string
TargetGroup	string

ProvisioningState

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

名前	型	説明
Canceled	string
Created	string
Failed	string
InProgress	string
Succeeded	string

次の方法で共有

Job Executions - List By Agent

URI パラメーター

応答

例

List all job executions in a job agent with filtering.

要求のサンプル

応答のサンプル

List all job executions in a job agent.

要求のサンプル

応答のサンプル

定義

JobExecution

JobExecutionLifecycle

JobExecutionListResult

JobExecutionTarget

JobTargetType

ProvisioningState

その他のリソース