Job Steps - List By Job

リファレンス

サービス:: SQL Database

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

ジョブの現在のバージョンのすべてのジョブステップを取得します。

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

URI パラメーター

名前	/	必須	型	説明
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 のバージョン。

応答

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

名前

型

説明

200 OK

JobStepListResult

ジョブステップの一覧が正常に取得されました。

Other Status Codes

エラー応答: ***

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

例

List job steps for the latest version of a job.

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


/**
 * Samples for JobSteps ListByJob.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ListJobStepsByJob.json
     */
    /**
     * Sample code: List job steps for the latest version of a job.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listJobStepsForTheLatestVersionOfAJob(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().listByJob("group1", "server1", "agent1", "job1",
            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": {
        "stepId": 1,
        "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
        "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
        "action": {
          "type": "TSql",
          "source": "Inline",
          "value": "select 2"
        },
        "output": {
          "type": "SqlDatabase",
          "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
          "resourceGroupName": "group3",
          "serverName": "server3",
          "databaseName": "database3",
          "schemaName": "myschema1234",
          "tableName": "mytable5678",
          "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
        },
        "executionOptions": {
          "timeoutSeconds": 1234,
          "retryAttempts": 42,
          "initialRetryIntervalSeconds": 11,
          "maximumRetryIntervalSeconds": 222,
          "retryIntervalBackoffMultiplier": 3
        }
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
      "name": "step1",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
    },
    {
      "properties": {
        "stepId": 2,
        "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
        "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
        "action": {
          "type": "TSql",
          "source": "Inline",
          "value": "select 2"
        },
        "output": {
          "type": "SqlDatabase",
          "subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
          "resourceGroupName": "group3",
          "serverName": "server3",
          "databaseName": "database3",
          "schemaName": "myschema1234",
          "tableName": "mytable5678",
          "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"
        },
        "executionOptions": {
          "timeoutSeconds": 1234,
          "retryAttempts": 42,
          "initialRetryIntervalSeconds": 11,
          "maximumRetryIntervalSeconds": 222,
          "retryIntervalBackoffMultiplier": 3
        }
      },
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step2",
      "name": "step2",
      "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
    }
  ]
}

定義

名前	説明
JobStep	ジョブステップ。
JobStepAction	ジョブステップによって実行されるアクション。
JobStepActionSource	実行するアクションのソース。
JobStepActionType	ジョブステップによって実行されるアクションの種類。
JobStepExecutionOptions	ジョブステップの実行オプション。
JobStepListResult	ジョブステップの一覧。
JobStepOutput	ジョブステップの出力構成。
JobStepOutputType	出力先の種類。

JobStep

Object

ジョブステップ。

名前	型	説明
id	string	リソースの ID
name	string	リソース名。
properties.action	JobStepAction	ジョブステップのアクションペイロード。
properties.credential	string	ターゲットへの接続に使用されるジョブ資格情報のリソース ID。
properties.executionOptions	JobStepExecutionOptions	ジョブステップの実行オプション。
properties.output	JobStepOutput	ジョブステップの出力先プロパティ。
properties.stepId	integer (int32)	ジョブ内のジョブステップのインデックス。ジョブステップの作成時に指定しない場合は、最後のステップとして作成されます。ジョブステップの更新時に指定しない場合、ステップ ID は変更されません。
properties.targetGroup	string	ジョブステップが実行されるターゲットグループのリソース ID。
type	string	リソースの種類。

JobStepAction

Object

ジョブステップによって実行されるアクション。

名前	型	規定値	説明
source	JobStepActionSource	Inline	実行するアクションのソース。
type	JobStepActionType	TSql	ジョブステップによって実行されるアクションの種類。
value	string		実行する T-SQL スクリプトのテキストなどのアクション値。

JobStepActionSource

列挙

実行するアクションのソース。

値	説明
Inline

JobStepActionType

列挙

ジョブステップによって実行されるアクションの種類。

値	説明
TSql

JobStepExecutionOptions

Object

ジョブステップの実行オプション。

名前	型	規定値	説明
initialRetryIntervalSeconds	integer (int32)	1	ジョブステップの実行の再試行間の初期遅延。
maximumRetryIntervalSeconds	integer (int32)	120	ジョブステップの実行の再試行の間に待機する最大時間。
retryAttempts	integer (int32)	10	最初の試行が失敗した場合にジョブステップが再試行される最大回数。
retryIntervalBackoffMultiplier	number (float)	2	再試行の間のバックオフ乗数。
timeoutSeconds	integer (int32)	43200	ジョブステップの実行タイムアウト。

JobStepListResult

Object

ジョブステップの一覧。

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

JobStepOutput

Object

ジョブステップの出力構成。

名前	型	規定値	説明
credential	string		出力先への接続に使用する資格情報のリソース ID。
databaseName	string		出力先データベース。
resourceGroupName	string		出力先のリソースグループ。
schemaName	string	dbo	出力先スキーマ。
serverName	string		出力先サーバー名。
subscriptionId	string (uuid)		出力先のサブスクリプション ID。
tableName	string		出力先テーブル。
type	JobStepOutputType	SqlDatabase	出力先の種類。

JobStepOutputType

列挙

出力先の種類。

値	説明
SqlDatabase

次の方法で共有

Job Steps - List By Job

URI パラメーター

応答

例

List job steps for the latest version of a job.

要求のサンプル

応答のサンプル

定義

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepListResult

JobStepOutput

JobStepOutputType

その他のリソース