ReverseDSC.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>ReverseDSC</name> </assembly> <members> <member name="T:ReverseDSC.Commands.AddConfigurationDataEntryCommand"> <summary> Adds a property to the ConfigurationData file the extract generates. The description ends up as a comment on top of the property in the resulting .psd1 file. </summary> </member> <member name="P:ReverseDSC.Commands.AddConfigurationDataEntryCommand.Node"> <summary> Node the property is added under. NonNodeData adds it to the non-node specific section. </summary> </member> <member name="P:ReverseDSC.Commands.AddConfigurationDataEntryCommand.Key"> <summary>Name of the property.</summary> </member> <member name="P:ReverseDSC.Commands.AddConfigurationDataEntryCommand.Value"> <summary>Value of the property.</summary> </member> <member name="P:ReverseDSC.Commands.AddConfigurationDataEntryCommand.Description"> <summary>Comment written on top of the property.</summary> </member> <member name="M:ReverseDSC.Commands.AddConfigurationDataEntryCommand.ProcessRecord"> <summary>Stores the property. Writes nothing.</summary> </member> <member name="T:ReverseDSC.Commands.GetConfigurationDataEntryCommand"> <summary> Retrieves the value and the description of a property of the ConfigurationData content that is being built. </summary> </member> <member name="P:ReverseDSC.Commands.GetConfigurationDataEntryCommand.Node"> <summary> Node to look in. When omitted or empty, every node is searched and the first match wins. </summary> </member> <member name="P:ReverseDSC.Commands.GetConfigurationDataEntryCommand.Key"> <summary>Name of the property to retrieve.</summary> </member> <member name="M:ReverseDSC.Commands.GetConfigurationDataEntryCommand.ProcessRecord"> <summary>Writes the entry, or nothing when the property is unknown.</summary> </member> <member name="T:ReverseDSC.Commands.ClearConfigurationDataContentCommand"> <summary> Clears the ConfigurationData content that is being built, resetting it to an empty state. </summary> </member> <member name="M:ReverseDSC.Commands.ClearConfigurationDataContentCommand.ProcessRecord"> <summary>Empties the content. Writes nothing.</summary> </member> <member name="T:ReverseDSC.Commands.GetConfigurationDataContentCommand"> <summary> Returns the ConfigurationData content that is being built as the formatted string of a .psd1 file, with an AllNodes and a NonNodeData section. </summary> </member> <member name="M:ReverseDSC.Commands.GetConfigurationDataContentCommand.ProcessRecord"> <summary>Writes the ConfigurationData content.</summary> </member> <member name="T:ReverseDSC.Commands.NewConfigurationDataDocumentCommand"> <summary> Writes the ConfigurationData content that is being built to a .psd1 file, encoded as UTF-8 without a byte order mark. </summary> </member> <member name="P:ReverseDSC.Commands.NewConfigurationDataDocumentCommand.Path"> <summary>Full file path the resulting file is written to.</summary> </member> <member name="M:ReverseDSC.Commands.NewConfigurationDataDocumentCommand.ProcessRecord"> <summary>Writes the file. Writes nothing to the pipeline.</summary> </member> <member name="T:ReverseDSC.Commands.GetCredentialsCommand"> <summary> Returns the lowercased username when it is already stored in the central list of required credentials, and nothing when it is not. </summary> </member> <member name="P:ReverseDSC.Commands.GetCredentialsCommand.UserName"> <summary>Username to look up.</summary> </member> <member name="M:ReverseDSC.Commands.GetCredentialsCommand.ProcessRecord"> <summary>Writes the stored username, or nothing when it is unknown.</summary> </member> <member name="T:ReverseDSC.Commands.ResolveCredentialsCommand"> <summary> Returns the name of the PSCredential variable that represents the specified user inside the extracted configuration. Credential variables are always named $Creds<username>, with the characters that are valid in usernames but not in variable names removed. </summary> </member> <member name="P:ReverseDSC.Commands.ResolveCredentialsCommand.UserName"> <summary>Username to build the variable name for.</summary> </member> <member name="M:ReverseDSC.Commands.ResolveCredentialsCommand.ProcessRecord"> <summary>Writes the credential variable name.</summary> </member> <member name="T:ReverseDSC.Commands.SaveCredentialsCommand"> <summary> Adds the username to the central list of required credentials when it is not already part of it. </summary> </member> <member name="P:ReverseDSC.Commands.SaveCredentialsCommand.UserName"> <summary>Username to store.</summary> </member> <member name="M:ReverseDSC.Commands.SaveCredentialsCommand.ProcessRecord"> <summary>Stores the username. Writes nothing.</summary> </member> <member name="T:ReverseDSC.Commands.TestCredentialsCommand"> <summary> Checks whether the username is already part of the central list of required credentials. </summary> </member> <member name="P:ReverseDSC.Commands.TestCredentialsCommand.UserName"> <summary>Username to check.</summary> </member> <member name="M:ReverseDSC.Commands.TestCredentialsCommand.ProcessRecord"> <summary>Writes true when the username is stored, otherwise false.</summary> </member> <member name="T:ReverseDSC.Commands.AddReverseDscUserNameCommand"> <summary> Adds the username to the list of user accounts the source environment requires, so that placeholders can be created in the destination environment. </summary> </member> <member name="P:ReverseDSC.Commands.AddReverseDscUserNameCommand.UserName"> <summary>Username to add.</summary> </member> <member name="M:ReverseDSC.Commands.AddReverseDscUserNameCommand.ProcessRecord"> <summary>Adds the username. Writes nothing.</summary> </member> <member name="T:ReverseDSC.Commands.ClearReverseDscUserNamesCommand"> <summary> Clears the list of user accounts the source environment requires. </summary> </member> <member name="M:ReverseDSC.Commands.ClearReverseDscUserNamesCommand.ProcessRecord"> <summary>Empties the list. Writes nothing.</summary> </member> <member name="T:ReverseDSC.Commands.GetDscBlockCommand"> <summary> Generates the DSC string representing an instance of the specified resource. CIM instances, class based complex type instances and arrays of either are rendered as MOF style blocks that are already unquoted and unescaped. Only values that were passed in as a pre-built string still need to be run through Convert-DSCStringParamToVariable afterwards. </summary> </member> <member name="P:ReverseDSC.Commands.GetDscBlockCommand.ModulePath"> <summary> Full file path to the .psm1 module the instance is generated for. In most cases this is the full path to the .psm1 file of the DSC resource. </summary> </member> <member name="P:ReverseDSC.Commands.GetDscBlockCommand.Params"> <summary>Key properties of the instance and their values.</summary> </member> <member name="P:ReverseDSC.Commands.GetDscBlockCommand.NoEscape"> <summary>Names of the parameters whose values are not escaped.</summary> </member> <member name="P:ReverseDSC.Commands.GetDscBlockCommand.AllowVariablesInStrings"> <summary> Preserves PowerShell variables inside string values instead of escaping them. </summary> </member> <member name="M:ReverseDSC.Commands.GetDscBlockCommand.ProcessRecord"> <summary>Writes the DSC representation of the instance.</summary> </member> <member name="T:ReverseDSC.Commands.GetDscDependsOnBlockCommand"> <summary> Generates the DependsOn clause for the received list of dependencies. </summary> </member> <member name="P:ReverseDSC.Commands.GetDscDependsOnBlockCommand.DependsOnItems"> <summary> Dependencies of the current DSC block, in the form [<DSCResourceName>]<InstanceName>. </summary> </member> <member name="M:ReverseDSC.Commands.GetDscDependsOnBlockCommand.ProcessRecord"> <summary>Writes the DependsOn clause.</summary> </member> <member name="T:ReverseDSC.Commands.GetDscParamTypeCommand"> <summary> Retrieves the data type of a parameter of the associated DSC resource, as it is declared on the Set-TargetResource function of the module. </summary> </member> <member name="P:ReverseDSC.Commands.GetDscParamTypeCommand.ModulePath"> <summary>Full file path to the .psm1 module that declares the parameter.</summary> </member> <member name="P:ReverseDSC.Commands.GetDscParamTypeCommand.ParamName"> <summary>Name of the parameter, including its leading dollar sign.</summary> </member> <member name="M:ReverseDSC.Commands.GetDscParamTypeCommand.ProcessRecord"> <summary>Writes the declared data type, or nothing when the parameter is unknown.</summary> </member> <member name="T:ReverseDSC.Commands.GetDscFakeParametersCommand"> <summary> Generates a hashtable holding every property the Get-TargetResource function of the specified DSC resource exposes, with a fake value derived from the declared data type. </summary> </member> <member name="P:ReverseDSC.Commands.GetDscFakeParametersCommand.ModulePath"> <summary>Full file path to the .psm1 module of the DSC resource.</summary> </member> <member name="M:ReverseDSC.Commands.GetDscFakeParametersCommand.ProcessRecord"> <summary>Writes the hashtable of fake parameter values.</summary> </member> <member name="T:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand"> <summary> Removes the quotes around a parameter value in a DSC block, turning the value into a variable reference instead of a string. Class based complex types and CIM instances that were rendered by Get-DSCBlock are already unquoted and must not be passed through this. </summary> </member> <member name="P:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand.DSCBlock"> <summary>The DSC block of the resource instance being extracted.</summary> </member> <member name="P:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand.ParameterName"> <summary>Name of the parameter whose value becomes a variable.</summary> </member> <member name="P:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand.IsCIMArray"> <summary> Marks the value as an array of CIM instances, whose items are not separated by commas and whose nested properties carry escaped double quotes. </summary> </member> <member name="P:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand.IsCIMObject"> <summary> Marks the value as a single CIM instance, which is a string carrying escaped double quotes that have to be handled separately. </summary> </member> <member name="M:ReverseDSC.Commands.ConvertDscStringParamToVariableCommand.ProcessRecord"> <summary>Writes the DSC block with the value of the parameter unquoted.</summary> </member> <member name="T:ReverseDSC.Commands.ReverseDscCmdlet"> <summary> Base class of the ReverseDSC cmdlets. Resolves the state that belongs to the module the cmdlet was imported with, so that a re-import starts from an empty state and concurrent runspaces never share one. </summary> </member> </members> </doc> |