Set-AzSqlElasticJob
Syntax
DefaultSet (Default)
Set-AzSqlElasticJob
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-Name] <String>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunOnce
Set-AzSqlElasticJob
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-Name] <String>
[-RunOnce]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Recurring
Set-AzSqlElasticJob
[-ResourceGroupName] <String>
[-ServerName] <String>
[-AgentName] <String>
[-Name] <String>
-IntervalType <String>
-IntervalCount <UInt32>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ObjectSet
Set-AzSqlElasticJob
[-InputObject] <AzureSqlElasticJobModel>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunOnceUsingParentObject
Set-AzSqlElasticJob
[-InputObject] <AzureSqlElasticJobModel>
[-RunOnce]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RecurringUsingParentObject
Set-AzSqlElasticJob
[-InputObject] <AzureSqlElasticJobModel>
-IntervalType <String>
-IntervalCount <UInt32>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ResourceIdSet
Set-AzSqlElasticJob
[-ResourceId] <String>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RunOnceUsingParentResourceId
Set-AzSqlElasticJob
[-ResourceId] <String>
[-RunOnce]
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RecurringUsingParentResourceId
Set-AzSqlElasticJob
[-ResourceId] <String>
-IntervalType <String>
-IntervalCount <UInt32>
[-StartTime <DateTime>]
[-EndTime <DateTime>]
[-Enable]
[-Description <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlElasticJob cmdlet updates a job
Examples
Example 1: Updates a job to start an hour from now and repeat every 1 hour
$job = Get-AzSqlElasticJob -ResourceGroupName rg -ServerName elasticjobserver -AgentName agent -Name job1
$job | Set-AzSqlElasticJob -IntervalType Hour -IntervalCount 1 -StartTime (Get-Date).AddHours(1) -Enable
JobName Version Description StartTime EndTime ScheduleType Interval Enabled
------- ------- ----------- --------- ------- ------------ -------- -------
job1 0 6/1/2018 10:50:15 PM 12/31/9999 11:59:59 AM Recurring PT1H True
Updates a job
Example 2
Set-AzSqlElasticJob -AgentName agent -Enable -IntervalCount 1 -IntervalType Hour -Name step1 -ResourceGroupName MyResourceGroup -ServerName s1 -StartTime '9/16/2016 11:31:12'
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
RunOnce
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Recurring
Position: 2 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
-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
-Description
The job description
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
-Enable
The flag to indicate customer wants this job to be enabled.
Parameter properties
Type: SwitchParameter
Default value: False 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
-EndTime
The job schedule end time
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
The job input object
ObjectSet
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RunOnceUsingParentObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
RecurringUsingParentObject
Position: 0 Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-IntervalCount
The recurring schedule interval count
Parameter properties
Parameter sets
Recurring
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RecurringUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RecurringUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IntervalType
The recurring schedule interval type - Can be Minute, Hour, Day, Week, Month
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Recurring
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RecurringUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RecurringUsingParentResourceId
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The job name
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: JobName
Parameter sets
DefaultSet
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunOnce
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Recurring
Position: 3 Mandatory: True Value from pipeline: False Value from pipeline by property name: False 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
RunOnce
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Recurring
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceId
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
RunOnceUsingParentResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
RecurringUsingParentResourceId
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RunOnce
The flag to indicate job will be run once
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False
Parameter sets
RunOnce
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunOnceUsingParentObject
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
RunOnceUsingParentResourceId
Position: Named Mandatory: True 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
RunOnce
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Recurring
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-StartTime
The job schedule start time
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
-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
