Job Steps - Get By Version

リファレンス

サービス:: SQL Database

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

ジョブステップの指定したバージョンを取得します。

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

URI パラメーター

名前	/	必須	型	説明
jobAgentName	path	True	string	ジョブエージェントの名前。
jobName	path	True	string	ジョブの名前。
jobVersion	path	True	integer int32	取得するジョブのバージョン。
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー API またはポータルから取得できます。
serverName	path	True	string	サーバーの名前。
stepName	path	True	string	ジョブステップの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
api-version	query	True	string	要求で使用する API のバージョン。

応答

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

名前

型

説明

200 OK

JobStep

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

Other Status Codes

エラー応答: ***

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

例

Get the specified version of a job step.

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


/**
 * Samples for JobSteps GetByVersion.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/GetJobStepByVersion.json
     */
    /**
     * Sample code: Get the specified version of a job step.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheSpecifiedVersionOfAJobStep(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getJobSteps().getByVersionWithResponse("group1", "server1",
            "agent1", "job1", 1, "step1", 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

{
  "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/versions/1/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/versions/steps"
}

定義

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

JobStep

ジョブステップ。

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

JobStepAction

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

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

JobStepActionSource

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

名前	型	説明
Inline	string

JobStepActionType

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

名前	型	説明
TSql	string

JobStepExecutionOptions

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

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

JobStepOutput

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

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

JobStepOutputType

出力先の種類。

名前	型	説明
SqlDatabase	string

次の方法で共有

Job Steps - Get By Version

URI パラメーター

応答

例

Get the specified version of a job step.

要求のサンプル

応答のサンプル

定義

JobStep

JobStepAction

JobStepActionSource

JobStepActionType

JobStepExecutionOptions

JobStepOutput

JobStepOutputType

その他のリソース