Set-AzureRmSchedulerServiceBusQueueJob
Modifies a service bus queue job.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmSchedulerServiceBusQueueJob
-ResourceGroupName <String>
-JobCollectionName <String>
-JobName <String>
[-ServiceBusQueueName <String>]
-ServiceBusNamespace <String>
-ServiceBusTransportType <String>
-ServiceBusMessage <String>
-ServiceBusSasKeyName <String>
-ServiceBusSasKeyValue <String>
[-StartTime <DateTime>]
[-Interval <Int32>]
[-Frequency <String>]
[-EndTime <DateTime>]
[-ExecutionCount <Int32>]
[-JobState <String>]
[-ErrorActionType <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-AzureRmSchedulerServiceBusQueueJob cmdlet modifies a service bus queue 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
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EndTime
Specifies an end time, as a DateTime object, for the job. To obtain a DateTime object, use the Get-Date cmdlet.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ErrorActionType
Specifies an error action setting for the job. The acceptable values for this parameter are:
- Http
- Https
- StorageQueue
- ServiceBusQueue
- ServiceBusTopic
| Type: | String |
| Accepted values: | Http, Https, StorageQueue, ServiceBusQueue, ServiceBusTopic |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ExecutionCount
Specifies how many times the job runs. By default, a job recurs indefinitely.
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Frequency
Specifies a frequency for the job. The acceptable values for this parameter are:
- Minute
- Hour
- Day
- Week
- Month
| Type: | String |
| Accepted values: | Minute, Hour, Day, Week, Month |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Interval
Specifies an interval of recurrence for the job.
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobCollectionName
Specifies the name of the job collection to which the job belongs.
| Type: | String |
| Aliases: | Name, ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobName
Specifies the name of the job that this cmdlet modifies.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-JobState
Specifies the state of the job. The acceptable values for this parameter are:
- Enabled
- Disabled
| Type: | String |
| Accepted values: | Enabled, Disabled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the resource group to which the job belongs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceBusMessage
Specifies a service bus queue message.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceBusNamespace
Specifies a service bus namespace.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceBusQueueName
Specifies a service bus queue name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceBusSasKeyName
Specifies a shared access signature key name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceBusSasKeyValue
Specifies a shared access signature key value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServiceBusTransportType
Specifies a service bus transport type. The acceptable values for this parameter are:
- NetMessaging
- AMQP
| Type: | String |
| Accepted values: | NetMessaging, AMQP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StartTime
Specifies the start time, as a DateTime object, for the job.
| Type: | Nullable<T>[DateTime] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Related Links
- New-AzureRmSchedulerHttpJob
- New-AzureRmSchedulerJobCollection
- New-AzureRmSchedulerServiceBusQueueJob
- New-AzureRmSchedulerServiceBusTopicJob
- New-AzureRmSchedulerStorageQueueJob
- Set-AzureRmSchedulerHttpJob
- Set-AzureRmSchedulerJobCollection
- Set-AzureRmSchedulerServiceBusTopicJob
- Set-AzureRmSchedulerStorageQueueJob