< Back
Set-AzureRmSchedulerServiceBusTopicJob
Post
NAME Set-AzureRmSchedulerServiceBusTopicJob
SYNOPSIS
Modifies a service bus topic job.
SYNTAX
Set-AzureRmSchedulerServiceBusTopicJob [-DefaultProfile <IAzureContextContainer>] [-EndTime <DateTime>] [-ErrorActionType {Http | Https |
StorageQueue | ServiceBusQueue | ServiceBusTopic}] [-ExecutionCount <Int32>] [-Frequency {Minute | Hour | Day | Week | Month}] [-Interval <Int32>]
-JobCollectionName <String> -JobName <String> [-JobState {Enabled | Disabled}] -ResourceGroupName <String> -ServiceBusMessage <String>
-ServiceBusNamespace <String> -ServiceBusSasKeyName <String> -ServiceBusSasKeyValue <String> -ServiceBusTopicPath <String>
-ServiceBusTransportType {NetMessaging | AMQP} [-StartTime <DateTime>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmSchedulerServiceBusTopicJob cmdlet modifies a service bus topic job in Azure Scheduler.
This cmdlet supports dynamic parameters based on the ErrorActionType parameter. Dynamic parameters become available based on other parameter
values.
To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to
cycle through the available parameters. If you omit a required parameter, the cmdlet prompts you for the value.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndTime <DateTime>
Specifies an end time, as a DateTime object, for the job. To obtain a DateTime object, use the Get-Date cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ErrorActionType <String>
Specifies an error action setting for the job. The acceptable values for this parameter are:
- Http
- Https
- StorageQueue
- ServiceBusQueue
- ServiceBusTopic
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExecutionCount <Int32>
Specifies how many times the job runs. By default, a job recurs indefinitely.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Frequency <String>
Specifies a maximum frequency for the job. The acceptable values for this parameter are:
- Minute
- Hour
- Day
- Week
- Month
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Interval <Int32>
Specifies an interval of recurrence for the job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobCollectionName <String>
Specifies the name of the job collection to which the job belongs.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobName <String>
Specifies the name of the job that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobState <String>
Specifies the state of the job. The acceptable values for this parameter are:
- Enabled
- Disabled
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the resource group to which the job belongs.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceBusMessage <String>
Specifies a service bus topic message.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusNamespace <String>
Specifies a service bus namespace.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusSasKeyName <String>
Specifies a shared access signature key name.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusSasKeyValue <String>
Specifies a shared access signature key value.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusTopicPath <String>
Specifies a service bus topic path.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusTransportType <String>
Specifies a service bus transport type. The acceptable values for this parameter are:
- NetMessaging
- AMQP
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StartTime <DateTime>
Specifies the start time, as a DateTime object, for the job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ustopicjob
New-AzureRmSchedulerHttpJob
New-AzureRmSchedulerJobCollection
New-AzureRmSchedulerServiceBusQueueJob
New-AzureRmSchedulerServiceBusTopicJob
New-AzureRmSchedulerStorageQueueJob
Set-AzureRmSchedulerHttpJob
Set-AzureRmSchedulerJobCollection
Set-AzureRmSchedulerServiceBusQueueJob
Set-AzureRmSchedulerStorageQueueJob
SYNOPSIS
Modifies a service bus topic job.
SYNTAX
Set-AzureRmSchedulerServiceBusTopicJob [-DefaultProfile <IAzureContextContainer>] [-EndTime <DateTime>] [-ErrorActionType {Http | Https |
StorageQueue | ServiceBusQueue | ServiceBusTopic}] [-ExecutionCount <Int32>] [-Frequency {Minute | Hour | Day | Week | Month}] [-Interval <Int32>]
-JobCollectionName <String> -JobName <String> [-JobState {Enabled | Disabled}] -ResourceGroupName <String> -ServiceBusMessage <String>
-ServiceBusNamespace <String> -ServiceBusSasKeyName <String> -ServiceBusSasKeyValue <String> -ServiceBusTopicPath <String>
-ServiceBusTransportType {NetMessaging | AMQP} [-StartTime <DateTime>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmSchedulerServiceBusTopicJob cmdlet modifies a service bus topic job in Azure Scheduler.
This cmdlet supports dynamic parameters based on the ErrorActionType parameter. Dynamic parameters become available based on other parameter
values.
To discover the names of dynamic parameters after you specify the other parameters, type a hyphen (-), and then press the Tab key repeatedly to
cycle through the available parameters. If you omit a required parameter, the cmdlet prompts you for the value.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndTime <DateTime>
Specifies an end time, as a DateTime object, for the job. To obtain a DateTime object, use the Get-Date cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ErrorActionType <String>
Specifies an error action setting for the job. The acceptable values for this parameter are:
- Http
- Https
- StorageQueue
- ServiceBusQueue
- ServiceBusTopic
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExecutionCount <Int32>
Specifies how many times the job runs. By default, a job recurs indefinitely.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Frequency <String>
Specifies a maximum frequency for the job. The acceptable values for this parameter are:
- Minute
- Hour
- Day
- Week
- Month
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Interval <Int32>
Specifies an interval of recurrence for the job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-JobCollectionName <String>
Specifies the name of the job collection to which the job belongs.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobName <String>
Specifies the name of the job that this cmdlet modifies.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-JobState <String>
Specifies the state of the job. The acceptable values for this parameter are:
- Enabled
- Disabled
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the resource group to which the job belongs.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceBusMessage <String>
Specifies a service bus topic message.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusNamespace <String>
Specifies a service bus namespace.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusSasKeyName <String>
Specifies a shared access signature key name.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusSasKeyValue <String>
Specifies a shared access signature key value.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusTopicPath <String>
Specifies a service bus topic path.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ServiceBusTransportType <String>
Specifies a service bus transport type. The acceptable values for this parameter are:
- NetMessaging
- AMQP
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-StartTime <DateTime>
Specifies the start time, as a DateTime object, for the job.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.Scheduler.Models.PSSchedulerJobDefinition
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ustopicjob
New-AzureRmSchedulerHttpJob
New-AzureRmSchedulerJobCollection
New-AzureRmSchedulerServiceBusQueueJob
New-AzureRmSchedulerServiceBusTopicJob
New-AzureRmSchedulerStorageQueueJob
Set-AzureRmSchedulerHttpJob
Set-AzureRmSchedulerJobCollection
Set-AzureRmSchedulerServiceBusQueueJob
Set-AzureRmSchedulerStorageQueueJob