Add-AzSqlElasticJobStep
Adds a job step to a job
Note
This is the previous version of our documentation. Please consult the most recent version for up-to-date information.
Syntax
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-Name <String>
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-Name <String>
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-Name <String>
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CredentialName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputCredentialName <String>
-OutputTableName <String>
-Name <String>
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Add-AzSqlElasticJobStep cmdlet adds a job step to a job
Examples
Example 1: Adds a step to a job
PS C:\> $job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -Name job1
$job | Add-AzSqlElasticJobStep -Name step1 -TargetGroupName tg1 -CredentialName cred1 -CommandText "SELECT 1"
JobName StepName StepId TargetGroupName CredentialName Output CommandText
------- -------- ------ --------------- -------------- ------ -----------
job1 step1 1 tg1 cred1 SELECT 1
Adds a job step to a job
Parameters
The agent name
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The command text
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The credential name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The initial retry interval seconds
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The job name
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The maximum retry interval seconds
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The job step name
| Type: | String |
| Aliases: | StepName |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The output credential name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The output database object
| Type: | AzureSqlDatabaseModel |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The output database resource id
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The output schema name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The output table name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The job object
| Type: | AzureSqlElasticJobModel |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The job resource id
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The resource group name
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The retry attempts
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The retry interval back off multiplier
| Type: | Nullable<T>[Double] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The server name
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The step id
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The target group name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The time out seconds
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |