azure-native.sql.JobStep
Explore with Pulumi AI
A job step. Azure REST API version: 2021-11-01. Prior API version in Azure Native 1.x: 2020-11-01-preview.
Other available API versions: 2022-11-01-preview, 2023-02-01-preview, 2023-05-01-preview, 2023-08-01-preview.
Example Usage
Create or update a job step with all properties specified.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var jobStep = new AzureNative.Sql.JobStep("jobStep", new()
{
Action = new AzureNative.Sql.Inputs.JobStepActionArgs
{
Source = AzureNative.Sql.JobStepActionSource.Inline,
Type = AzureNative.Sql.JobStepActionType.TSql,
Value = "select 2",
},
Credential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
ExecutionOptions = new AzureNative.Sql.Inputs.JobStepExecutionOptionsArgs
{
InitialRetryIntervalSeconds = 11,
MaximumRetryIntervalSeconds = 222,
RetryAttempts = 42,
RetryIntervalBackoffMultiplier = 3,
TimeoutSeconds = 1234,
},
JobAgentName = "agent1",
JobName = "job1",
Output = new AzureNative.Sql.Inputs.JobStepOutputArgs
{
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",
Type = AzureNative.Sql.JobStepOutputType.SqlDatabase,
},
ResourceGroupName = "group1",
ServerName = "server1",
StepId = 1,
StepName = "step1",
TargetGroup = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
});
});
package main
import (
sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sql.NewJobStep(ctx, "jobStep", &sql.JobStepArgs{
Action: &sql.JobStepActionArgs{
Source: pulumi.String(sql.JobStepActionSourceInline),
Type: pulumi.String(sql.JobStepActionTypeTSql),
Value: pulumi.String("select 2"),
},
Credential: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1"),
ExecutionOptions: &sql.JobStepExecutionOptionsArgs{
InitialRetryIntervalSeconds: pulumi.Int(11),
MaximumRetryIntervalSeconds: pulumi.Int(222),
RetryAttempts: pulumi.Int(42),
RetryIntervalBackoffMultiplier: pulumi.Float64(3),
TimeoutSeconds: pulumi.Int(1234),
},
JobAgentName: pulumi.String("agent1"),
JobName: pulumi.String("job1"),
Output: &sql.JobStepOutputTypeArgs{
Credential: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"),
DatabaseName: pulumi.String("database3"),
ResourceGroupName: pulumi.String("group3"),
SchemaName: pulumi.String("myschema1234"),
ServerName: pulumi.String("server3"),
SubscriptionId: pulumi.String("3501b905-a848-4b5d-96e8-b253f62d735a"),
TableName: pulumi.String("mytable5678"),
Type: pulumi.String(sql.JobStepOutputTypeSqlDatabase),
},
ResourceGroupName: pulumi.String("group1"),
ServerName: pulumi.String("server1"),
StepId: pulumi.Int(1),
StepName: pulumi.String("step1"),
TargetGroup: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.JobStep;
import com.pulumi.azurenative.sql.JobStepArgs;
import com.pulumi.azurenative.sql.inputs.JobStepActionArgs;
import com.pulumi.azurenative.sql.inputs.JobStepExecutionOptionsArgs;
import com.pulumi.azurenative.sql.inputs.JobStepOutputArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var jobStep = new JobStep("jobStep", JobStepArgs.builder()
.action(JobStepActionArgs.builder()
.source("Inline")
.type("TSql")
.value("select 2")
.build())
.credential("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1")
.executionOptions(JobStepExecutionOptionsArgs.builder()
.initialRetryIntervalSeconds(11)
.maximumRetryIntervalSeconds(222)
.retryAttempts(42)
.retryIntervalBackoffMultiplier(3)
.timeoutSeconds(1234)
.build())
.jobAgentName("agent1")
.jobName("job1")
.output(JobStepOutputArgs.builder()
.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")
.type("SqlDatabase")
.build())
.resourceGroupName("group1")
.serverName("server1")
.stepId(1)
.stepName("step1")
.targetGroup("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
job_step = azure_native.sql.JobStep("jobStep",
action=azure_native.sql.JobStepActionArgs(
source=azure_native.sql.JobStepActionSource.INLINE,
type=azure_native.sql.JobStepActionType.T_SQL,
value="select 2",
),
credential="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred1",
execution_options=azure_native.sql.JobStepExecutionOptionsArgs(
initial_retry_interval_seconds=11,
maximum_retry_interval_seconds=222,
retry_attempts=42,
retry_interval_backoff_multiplier=3,
timeout_seconds=1234,
),
job_agent_name="agent1",
job_name="job1",
output=azure_native.sql.JobStepOutputArgs(
credential="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
database_name="database3",
resource_group_name="group3",
schema_name="myschema1234",
server_name="server3",
subscription_id="3501b905-a848-4b5d-96e8-b253f62d735a",
table_name="mytable5678",
type=azure_native.sql.JobStepOutputType.SQL_DATABASE,
),
resource_group_name="group1",
server_name="server1",
step_id=1,
step_name="step1",
target_group="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const jobStep = new azure_native.sql.JobStep("jobStep", {
action: {
source: azure_native.sql.JobStepActionSource.Inline,
type: azure_native.sql.JobStepActionType.TSql,
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,
},
jobAgentName: "agent1",
jobName: "job1",
output: {
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",
type: azure_native.sql.JobStepOutputType.SqlDatabase,
},
resourceGroupName: "group1",
serverName: "server1",
stepId: 1,
stepName: "step1",
targetGroup: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1",
});
resources:
jobStep:
type: azure-native:sql:JobStep
properties:
action:
source: Inline
type: TSql
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
jobAgentName: agent1
jobName: job1
output:
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
type: SqlDatabase
resourceGroupName: group1
serverName: server1
stepId: 1
stepName: step1
targetGroup: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup1
Create or update a job step with minimal properties specified.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var jobStep = new AzureNative.Sql.JobStep("jobStep", new()
{
Action = new AzureNative.Sql.Inputs.JobStepActionArgs
{
Value = "select 1",
},
Credential = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
JobAgentName = "agent1",
JobName = "job1",
ResourceGroupName = "group1",
ServerName = "server1",
StepName = "step1",
TargetGroup = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
});
});
package main
import (
sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sql.NewJobStep(ctx, "jobStep", &sql.JobStepArgs{
Action: &sql.JobStepActionArgs{
Value: pulumi.String("select 1"),
},
Credential: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0"),
JobAgentName: pulumi.String("agent1"),
JobName: pulumi.String("job1"),
ResourceGroupName: pulumi.String("group1"),
ServerName: pulumi.String("server1"),
StepName: pulumi.String("step1"),
TargetGroup: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.sql.JobStep;
import com.pulumi.azurenative.sql.JobStepArgs;
import com.pulumi.azurenative.sql.inputs.JobStepActionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var jobStep = new JobStep("jobStep", JobStepArgs.builder()
.action(JobStepActionArgs.builder()
.value("select 1")
.build())
.credential("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0")
.jobAgentName("agent1")
.jobName("job1")
.resourceGroupName("group1")
.serverName("server1")
.stepName("step1")
.targetGroup("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
job_step = azure_native.sql.JobStep("jobStep",
action=azure_native.sql.JobStepActionArgs(
value="select 1",
),
credential="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
job_agent_name="agent1",
job_name="job1",
resource_group_name="group1",
server_name="server1",
step_name="step1",
target_group="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const jobStep = new azure_native.sql.JobStep("jobStep", {
action: {
value: "select 1",
},
credential: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0",
jobAgentName: "agent1",
jobName: "job1",
resourceGroupName: "group1",
serverName: "server1",
stepName: "step1",
targetGroup: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0",
});
resources:
jobStep:
type: azure-native:sql:JobStep
properties:
action:
value: select 1
credential: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/credentials/cred0
jobAgentName: agent1
jobName: job1
resourceGroupName: group1
serverName: server1
stepName: step1
targetGroup: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/server1/jobAgents/agent1/targetGroups/targetGroup0
Create JobStep Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new JobStep(name: string, args: JobStepArgs, opts?: CustomResourceOptions);
@overload
def JobStep(resource_name: str,
args: JobStepArgs,
opts: Optional[ResourceOptions] = None)
@overload
def JobStep(resource_name: str,
opts: Optional[ResourceOptions] = None,
action: Optional[JobStepActionArgs] = None,
credential: Optional[str] = None,
job_agent_name: Optional[str] = None,
job_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
server_name: Optional[str] = None,
target_group: Optional[str] = None,
execution_options: Optional[JobStepExecutionOptionsArgs] = None,
output: Optional[JobStepOutputArgs] = None,
step_id: Optional[int] = None,
step_name: Optional[str] = None)
func NewJobStep(ctx *Context, name string, args JobStepArgs, opts ...ResourceOption) (*JobStep, error)
public JobStep(string name, JobStepArgs args, CustomResourceOptions? opts = null)
public JobStep(String name, JobStepArgs args)
public JobStep(String name, JobStepArgs args, CustomResourceOptions options)
type: azure-native:sql:JobStep
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args JobStepArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args JobStepArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args JobStepArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobStepArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobStepArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var jobStepResource = new AzureNative.Sql.JobStep("jobStepResource", new()
{
Action = new AzureNative.Sql.Inputs.JobStepActionArgs
{
Value = "string",
Source = "string",
Type = "string",
},
Credential = "string",
JobAgentName = "string",
JobName = "string",
ResourceGroupName = "string",
ServerName = "string",
TargetGroup = "string",
ExecutionOptions = new AzureNative.Sql.Inputs.JobStepExecutionOptionsArgs
{
InitialRetryIntervalSeconds = 0,
MaximumRetryIntervalSeconds = 0,
RetryAttempts = 0,
RetryIntervalBackoffMultiplier = 0,
TimeoutSeconds = 0,
},
Output = new AzureNative.Sql.Inputs.JobStepOutputArgs
{
Credential = "string",
DatabaseName = "string",
ServerName = "string",
TableName = "string",
ResourceGroupName = "string",
SchemaName = "string",
SubscriptionId = "string",
Type = "string",
},
StepId = 0,
StepName = "string",
});
example, err := sql.NewJobStep(ctx, "jobStepResource", &sql.JobStepArgs{
Action: &sql.JobStepActionArgs{
Value: pulumi.String("string"),
Source: pulumi.String("string"),
Type: pulumi.String("string"),
},
Credential: pulumi.String("string"),
JobAgentName: pulumi.String("string"),
JobName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServerName: pulumi.String("string"),
TargetGroup: pulumi.String("string"),
ExecutionOptions: &sql.JobStepExecutionOptionsArgs{
InitialRetryIntervalSeconds: pulumi.Int(0),
MaximumRetryIntervalSeconds: pulumi.Int(0),
RetryAttempts: pulumi.Int(0),
RetryIntervalBackoffMultiplier: pulumi.Float64(0),
TimeoutSeconds: pulumi.Int(0),
},
Output: &sql.JobStepOutputTypeArgs{
Credential: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
ServerName: pulumi.String("string"),
TableName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
SchemaName: pulumi.String("string"),
SubscriptionId: pulumi.String("string"),
Type: pulumi.String("string"),
},
StepId: pulumi.Int(0),
StepName: pulumi.String("string"),
})
var jobStepResource = new JobStep("jobStepResource", JobStepArgs.builder()
.action(JobStepActionArgs.builder()
.value("string")
.source("string")
.type("string")
.build())
.credential("string")
.jobAgentName("string")
.jobName("string")
.resourceGroupName("string")
.serverName("string")
.targetGroup("string")
.executionOptions(JobStepExecutionOptionsArgs.builder()
.initialRetryIntervalSeconds(0)
.maximumRetryIntervalSeconds(0)
.retryAttempts(0)
.retryIntervalBackoffMultiplier(0)
.timeoutSeconds(0)
.build())
.output(JobStepOutputArgs.builder()
.credential("string")
.databaseName("string")
.serverName("string")
.tableName("string")
.resourceGroupName("string")
.schemaName("string")
.subscriptionId("string")
.type("string")
.build())
.stepId(0)
.stepName("string")
.build());
job_step_resource = azure_native.sql.JobStep("jobStepResource",
action=azure_native.sql.JobStepActionArgs(
value="string",
source="string",
type="string",
),
credential="string",
job_agent_name="string",
job_name="string",
resource_group_name="string",
server_name="string",
target_group="string",
execution_options=azure_native.sql.JobStepExecutionOptionsArgs(
initial_retry_interval_seconds=0,
maximum_retry_interval_seconds=0,
retry_attempts=0,
retry_interval_backoff_multiplier=0,
timeout_seconds=0,
),
output=azure_native.sql.JobStepOutputArgs(
credential="string",
database_name="string",
server_name="string",
table_name="string",
resource_group_name="string",
schema_name="string",
subscription_id="string",
type="string",
),
step_id=0,
step_name="string")
const jobStepResource = new azure_native.sql.JobStep("jobStepResource", {
action: {
value: "string",
source: "string",
type: "string",
},
credential: "string",
jobAgentName: "string",
jobName: "string",
resourceGroupName: "string",
serverName: "string",
targetGroup: "string",
executionOptions: {
initialRetryIntervalSeconds: 0,
maximumRetryIntervalSeconds: 0,
retryAttempts: 0,
retryIntervalBackoffMultiplier: 0,
timeoutSeconds: 0,
},
output: {
credential: "string",
databaseName: "string",
serverName: "string",
tableName: "string",
resourceGroupName: "string",
schemaName: "string",
subscriptionId: "string",
type: "string",
},
stepId: 0,
stepName: "string",
});
type: azure-native:sql:JobStep
properties:
action:
source: string
type: string
value: string
credential: string
executionOptions:
initialRetryIntervalSeconds: 0
maximumRetryIntervalSeconds: 0
retryAttempts: 0
retryIntervalBackoffMultiplier: 0
timeoutSeconds: 0
jobAgentName: string
jobName: string
output:
credential: string
databaseName: string
resourceGroupName: string
schemaName: string
serverName: string
subscriptionId: string
tableName: string
type: string
resourceGroupName: string
serverName: string
stepId: 0
stepName: string
targetGroup: string
JobStep Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The JobStep resource accepts the following input properties:
- Action
Pulumi.
Azure Native. Sql. Inputs. Job Step Action - The action payload of the job step.
- Credential string
- The resource ID of the job credential that will be used to connect to the targets.
- Job
Agent stringName - The name of the job agent.
- Job
Name string - The name of the job.
- Resource
Group stringName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Server
Name string - The name of the server.
- Target
Group string - The resource ID of the target group that the job step will be executed on.
- Execution
Options Pulumi.Azure Native. Sql. Inputs. Job Step Execution Options - Execution options for the job step.
- Output
Pulumi.
Azure Native. Sql. Inputs. Job Step Output - Output destination properties of the job step.
- Step
Id int - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- Step
Name string - The name of the job step.
- Action
Job
Step Action Args - The action payload of the job step.
- Credential string
- The resource ID of the job credential that will be used to connect to the targets.
- Job
Agent stringName - The name of the job agent.
- Job
Name string - The name of the job.
- Resource
Group stringName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- Server
Name string - The name of the server.
- Target
Group string - The resource ID of the target group that the job step will be executed on.
- Execution
Options JobStep Execution Options Args - Execution options for the job step.
- Output
Job
Step Output Type Args - Output destination properties of the job step.
- Step
Id int - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- Step
Name string - The name of the job step.
- action
Job
Step Action - The action payload of the job step.
- credential String
- The resource ID of the job credential that will be used to connect to the targets.
- job
Agent StringName - The name of the job agent.
- job
Name String - The name of the job.
- resource
Group StringName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Name String - The name of the server.
- target
Group String - The resource ID of the target group that the job step will be executed on.
- execution
Options JobStep Execution Options - Execution options for the job step.
- output
Job
Step Output - Output destination properties of the job step.
- step
Id Integer - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- step
Name String - The name of the job step.
- action
Job
Step Action - The action payload of the job step.
- credential string
- The resource ID of the job credential that will be used to connect to the targets.
- job
Agent stringName - The name of the job agent.
- job
Name string - The name of the job.
- resource
Group stringName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Name string - The name of the server.
- target
Group string - The resource ID of the target group that the job step will be executed on.
- execution
Options JobStep Execution Options - Execution options for the job step.
- output
Job
Step Output - Output destination properties of the job step.
- step
Id number - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- step
Name string - The name of the job step.
- action
Job
Step Action Args - The action payload of the job step.
- credential str
- The resource ID of the job credential that will be used to connect to the targets.
- job_
agent_ strname - The name of the job agent.
- job_
name str - The name of the job.
- resource_
group_ strname - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server_
name str - The name of the server.
- target_
group str - The resource ID of the target group that the job step will be executed on.
- execution_
options JobStep Execution Options Args - Execution options for the job step.
- output
Job
Step Output Args - Output destination properties of the job step.
- step_
id int - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- step_
name str - The name of the job step.
- action Property Map
- The action payload of the job step.
- credential String
- The resource ID of the job credential that will be used to connect to the targets.
- job
Agent StringName - The name of the job agent.
- job
Name String - The name of the job.
- resource
Group StringName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- server
Name String - The name of the server.
- target
Group String - The resource ID of the target group that the job step will be executed on.
- execution
Options Property Map - Execution options for the job step.
- output Property Map
- Output destination properties of the job step.
- step
Id Number - The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.
- step
Name String - The name of the job step.
Outputs
All input properties are implicitly available as output properties. Additionally, the JobStep resource produces the following output properties:
Supporting Types
JobStepAction, JobStepActionArgs
- Value string
- The action value, for example the text of the T-SQL script to execute.
- Source
string | Pulumi.
Azure Native. Sql. Job Step Action Source - The source of the action to execute.
- Type
string | Pulumi.
Azure Native. Sql. Job Step Action Type - Type of action being executed by the job step.
- Value string
- The action value, for example the text of the T-SQL script to execute.
- Source
string | Job
Step Action Source - The source of the action to execute.
- Type
string | Job
Step Action Type - Type of action being executed by the job step.
- value String
- The action value, for example the text of the T-SQL script to execute.
- source
String | Job
Step Action Source - The source of the action to execute.
- type
String | Job
Step Action Type - Type of action being executed by the job step.
- value string
- The action value, for example the text of the T-SQL script to execute.
- source
string | Job
Step Action Source - The source of the action to execute.
- type
string | Job
Step Action Type - Type of action being executed by the job step.
- value str
- The action value, for example the text of the T-SQL script to execute.
- source
str | Job
Step Action Source - The source of the action to execute.
- type
str | Job
Step Action Type - Type of action being executed by the job step.
JobStepActionResponse, JobStepActionResponseArgs
JobStepActionSource, JobStepActionSourceArgs
- Inline
- Inline
- Job
Step Action Source Inline - Inline
- Inline
- Inline
- Inline
- Inline
- INLINE
- Inline
- "Inline"
- Inline
JobStepActionType, JobStepActionTypeArgs
- TSql
- TSql
- Job
Step Action Type TSql - TSql
- TSql
- TSql
- TSql
- TSql
- T_SQL
- TSql
- "TSql"
- TSql
JobStepExecutionOptions, JobStepExecutionOptionsArgs
- Initial
Retry intInterval Seconds - Initial delay between retries for job step execution.
- Maximum
Retry intInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- Retry
Attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- Retry
Interval doubleBackoff Multiplier - The backoff multiplier for the time between retries.
- Timeout
Seconds int - Execution timeout for the job step.
- Initial
Retry intInterval Seconds - Initial delay between retries for job step execution.
- Maximum
Retry intInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- Retry
Attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- Retry
Interval float64Backoff Multiplier - The backoff multiplier for the time between retries.
- Timeout
Seconds int - Execution timeout for the job step.
- initial
Retry IntegerInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry IntegerInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts Integer - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval DoubleBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds Integer - Execution timeout for the job step.
- initial
Retry numberInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry numberInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts number - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval numberBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds number - Execution timeout for the job step.
- initial_
retry_ intinterval_ seconds - Initial delay between retries for job step execution.
- maximum_
retry_ intinterval_ seconds - The maximum amount of time to wait between retries for job step execution.
- retry_
attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry_
interval_ floatbackoff_ multiplier - The backoff multiplier for the time between retries.
- timeout_
seconds int - Execution timeout for the job step.
- initial
Retry NumberInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry NumberInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts Number - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval NumberBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds Number - Execution timeout for the job step.
JobStepExecutionOptionsResponse, JobStepExecutionOptionsResponseArgs
- Initial
Retry intInterval Seconds - Initial delay between retries for job step execution.
- Maximum
Retry intInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- Retry
Attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- Retry
Interval doubleBackoff Multiplier - The backoff multiplier for the time between retries.
- Timeout
Seconds int - Execution timeout for the job step.
- Initial
Retry intInterval Seconds - Initial delay between retries for job step execution.
- Maximum
Retry intInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- Retry
Attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- Retry
Interval float64Backoff Multiplier - The backoff multiplier for the time between retries.
- Timeout
Seconds int - Execution timeout for the job step.
- initial
Retry IntegerInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry IntegerInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts Integer - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval DoubleBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds Integer - Execution timeout for the job step.
- initial
Retry numberInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry numberInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts number - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval numberBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds number - Execution timeout for the job step.
- initial_
retry_ intinterval_ seconds - Initial delay between retries for job step execution.
- maximum_
retry_ intinterval_ seconds - The maximum amount of time to wait between retries for job step execution.
- retry_
attempts int - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry_
interval_ floatbackoff_ multiplier - The backoff multiplier for the time between retries.
- timeout_
seconds int - Execution timeout for the job step.
- initial
Retry NumberInterval Seconds - Initial delay between retries for job step execution.
- maximum
Retry NumberInterval Seconds - The maximum amount of time to wait between retries for job step execution.
- retry
Attempts Number - Maximum number of times the job step will be reattempted if the first attempt fails.
- retry
Interval NumberBackoff Multiplier - The backoff multiplier for the time between retries.
- timeout
Seconds Number - Execution timeout for the job step.
JobStepOutput, JobStepOutputArgs
- Credential string
- The resource ID of the credential to use to connect to the output destination.
- Database
Name string - The output destination database.
- Server
Name string - The output destination server name.
- Table
Name string - The output destination table.
- Resource
Group stringName - The output destination resource group.
- Schema
Name string - The output destination schema.
- Subscription
Id string - The output destination subscription id.
- Type
string | Pulumi.
Azure Native. Sql. Job Step Output Type - The output destination type.
- Credential string
- The resource ID of the credential to use to connect to the output destination.
- Database
Name string - The output destination database.
- Server
Name string - The output destination server name.
- Table
Name string - The output destination table.
- Resource
Group stringName - The output destination resource group.
- Schema
Name string - The output destination schema.
- Subscription
Id string - The output destination subscription id.
- Type
string | Job
Step Output Type Enum - The output destination type.
- credential String
- The resource ID of the credential to use to connect to the output destination.
- database
Name String - The output destination database.
- server
Name String - The output destination server name.
- table
Name String - The output destination table.
- resource
Group StringName - The output destination resource group.
- schema
Name String - The output destination schema.
- subscription
Id String - The output destination subscription id.
- type
String | Job
Step Output Type - The output destination type.
- credential string
- The resource ID of the credential to use to connect to the output destination.
- database
Name string - The output destination database.
- server
Name string - The output destination server name.
- table
Name string - The output destination table.
- resource
Group stringName - The output destination resource group.
- schema
Name string - The output destination schema.
- subscription
Id string - The output destination subscription id.
- type
string | Job
Step Output Type - The output destination type.
- credential str
- The resource ID of the credential to use to connect to the output destination.
- database_
name str - The output destination database.
- server_
name str - The output destination server name.
- table_
name str - The output destination table.
- resource_
group_ strname - The output destination resource group.
- schema_
name str - The output destination schema.
- subscription_
id str - The output destination subscription id.
- type
str | Job
Step Output Type - The output destination type.
- credential String
- The resource ID of the credential to use to connect to the output destination.
- database
Name String - The output destination database.
- server
Name String - The output destination server name.
- table
Name String - The output destination table.
- resource
Group StringName - The output destination resource group.
- schema
Name String - The output destination schema.
- subscription
Id String - The output destination subscription id.
- type
String | "Sql
Database" - The output destination type.
JobStepOutputResponse, JobStepOutputResponseArgs
- Credential string
- The resource ID of the credential to use to connect to the output destination.
- Database
Name string - The output destination database.
- Server
Name string - The output destination server name.
- Table
Name string - The output destination table.
- Resource
Group stringName - The output destination resource group.
- Schema
Name string - The output destination schema.
- Subscription
Id string - The output destination subscription id.
- Type string
- The output destination type.
- Credential string
- The resource ID of the credential to use to connect to the output destination.
- Database
Name string - The output destination database.
- Server
Name string - The output destination server name.
- Table
Name string - The output destination table.
- Resource
Group stringName - The output destination resource group.
- Schema
Name string - The output destination schema.
- Subscription
Id string - The output destination subscription id.
- Type string
- The output destination type.
- credential String
- The resource ID of the credential to use to connect to the output destination.
- database
Name String - The output destination database.
- server
Name String - The output destination server name.
- table
Name String - The output destination table.
- resource
Group StringName - The output destination resource group.
- schema
Name String - The output destination schema.
- subscription
Id String - The output destination subscription id.
- type String
- The output destination type.
- credential string
- The resource ID of the credential to use to connect to the output destination.
- database
Name string - The output destination database.
- server
Name string - The output destination server name.
- table
Name string - The output destination table.
- resource
Group stringName - The output destination resource group.
- schema
Name string - The output destination schema.
- subscription
Id string - The output destination subscription id.
- type string
- The output destination type.
- credential str
- The resource ID of the credential to use to connect to the output destination.
- database_
name str - The output destination database.
- server_
name str - The output destination server name.
- table_
name str - The output destination table.
- resource_
group_ strname - The output destination resource group.
- schema_
name str - The output destination schema.
- subscription_
id str - The output destination subscription id.
- type str
- The output destination type.
- credential String
- The resource ID of the credential to use to connect to the output destination.
- database
Name String - The output destination database.
- server
Name String - The output destination server name.
- table
Name String - The output destination table.
- resource
Group StringName - The output destination resource group.
- schema
Name String - The output destination schema.
- subscription
Id String - The output destination subscription id.
- type String
- The output destination type.
JobStepOutputType, JobStepOutputTypeArgs
- Sql
Database - SqlDatabase
- Job
Step Output Type Sql Database - SqlDatabase
- Sql
Database - SqlDatabase
- Sql
Database - SqlDatabase
- SQL_DATABASE
- SqlDatabase
- "Sql
Database" - SqlDatabase
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:sql:JobStep step1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0