次の方法で共有

Job Steps - Create Or Update

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

ジョブ ステップを作成または更新します。 これにより、新しいジョブ バージョンが暗黙的に作成されます。

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

URI パラメーター

名前 / 必須 型 説明
jobAgentName
 path True

string

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

string

ジョブの名前。
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 のバージョン。

要求本文

名前 必須 型 説明
properties.action True

JobStepAction

ジョブ ステップのアクション ペイロード。
properties.credential True

string

ターゲットへの接続に使用されるジョブ資格情報のリソース ID。
properties.targetGroup True

string

ジョブ ステップが実行されるターゲット グループのリソース ID。
properties.executionOptions

JobStepExecutionOptions

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

JobStepOutput

ジョブ ステップの出力先プロパティ。
properties.stepId

integer

ジョブ内のジョブ ステップのインデックス。 ジョブ ステップの作成時に指定しない場合は、最後のステップとして作成されます。 ジョブ ステップの更新時に指定しない場合、ステップ ID は変更されません。

応答

名前 型 説明
200 OK

JobStep

ジョブ ステップが正常に更新されました。
201 Created

JobStep

ジョブ ステップが正常に追加されました。
Other Status Codes

エラー応答: ***

  • 400 JobStepIdMismatch - 指定したジョブ ステップ URI のステップ ID が、指定されたジョブ ステップ リソースのステップ ID と一致しません。

  • 400 InvalidResourceRequestBody - 要求本文のリソースまたはリソースのプロパティが空または無効です。

  • 400 InvalidResourceId - リソース識別子が無効です。

  • 400 MismatchingSubscriptionWithUrl - 指定されたサブスクリプションが URL 内のサブスクリプションと一致しませんでした。

  • 400 MismatchingResourceGroupNameWithUrl - 指定されたリソース グループ名が URL の名前と一致しませんでした。

  • 400 MismatchingServerNameWithUrl - 指定されたサーバー名が URL の名前と一致しませんでした。

  • 400 MismatchingJobAccountNameWithUrl - 指定されたジョブ アカウント名が URL の名前と一致しませんでした。

  • 400 ElasticJobsOperationFailed - エラスティック ジョブ管理操作に失敗しました。

  • 400 ElasticJobsOperationFailed - エラスティック ジョブ管理操作に失敗しました。

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

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

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

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

例

Create or update a job step with all properties specified.
Create or update a job step with minimal properties specified.

Create or update a job step with all properties specified.

要求のサンプル

PUT 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=2021-11-01

{
  "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
    }
  }
}

応答のサンプル

状態コード:
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"
}
状態コード:
201 
{
  "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"
}

Create or update a job step with minimal properties specified.

要求のサンプル

PUT 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=2021-11-01

{
  "properties": {
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "value": "select 1"
    }
  }
}

応答のサンプル

状態コード:
200 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "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"
}
状態コード:
201 
{
  "properties": {
    "stepId": 1,
    "targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
    "credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
    "action": {
      "type": "TSql",
      "source": "Inline",
      "value": "select 1"
    },
    "executionOptions": {
      "timeoutSeconds": 43200,
      "retryAttempts": 10,
      "initialRetryIntervalSeconds": 1,
      "maximumRetryIntervalSeconds": 120,
      "retryIntervalBackoffMultiplier": 2
    }
  },
  "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"
}

定義

名前 説明
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