Azure Native v1.102.0, May 2 23

azure-native.sql.getJobStep

Explore with Pulumi AI

Gets a job step in a job’s current version. API Version: 2020-11-01-preview.

Using getJobStep

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJobStep(args: GetJobStepArgs, opts?: InvokeOptions): Promise<GetJobStepResult>
function getJobStepOutput(args: GetJobStepOutputArgs, opts?: InvokeOptions): Output<GetJobStepResult>

def get_job_step(job_agent_name: Optional[str] = None,
                 job_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 server_name: Optional[str] = None,
                 step_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetJobStepResult
def get_job_step_output(job_agent_name: Optional[pulumi.Input[str]] = None,
                 job_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 server_name: Optional[pulumi.Input[str]] = None,
                 step_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetJobStepResult]

func LookupJobStep(ctx *Context, args *LookupJobStepArgs, opts ...InvokeOption) (*LookupJobStepResult, error)
func LookupJobStepOutput(ctx *Context, args *LookupJobStepOutputArgs, opts ...InvokeOption) LookupJobStepResultOutput

> Note: This function is named LookupJobStep in the Go SDK.

public static class GetJobStep 
{
    public static Task<GetJobStepResult> InvokeAsync(GetJobStepArgs args, InvokeOptions? opts = null)
    public static Output<GetJobStepResult> Invoke(GetJobStepInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetJobStepResult> getJobStep(GetJobStepArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:sql:getJobStep
  arguments:
    # arguments dictionary

The following arguments are supported:

JobAgentName string: The name of the job agent.
JobName string: The name of the job.
ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName string: The name of the server.
StepName string: The name of the job step.

JobAgentName string: The name of the job agent.
JobName string: The name of the job.
ResourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ServerName string: The name of the server.
StepName string: The name of the job step.

jobAgentName String: The name of the job agent.
jobName String: The name of the job.
resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName String: The name of the server.
stepName String: The name of the job step.

jobAgentName string: The name of the job agent.
jobName string: The name of the job.
resourceGroupName string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName string: The name of the server.
stepName string: The name of the job step.

job_agent_name str: The name of the job agent.
job_name str: The name of the job.
resource_group_name str: 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.
step_name str: The name of the job step.

jobAgentName String: The name of the job agent.
jobName String: The name of the job.
resourceGroupName String: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName String: The name of the server.
stepName String: The name of the job step.

getJobStep Result

The following output properties are available:

Action Pulumi.AzureNative.Sql.Outputs.JobStepActionResponse: 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.
Id string: Resource ID.
Name string: Resource name.
TargetGroup string: The resource ID of the target group that the job step will be executed on.
Type string: Resource type.
ExecutionOptions Pulumi.AzureNative.Sql.Outputs.JobStepExecutionOptionsResponse: Execution options for the job step.
Output Pulumi.AzureNative.Sql.Outputs.JobStepOutputResponse: Output destination properties of the job step.
StepId 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.

Action JobStepActionResponse: 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.
Id string: Resource ID.
Name string: Resource name.
TargetGroup string: The resource ID of the target group that the job step will be executed on.
Type string: Resource type.
ExecutionOptions JobStepExecutionOptionsResponse: Execution options for the job step.
Output JobStepOutputResponse: Output destination properties of the job step.
StepId 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.

action JobStepActionResponse: 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.
id String: Resource ID.
name String: Resource name.
targetGroup String: The resource ID of the target group that the job step will be executed on.
type String: Resource type.
executionOptions JobStepExecutionOptionsResponse: Execution options for the job step.
output JobStepOutputResponse: Output destination properties of the job step.
stepId 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.

action JobStepActionResponse: 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.
id string: Resource ID.
name string: Resource name.
targetGroup string: The resource ID of the target group that the job step will be executed on.
type string: Resource type.
executionOptions JobStepExecutionOptionsResponse: Execution options for the job step.
output JobStepOutputResponse: Output destination properties of the job step.
stepId 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.

action JobStepActionResponse: 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.
id str: Resource ID.
name str: Resource name.
target_group str: The resource ID of the target group that the job step will be executed on.
type str: Resource type.
execution_options JobStepExecutionOptionsResponse: Execution options for the job step.
output JobStepOutputResponse: 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.

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.
id String: Resource ID.
name String: Resource name.
targetGroup String: The resource ID of the target group that the job step will be executed on.
type String: Resource type.
executionOptions Property Map: Execution options for the job step.
output Property Map: Output destination properties of the job step.
stepId 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.

Supporting Types

JobStepActionResponse

Value string: The action value, for example the text of the T-SQL script to execute.
Source string: The source of the action to execute.
Type string: 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: The source of the action to execute.
Type string: 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: The source of the action to execute.
type String: 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: The source of the action to execute.
type string: 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: The source of the action to execute.
type str: 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: The source of the action to execute.
type String: Type of action being executed by the job step.

JobStepExecutionOptionsResponse

InitialRetryIntervalSeconds int: Initial delay between retries for job step execution.
MaximumRetryIntervalSeconds int: The maximum amount of time to wait between retries for job step execution.
RetryAttempts int: Maximum number of times the job step will be reattempted if the first attempt fails.
RetryIntervalBackoffMultiplier double: The backoff multiplier for the time between retries.
TimeoutSeconds int: Execution timeout for the job step.

InitialRetryIntervalSeconds int: Initial delay between retries for job step execution.
MaximumRetryIntervalSeconds int: The maximum amount of time to wait between retries for job step execution.
RetryAttempts int: Maximum number of times the job step will be reattempted if the first attempt fails.
RetryIntervalBackoffMultiplier float64: The backoff multiplier for the time between retries.
TimeoutSeconds int: Execution timeout for the job step.

initialRetryIntervalSeconds Integer: Initial delay between retries for job step execution.
maximumRetryIntervalSeconds Integer: The maximum amount of time to wait between retries for job step execution.
retryAttempts Integer: Maximum number of times the job step will be reattempted if the first attempt fails.
retryIntervalBackoffMultiplier Double: The backoff multiplier for the time between retries.
timeoutSeconds Integer: Execution timeout for the job step.

initialRetryIntervalSeconds number: Initial delay between retries for job step execution.
maximumRetryIntervalSeconds number: The maximum amount of time to wait between retries for job step execution.
retryAttempts number: Maximum number of times the job step will be reattempted if the first attempt fails.
retryIntervalBackoffMultiplier number: The backoff multiplier for the time between retries.
timeoutSeconds number: Execution timeout for the job step.

initial_retry_interval_seconds int: Initial delay between retries for job step execution.
maximum_retry_interval_seconds int: 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_backoff_multiplier float: The backoff multiplier for the time between retries.
timeout_seconds int: Execution timeout for the job step.

initialRetryIntervalSeconds Number: Initial delay between retries for job step execution.
maximumRetryIntervalSeconds Number: The maximum amount of time to wait between retries for job step execution.
retryAttempts Number: Maximum number of times the job step will be reattempted if the first attempt fails.
retryIntervalBackoffMultiplier Number: The backoff multiplier for the time between retries.
timeoutSeconds Number: Execution timeout for the job step.

JobStepOutputResponse

Credential string: The resource ID of the credential to use to connect to the output destination.
DatabaseName string: The output destination database.
ServerName string: The output destination server name.
TableName string: The output destination table.
ResourceGroupName string: The output destination resource group.
SchemaName string: The output destination schema.
SubscriptionId 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.
DatabaseName string: The output destination database.
ServerName string: The output destination server name.
TableName string: The output destination table.
ResourceGroupName string: The output destination resource group.
SchemaName string: The output destination schema.
SubscriptionId 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.
databaseName String: The output destination database.
serverName String: The output destination server name.
tableName String: The output destination table.
resourceGroupName String: The output destination resource group.
schemaName String: The output destination schema.
subscriptionId 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.
databaseName string: The output destination database.
serverName string: The output destination server name.
tableName string: The output destination table.
resourceGroupName string: The output destination resource group.
schemaName string: The output destination schema.
subscriptionId 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_name str: 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.
databaseName String: The output destination database.
serverName String: The output destination server name.
tableName String: The output destination table.
resourceGroupName String: The output destination resource group.
schemaName String: The output destination schema.
subscriptionId String: The output destination subscription id.
type String: The output destination type.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0