次の方法で共有

Job Steps - Get

  • リファレンス
サービス:
SQL Database
API バージョン:
2023-08-01

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

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

URI パラメーター

名前 / 必須 型 説明
jobAgentName
 path True

string

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

string

ジョブの名前。
resourceGroupName
 path True

string

リソースを含むリソース グループの名前。 この値は、Azure Resource Manager 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

ErrorResponse

エラー応答: ***

  • 400 ManagedInstanceStoppingOrStopped - インスタンスが停止/停止状態にある間に送信された操作の競合

  • 400 ManagedInstanceStarting - インスタンスが開始状態の間に送信された操作の競合

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

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

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

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

例

Get the latest 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/steps/step1?api-version=2023-08-01

応答のサンプル

状態コード:
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/steps/step1",
  "name": "step1",
  "type": "Microsoft.Sql/servers/jobAgents/jobs/steps"
}

定義

名前 説明
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答
JobStep

ジョブ ステップ。
JobStepAction

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

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

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

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

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

出力先の種類。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。

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

ジョブ ステップの実行タイムアウト。

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