你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Register-AzAutomationScheduledRunbook
Associates a runbook to a schedule.
Syntax
Register-AzAutomationScheduledRunbook
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Register-AzAutomationScheduledRunbook
-RunbookName <String>
-ScheduleName <String>
[-Parameters <IDictionary>]
[-RunOn <String>]
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Register-AzAutomationScheduledRunbook cmdlet associates an Azure Automation runbook to a schedule. The runbook starts based on the schedule you specify using the ScheduleName parameter.
Examples
Example 1: Associate a runbook with a schedule
Register-AzAutomationScheduledRunbook -AutomationAccountName "Contoso17" -RunbookName "Runbk01" -ScheduleName "Sched01" -ResourceGroupName "ResourceGroup01"
This command associates the runbook named Runbk01 with the schedule named Sched01 in the Azure Automation account named Contoso17.
Example 2
Associates a runbook to a schedule. (autogenerated)
Register-AzAutomationScheduledRunbook -AutomationAccountName 'Contoso17' -Parameters <IDictionary> -ResourceGroupName 'ResourceGroup01' -RunbookName 'Runbk01' -ScheduleName 'Sched01'
Parameters
-AutomationAccountName
Specifies an Automation account for the runbook on which this cmdlet operates.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameters
Specifies a hash table of key/value pairs. The keys are runbook parameter names. The values are runbook parameter values. When the runbook starts in response to the associated schedule, these parameters are passed to the runbook. Example: -Parameters @{"Key1"="Value1";"Key2"="Value2"}
Type: | IDictionary |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group for the scheduled runbook.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RunbookName
Specifies the name of the runbook that this cmdlet associates to a schedule.
Type: | String |
Aliases: | Name |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RunOn
The name of the hybrid runbook worker group.
Type: | String |
Aliases: | HybridWorker |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ScheduleName
Specifies the name of the schedule to which this cmdlet associates a runbook.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Outputs
Related Links
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈