Export-AzAutomationDscConfiguration

Reference

Module:: Az.Automation

Exports a DSC configuration from Automation to a local file.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Export-AzAutomationDscConfiguration
      -Name <String>
      [-Slot <String>]
      [-OutputFolder <String>]
      [-Force]
      [-ResourceGroupName] <String>
      [-AutomationAccountName] <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Export-AzAutomationDscConfiguration cmdlet exports an APS Desired State Configuration (DSC) configuration from Azure Automation to a local file. The exported file has a .ps1 file name extension.

Examples

Example 1: Export the published version of a DSC configuration

PS C:\>Export-AzAutomationDscConfiguration -ResourceGroupName "ResourceGroup01" -AutomationAccountName "AutomationAccount01" -Name "Configuration01" -Slot Published -OutputFolder "C:\Users\PattiFuller\Desktop"

This command exports the published version of a DSC configuration in Automation to the specified folder, which is the desktop.

Parameters

-AutomationAccountName

Specifies the name of the Automation account that contains the DSC that this cmdlet exports.

Type:	String
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
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
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Indicates that this cmdlet replaces an existing local file with a new file that has the same name.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies the name of the DSC configuration that this cmdlet exports.

Type:	String
Aliases:	ConfigurationName
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-OutputFolder

Specifies the output folder where this cmdlet exports the DSC configuration.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Specifies the name of a resource group for which this cmdlet exports a DSC configuration.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Slot

Specifies which version of the DSC configuration that this cmdlet exports. Valid values are:

Draft
Published The default value is Published.

Type:	String
Accepted values:	Published, Draft
Position:	Named
Default value:	None
Accept pipeline input:	True
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

DirectoryInfo