Skip to content

ConvertTo-Yml

SYNOPSIS

Converts a PowerShell object to a YAML string.

SYNTAX

__AllParameterSets

ConvertTo-Yml [-InputObject] <Object>

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Converts a PowerShell object to a YAML-formatted string. This is a placeholder function. Full implementation is pending.

EXAMPLES

EXAMPLE 1

ConvertTo-Yml -InputObject @{ Name = 'World' }

Name: World

PARAMETERS

-InputObject

The object to convert to YAML.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

You can pipe any object to this function.

{{ Fill in the Description }}

System.Object

{{ Fill in the Description }}

OUTPUTS

System.String

A YAML-formatted string representation of the input object.

{{ Fill in the Description }}

System.String

{{ Fill in the Description }}

NOTES