PSRest.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Set-RestEnvironment</command:name> <maml:description> <maml:para>Sets the current environment.</maml:para> </maml:description> <command:verb>Set</command:verb> <command:noun>RestEnvironment</command:noun> </command:details> <maml:description> <maml:para>Sets the current environment as $RestEnvironment in the current scope. This variable is used by other commands as the parameter Environment default. If Set-RestEnvironment is not invoked or its $RestEnvironment is not in the current or parent scope, other PSRest commands may fail. They might need their own Set-RestEnvironment invoked or $RestEnvironment exposed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-RestEnvironment</maml:name> <command:parameter required="false" position="0" > <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Path</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" position="0" > <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the environment name, one of defined in ".vscode/settings.json". Example: '$shared' (default), 'local', 'production': { "rest-client.environmentVariables": { "$shared": { ... }, "local": { ... }, "production": { ... } } }</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Path</maml:name> <maml:description> <maml:para>Specifies the directory used for files discovery. Default: The current location.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-RestVariable</command:name> <maml:description> <maml:para>Gets the specified variable.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>RestVariable</command:noun> </command:details> <maml:description> <maml:para>Gets the specified variable value or null if the variable is not found.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RestVariable</maml:name> <command:parameter required="true" position="0" > <maml:name>Name</maml:name> <command:parameterValue required="true">String</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Environment</maml:name> <command:parameterValue required="true">RestEnvironment</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Type</maml:name> <command:parameterValue required="true">VariableType</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" position="0" > <maml:name>Name</maml:name> <maml:description> <maml:para>The variable name.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies the environment, usually different from the current set by Set-RestEnvironment. In most cases this parameter is not used directly.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Type</maml:name> <maml:description> <maml:para>The variable type. Default: Any With Any, Name is the full name with a prefix like $dotenv, $processEnv, etc. With other types, Name is just the name.</maml:para> <maml:para>Values : Any, Env, Shared, DotEnv, ProcessEnv</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Resolve-RestVariable</command:name> <maml:description> <maml:para>Expands variables in input strings.</maml:para> </maml:description> <command:verb>Resolve</command:verb> <command:noun>RestVariable</command:noun> </command:details> <maml:description> <maml:para>Replaces each variable embedded in the specified string with its value, then returns the result string.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resolve-RestVariable</maml:name> <command:parameter required="true" position="0" > <maml:name>Value</maml:name> <command:parameterValue required="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Environment</maml:name> <command:parameterValue required="true">RestEnvironment</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" pipelineInput="true (ByValue)" position="0" > <maml:name>Value</maml:name> <maml:description> <maml:para>One or more strings to expand, specified as parameter or pipeline input. Nulls and empty strings are allowed and passed through.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" position="named" > <maml:name>Environment</maml:name> <maml:description> <maml:para>Specifies the environment, usually different from the current set by Set-RestEnvironment. In most cases this parameter is not used directly.</maml:para> </maml:description> </command:parameter> </command:parameters> </command:command> </helpItems> |