Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions powershell-helpers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Introduction

The `powershell-adapters` folder contains helper modules that can be loaded into your PowerShell session to assist you in familiarizing yourself with new DSC concepts. To see the availability of helper modules, see the following list:

- **DSC Configuration Migration Module**: - Aids in the assistance of grabbing configuration documents written in PowerShell code and transform them to valid configuration documents for the DSC version 3 core engine (e.g. YAML or JSON).

## Getting started

To get started using the helper modules, you can follow the below steps. This example uses the _DSC Configuration Migration Tool_ to be loaded into the session:

1. Open a PowerShell terminal session
2. Execute the following command: `Import-Module "powershell-helpers\dscConfigurationMigrationTool.psm1"`
3. Discover examples using: `Get-Help ConvertTo-DscYaml`
47 changes: 47 additions & 0 deletions powershell-helpers/dscCfgMigMod.psd1
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
@{

# Script module or binary module file associated with this manifest.
RootModule = 'dscCfgMigMod.psm1'

# Version number of this module.
moduleVersion = '0.0.1'

# ID used to uniquely identify this module
GUID = '42bf8cb0-210c-4dac-8614-319d9287c6dc'

# Author of this module
Author = 'Microsoft Corporation'

# Company or vendor of this module
CompanyName = 'Microsoft Corporation'

# Copyright statement for this module
Copyright = '(c) Microsoft Corporation. All rights reserved.'

# Description of the functionality provided by this module
Description = 'PowerShell Desired State Configuration Migration Module helper'

# Modules that must be imported into the global environment prior to importing this module
RequiredModules = @('powershell-yaml')

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @(
'ConvertTo-DscJson'
'ConvertTo-DscYaml'
)

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = @()

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

PrivateData = @{
PSData = @{
ProjectUri = 'https://github.com/PowerShell/dsc'
}
}
}
Loading