Jobs - List By Agent

  • リファレンス
Service:
SQL Database
API Version:
2021-11-01

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

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs?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 のバージョン。

応答

名前 型 説明
200 OK

JobListResult

ジョブの一覧が正常に取得されました。
Other Status Codes

エラー応答: ***

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

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

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

例

List jobs in a job agent

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1",
      "name": "job1",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "my favourite job",
        "version": 0,
        "schedule": {
          "startTime": "2015-09-24T18:30:01Z",
          "endTime": "2015-09-24T23:59:59Z",
          "type": "Recurring",
          "interval": "PT5M",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job3",
      "name": "job3",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will be scheduled once",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": true
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job2",
      "name": "job2",
      "type": "Microsoft.Sql/servers/jobAccounts/jobs",
      "properties": {
        "description": "this job will never be automatically scheduled",
        "version": 1,
        "schedule": {
          "startTime": "2017-07-01T03:45:00Z",
          "endTime": "2017-12-27T06:00:00Z",
          "type": "Once",
          "enabled": false
        }
      }
    }
  ]
}

定義

名前 説明
Job

ジョブ。
JobListResult

ジョブの一覧。
JobSchedule

ジョブのプロパティのスケジュール設定。
JobScheduleType

スケジュール間隔の種類

Job

ジョブ。

名前 型 説明
id

string

リソースの ID
name

string

リソース名。
properties.description

string

ジョブのユーザー定義の説明。
properties.schedule

JobSchedule

ジョブのプロパティをスケジュールします。
properties.version

integer

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

string

リソースの種類。

JobListResult

ジョブの一覧。

名前 型 説明
nextLink

string

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

Job[]

結果の配列。

JobSchedule

ジョブのプロパティのスケジュール設定。

名前 型 既定値 説明
enabled

boolean

スケジュールが有効かどうか。
endTime

string

9999-12-31T11:59:59+00:00

終了時刻をスケジュールします。
interval

string

ScheduleType が定期的な場合は、スケジュールの定期的な間隔の値。 期間の形式をISO8601します。
startTime

string

0001-01-01T00:00:00+00:00

開始時刻をスケジュールします。
type

JobScheduleType

Once

スケジュール間隔の種類

JobScheduleType

スケジュール間隔の種類

名前 型 説明
Once

string

Recurring

string