Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
Gets a DSC Node configuration deployment job schedule in Automation.
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
Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule
-JobScheduleId <Guid>
[-ResourceGroupName] <String>
[-AutomationAccountName] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
The Get-AzureRmAutomationDscNodeConfigurationDeployment cmdlet deployes an APS Desired State Configuration (DSC) node configuration in Azure Automation.
Examples
Example 1: Get all the deployment schedules
PS C:\> Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule `
-AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01"
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5
JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule
RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobScheduleId : e347dfc4-62fe-4ed6-adfb-55518c57b558
JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSchedule
RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1Example 2: Get a deployment schedule
PS C:\> $js= Get-AzureRmAutomationDscNodeConfigurationDeploymentSchedule `
-AutomationAccountName "Contoso01" `
-ResourceGroupName "ResourceGroup01" `
-JobScheduleId 2b1d7738-093d-4ff7-b87b-e4b2321319e5
PS C:\> $js
ResourceGroupName : ResourceGroup01
AutomationAccountName : Contoso01
JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5
JobSchedule : Microsoft.Azure.Commands.Automation.Model.JobSche
RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1
PS C:\> $js.JobSchedule
ResourceGroupName : ResourceGroup01
RunOn :
AutomationAccountName : Contoso01
JobScheduleId : 2b1d7738-093d-4ff7-b87b-e4b2321319e5
RunbookName : Deploy-NodeConfigurationToAutomationDscNodesV1
ScheduleName : TestScheduleName
Parameters : {AutomationAccountName, NodeConfigurationName, ResourceGroupName, ListOfNodeNames}
HybridWorker :The above command deploys the DSC node configuration named "Config01.Node1" to the given two-dimensional array of Node Names. The deployment happens in a staged manner.
Parameters
-AutomationAccountName
Specifies the name of the Automation account that contains the DSC configuration that this cmdlet compiles.
| 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: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobScheduleId
Specifies the Job Schedule id of an existing scheduled deployment job.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group in which this cmdlet compiles a configuration.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
NodeConfigurationDeploymentSchedule