Microsoft.Sql servers/jobAgents/jobs/steps 2021-08-01-preview
Bicep リソース定義
servers/jobAgents/jobs/steps リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/jobAgents/jobs/steps リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
action: {
source: 'Inline'
type: 'TSql'
value: 'string'
}
credential: 'string'
executionOptions: {
initialRetryIntervalSeconds: int
maximumRetryIntervalSeconds: int
retryAttempts: int
retryIntervalBackoffMultiplier: int
timeoutSeconds: int
}
output: {
credential: 'string'
databaseName: 'string'
resourceGroupName: 'string'
schemaName: 'string'
serverName: 'string'
subscriptionId: 'string'
tableName: 'string'
type: 'SqlDatabase'
}
stepId: int
targetGroup: 'string'
}
}
プロパティ値
servers/jobAgents/jobs/steps
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。 |
種類のリソースのシンボル名: jobs |
| properties | リソースのプロパティ。 | JobStepProperties |
JobStepProperties
| 名前 | 説明 | 値 |
|---|---|---|
| action | ジョブ ステップのアクション ペイロード。 | JobStepAction (必須) |
| 資格情報 (credential) | ターゲットへの接続に使用されるジョブ資格情報のリソース ID。 | string (必須) |
| executionOptions | ジョブ ステップの実行オプション。 | JobStepExecutionOptions |
| output | ジョブ ステップの出力先プロパティ。 | JobStepOutput |
| stepId | ジョブ内のジョブ ステップのインデックス。 ジョブ ステップの作成時に指定しない場合は、最後のステップとして作成されます。 ジョブ ステップの更新時に指定しない場合、ステップ ID は変更されません。 | INT |
| targetGroup | ジョブ ステップが実行されるターゲット グループのリソース ID。 | string (必須) |
JobStepAction
| 名前 | 説明 | 値 |
|---|---|---|
| source | 実行するアクションのソース。 | 'Inline' |
| 型 | ジョブ ステップによって実行されるアクションの種類。 | 'TSql' |
| value | 実行する T-SQL スクリプトのテキストなどのアクション値。 | string (必須) |
JobStepExecutionOptions
| 名前 | 説明 | 値 |
|---|---|---|
| initialRetryIntervalSeconds | ジョブ ステップの実行の再試行間の初期遅延。 | INT |
| maximumRetryIntervalSeconds | ジョブ ステップの実行の再試行の間に待機する最大時間。 | INT |
| retryAttempts | 最初の試行が失敗した場合にジョブ ステップが再試行される最大回数。 | INT |
| retryIntervalBackoffMultiplier | 再試行の間のバックオフ乗数。 | INT |
| timeoutSeconds | ジョブ ステップの実行タイムアウト。 | INT |
JobStepOutput
| 名前 | 説明 | 値 |
|---|---|---|
| 資格情報 (credential) | 出力先への接続に使用する資格情報のリソース ID。 | string (必須) |
| databaseName | 出力先データベース。 | string (必須) |
| resourceGroupName | 出力先のリソース グループ。 | string |
| schemaName | 出力先スキーマ。 | string |
| serverName | 出力先サーバー名。 | string (必須) |
| subscriptionId | 出力先のサブスクリプション ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | 出力先テーブル。 | string (必須) |
| 型 | 出力先の種類。 | 'SqlDatabase' |
ARM テンプレート リソース定義
servers/jobAgents/jobs/steps リソースの種類は、次をターゲットとする操作と共にデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/jobAgents/jobs/steps リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Sql/servers/jobAgents/jobs/steps",
"apiVersion": "2021-08-01-preview",
"name": "string",
"properties": {
"action": {
"source": "Inline",
"type": "TSql",
"value": "string"
},
"credential": "string",
"executionOptions": {
"initialRetryIntervalSeconds": "int",
"maximumRetryIntervalSeconds": "int",
"retryAttempts": "int",
"retryIntervalBackoffMultiplier": "int",
"timeoutSeconds": "int"
},
"output": {
"credential": "string",
"databaseName": "string",
"resourceGroupName": "string",
"schemaName": "string",
"serverName": "string",
"subscriptionId": "string",
"tableName": "string",
"type": "SqlDatabase"
},
"stepId": "int",
"targetGroup": "string"
}
}
プロパティ値
servers/jobAgents/jobs/steps
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Sql/servers/jobAgents/jobs/steps' |
| apiVersion | リソース API のバージョン | '2021-08-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| properties | リソースのプロパティ。 | JobStepProperties |
JobStepProperties
| 名前 | 説明 | 値 |
|---|---|---|
| action | ジョブ ステップのアクション ペイロード。 | JobStepAction (必須) |
| 資格情報 (credential) | ターゲットへの接続に使用されるジョブ資格情報のリソース ID。 | string (必須) |
| executionOptions | ジョブ ステップの実行オプション。 | JobStepExecutionOptions |
| output | ジョブ ステップの出力先プロパティ。 | JobStepOutput |
| stepId | ジョブ内のジョブ ステップのインデックス。 ジョブ ステップの作成時に指定しない場合は、最後のステップとして作成されます。 ジョブ ステップの更新時に指定しない場合、ステップ ID は変更されません。 | INT |
| targetGroup | ジョブ ステップが実行されるターゲット グループのリソース ID。 | string (必須) |
JobStepAction
| 名前 | 説明 | 値 |
|---|---|---|
| source | 実行するアクションのソース。 | 'Inline' |
| 型 | ジョブ ステップによって実行されるアクションの種類。 | 'TSql' |
| value | 実行する T-SQL スクリプトのテキストなどのアクション値。 | string (必須) |
JobStepExecutionOptions
| 名前 | 説明 | 値 |
|---|---|---|
| initialRetryIntervalSeconds | ジョブ ステップの実行の再試行間の初期遅延。 | INT |
| maximumRetryIntervalSeconds | ジョブ ステップの実行の再試行の間に待機する最大時間。 | INT |
| retryAttempts | 最初の試行が失敗した場合にジョブ ステップが再試行される最大回数。 | INT |
| retryIntervalBackoffMultiplier | 再試行間の時間のバックオフ乗数。 | INT |
| timeoutSeconds | ジョブ ステップの実行タイムアウト。 | INT |
JobStepOutput
| 名前 | 説明 | 値 |
|---|---|---|
| 資格情報 (credential) | 出力先への接続に使用する資格情報のリソース ID。 | string (必須) |
| databaseName | 出力先データベース。 | string (必須) |
| resourceGroupName | 出力先のリソース グループ。 | string |
| schemaName | 出力先スキーマ。 | string |
| serverName | 出力先サーバー名。 | string (必須) |
| subscriptionId | 出力先サブスクリプション ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | 出力先テーブル。 | string (必須) |
| 型 | 出力先の種類。 | 'SqlDatabase' |
Terraform (AzAPI プロバイダー) リソース定義
servers/jobAgents/jobs/steps リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Sql/servers/jobAgents/jobs/steps リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
action = {
source = "Inline"
type = "TSql"
value = "string"
}
credential = "string"
executionOptions = {
initialRetryIntervalSeconds = int
maximumRetryIntervalSeconds = int
retryAttempts = int
retryIntervalBackoffMultiplier = int
timeoutSeconds = int
}
output = {
credential = "string"
databaseName = "string"
resourceGroupName = "string"
schemaName = "string"
serverName = "string"
subscriptionId = "string"
tableName = "string"
type = "SqlDatabase"
}
stepId = int
targetGroup = "string"
}
})
}
プロパティ値
servers/jobAgents/jobs/steps
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Sql/servers/jobAgents/jobs/steps@2021-08-01-preview" |
| name | リソース名 | string (必須) |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: jobs |
| properties | リソースのプロパティ。 | JobStepProperties |
JobStepProperties
| 名前 | 説明 | 値 |
|---|---|---|
| action | ジョブ ステップのアクション ペイロード。 | JobStepAction (必須) |
| 資格情報 (credential) | ターゲットへの接続に使用されるジョブ資格情報のリソース ID。 | string (必須) |
| executionOptions | ジョブ ステップの実行オプション。 | JobStepExecutionOptions |
| output | ジョブ ステップの出力先プロパティ。 | JobStepOutput |
| stepId | ジョブ内のジョブ ステップのインデックス。 ジョブ ステップの作成時に指定しない場合は、最後のステップとして作成されます。 ジョブ ステップの更新時に指定しない場合、ステップ ID は変更されません。 | INT |
| targetGroup | ジョブ ステップが実行されるターゲット グループのリソース ID。 | string (必須) |
JobStepAction
| 名前 | 説明 | 値 |
|---|---|---|
| source | 実行するアクションのソース。 | "インライン" |
| 型 | ジョブ ステップによって実行されるアクションの種類。 | "TSql" |
| value | 実行する T-SQL スクリプトのテキストなどのアクション値。 | string (必須) |
JobStepExecutionOptions
| 名前 | 説明 | 値 |
|---|---|---|
| initialRetryIntervalSeconds | ジョブ ステップの実行の再試行間の初期遅延。 | INT |
| maximumRetryIntervalSeconds | ジョブ ステップの実行の再試行の間に待機する最大時間。 | INT |
| retryAttempts | 最初の試行が失敗した場合にジョブ ステップが再試行される最大回数。 | INT |
| retryIntervalBackoffMultiplier | 再試行の間のバックオフ乗数。 | INT |
| timeoutSeconds | ジョブ ステップの実行タイムアウト。 | INT |
JobStepOutput
| 名前 | 説明 | 値 |
|---|---|---|
| 資格情報 (credential) | 出力先への接続に使用する資格情報のリソース ID。 | string (必須) |
| databaseName | 出力先データベース。 | string (必須) |
| resourceGroupName | 出力先のリソース グループ。 | string |
| schemaName | 出力先スキーマ。 | string |
| serverName | 出力先サーバー名。 | string (必須) |
| subscriptionId | 出力先のサブスクリプション ID。 | string 制約: 最小長 = 36 最大長 = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| tableName | 出力先テーブル。 | string (必須) |
| 型 | 出力先の種類。 | "SqlDatabase" |