Job Steps - Get
ジョブの現在のバージョンのジョブ ステップを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}?api-version=2025-01-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
job
|
path | True |
string |
ジョブ エージェントの名前。 |
|
job
|
path | True |
string |
ジョブの名前。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前の大文字と小文字は区別されません。 |
|
server
|
path | True |
string |
サーバーの名前。 |
|
step
|
path | True |
string |
ジョブ ステップの名前。 |
|
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
Azureの運用は無事に完了しました。 |
|
| Other Status Codes |
予期しないエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 Flow.
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
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=2025-01-01
応答のサンプル
{
"name": "step1",
"type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/jobs/job1/steps/step1",
"properties": {
"action": {
"type": "TSql",
"source": "Inline",
"value": "select 2"
},
"credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
"executionOptions": {
"initialRetryIntervalSeconds": 11,
"maximumRetryIntervalSeconds": 222,
"retryAttempts": 42,
"retryIntervalBackoffMultiplier": 3,
"timeoutSeconds": 1234
},
"output": {
"type": "SqlDatabase",
"credential": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
"databaseName": "database3",
"resourceGroupName": "group3",
"schemaName": "myschema1234",
"serverName": "server3",
"subscriptionId": "3501b905-a848-4b5d-96e8-b253f62d735a",
"tableName": "mytable5678"
},
"stepId": 1,
"targetGroup": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"
}
}
定義
| 名前 | 説明 |
|---|---|
|
created |
リソースを作成した ID の種類。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Job |
ジョブ ステップ。 |
|
Job |
ジョブ ステップによって実行されるアクション。 |
|
Job |
実行するアクションのソース。 |
|
Job |
ジョブ ステップによって実行されるアクションの種類。 |
|
Job |
ジョブ ステップの実行オプション。 |
|
Job |
ジョブ ステップの出力構成。 |
|
Job |
出力先の種類。 |
|
system |
リソースの作成と最後の変更に関連するメタデータ。 |
createdByType
リソースを作成した ID の種類。
| 値 | 説明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
JobStep
ジョブ ステップ。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
| name |
string |
リソースの名前 |
| properties.action |
ジョブ ステップのアクション ペイロード。 |
|
| properties.credential |
string |
ターゲットへの接続に使用されるジョブ資格情報のリソース ID。 |
| properties.executionOptions |
ジョブ ステップの実行オプション。 |
|
| properties.output |
ジョブ ステップの出力先プロパティ。 |
|
| properties.stepId |
integer (int32) |
ジョブ内のジョブ ステップのインデックス。 ジョブ ステップの作成時に指定しない場合は、最後のステップとして作成されます。 ジョブ ステップの更新時に指定しない場合、ステップ ID は変更されません。 |
| properties.targetGroup |
string |
ジョブ ステップが実行されるターゲット グループのリソース ID。 |
| systemData |
create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。 |
|
| type |
string |
リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」 |
JobStepAction
ジョブ ステップによって実行されるアクション。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| source | Inline |
実行するアクションのソース。 |
|
| type | TSql |
ジョブ ステップによって実行されるアクションの種類。 |
|
| value |
string |
実行する T-SQL スクリプトのテキストなどのアクション値。 |
JobStepActionSource
実行するアクションのソース。
| 値 | 説明 |
|---|---|
| Inline |
インライン |
JobStepActionType
ジョブ ステップによって実行されるアクションの種類。
| 値 | 説明 |
|---|---|
| TSql |
TSql |
JobStepExecutionOptions
ジョブ ステップの実行オプション。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| initialRetryIntervalSeconds |
integer (int32) |
1 |
ジョブ ステップの実行の再試行間の初期遅延。 |
| maximumRetryIntervalSeconds |
integer (int32) |
120 |
ジョブ ステップの実行の再試行の間に待機する最大時間。 |
| retryAttempts |
integer (int32) |
10 |
最初の試行が失敗した場合にジョブ ステップが再試行される最大回数。 |
| retryIntervalBackoffMultiplier |
number (float) |
2 |
再試行間のバックオフ乗数。 |
| timeoutSeconds |
integer (int32) |
43200 |
ジョブ ステップの実行タイムアウト。 |
JobStepOutput
ジョブ ステップの出力構成。
| 名前 | 型 | 規定値 | 説明 |
|---|---|---|---|
| credential |
string |
出力先への接続に使用する資格情報のリソース ID。 |
|
| databaseName |
string |
出力先データベース。 |
|
| resourceGroupName |
string |
出力先のリソース グループ。 |
|
| schemaName |
string |
dbo |
出力先スキーマ。 |
| serverName |
string |
出力先サーバー名。 |
|
| subscriptionId |
string (uuid) |
出力先のサブスクリプション ID。 |
|
| tableName |
string |
出力先テーブル。 |
|
| type | SqlDatabase |
出力先の種類。 |
JobStepOutputType
出力先の種類。
| 値 | 説明 |
|---|---|
| SqlDatabase |
SqlDatabase |
systemData
リソースの作成と最後の変更に関連するメタデータ。
| 名前 | 型 | 説明 |
|---|---|---|
| createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
| createdBy |
string |
リソースを作成した ID。 |
| createdByType |
リソースを作成した ID の種類。 |
|
| lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
| lastModifiedBy |
string |
リソースを最後に変更した ID。 |
| lastModifiedByType |
リソースを最後に変更した ID の種類。 |