Add-AzSqlElasticJobStep
Syntax
DefaultSet (Default)
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CommandText <String>
-Name <String>
[-CredentialName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDb
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <String>]
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDbId
Add-AzSqlElasticJobStep
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-JobName] <String>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <String>]
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ObjectSet
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CommandText <String>
-Name <String>
[-CredentialName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDbUsingParentObject
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <String>]
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDbIdUsingParentObject
Add-AzSqlElasticJobStep
[-ParentObject] <AzureSqlElasticJobModel>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <String>]
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdSet
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CommandText <String>
-Name <String>
[-CredentialName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDbUsingParentResourceId
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseObject <AzureSqlDatabaseModel>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <String>]
[-OutputSchemaName <String>]
[-StepId <Int32>]
[-TimeoutSeconds <Int32>]
[-RetryAttempts <Int32>]
[-InitialRetryIntervalSeconds <Int32>]
[-MaximumRetryIntervalSeconds <Int32>]
[-RetryIntervalBackoffMultiplier <Double>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
WithOutputDbIdUsingParentResourceId
Add-AzSqlElasticJobStep
[-ParentResourceId] <String>
-TargetGroupName <String>
-CommandText <String>
-OutputDatabaseResourceId <String>
-OutputTableName <String>
-Name <String>
[-CredentialName <String>]
[-OutputCredentialName <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
$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
-AgentName
The agent name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultSet
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDb
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CommandText
The command text
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CredentialName
The credential name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-InitialRetryIntervalSeconds
The initial retry interval seconds
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JobName
The job name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultSet
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDb
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MaximumRetryIntervalSeconds
The maximum retry interval seconds
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The job step name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: StepName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OutputCredentialName
The output credential name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
WithOutputDb
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OutputDatabaseObject
The output database object
Parameter properties
Parameter sets
WithOutputDb
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OutputDatabaseResourceId
The output database resource id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
WithOutputDbId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OutputSchemaName
The output schema name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
WithOutputDb
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OutputTableName
The output table name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
WithOutputDb
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ParentObject
The job object
Parameter properties
Parameter sets
ObjectSet
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ParentResourceId
The job resource id
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ResourceIdSet
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
WithOutputDbUsingParentResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ResourceGroupName
The resource group name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultSet
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDb
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RetryAttempts
The retry attempts
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RetryIntervalBackoffMultiplier
The retry interval back off multiplier
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServerName
The server name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultSet
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDb
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StepId
The step id
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TargetGroupName
The target group name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
DefaultSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDb
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ObjectSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
ResourceIdSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
WithOutputDbIdUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-TimeoutSeconds
The time out seconds
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs