-
-
Notifications
You must be signed in to change notification settings - Fork 3
Get RoughDraftExtension
Gets Extensions
Gets Extensions.
RoughDraft Extensions can be found in:
- Any module that includes -ExtensionModuleName in it's tags.
- The directory specified in -ExtensionPath
Get-RoughDraftExtensionIf provided, will look beneath a specific path for extensions.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String] |
false | 1 | true (ByPropertyName) |
If set, will clear caches of extensions, forcing a refresh.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
If provided, will get RoughDraft Extensions that extend a given command
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String[]] |
false | 2 | true (ByPropertyName) |
The name of an extension
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String[]] |
false | 3 | true (ByPropertyName) |
If provided, will treat -ExtensionName as a wildcard.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If provided, will treat -ExtensionName as a regular expression.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will return the dynamic parameters object of all the RoughDraft Extensions for a given command.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will return if the extension could run
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will run the extension. If -Stream is passed, results will be directly returned. By default, extension results are wrapped in a return object.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will stream output from running the extension. By default, extension results are wrapped in a return object.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will return the dynamic parameters of all RoughDraft Extensions for a given command, using the provided DynamicParameterSetName. Implies -DynamicParameter.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String] |
false | 4 | true (ByPropertyName) |
If provided, will return the dynamic parameters of all RoughDraft Extensions for a given command, with all positional parameters offset. Implies -DynamicParameter.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Int32] |
false | 5 | true (ByPropertyName) |
If set, will return the dynamic parameters of all RoughDraft Extensions for a given command, with all mandatory parameters marked as optional. Implies -DynamicParameter. Does not actually prevent the parameter from being Mandatory on the Extension.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | true (ByPropertyName) |
If set, will validate this input against [ValidateScript], [ValidatePattern], [ValidateSet], and [ValidateRange] attributes found on an extension.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[PSObject] |
false | 6 | true (ByPropertyName) |
If set, will validate this input against all [ValidateScript], [ValidatePattern], [ValidateSet], and [ValidateRange] attributes found on an extension. By default, if any validation attribute returned true, the extension is considered validated.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
The name of the parameter set. This is used by -CouldRun and -Run to enforce a single specific parameter set.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String] |
false | 7 | true (ByPropertyName) |
The parameters to the extension. Only used when determining if the extension -CouldRun.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[IDictionary] |
false | 8 | true (ByPropertyName) |
If set, will output a steppable pipeline for the extension. Steppable pipelines allow you to control how begin, process, and end are executed in an extension. This allows for the execution of more than one extension at a time.
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
If set, will output the help for the extensions
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
If set, will get help about one or more parameters of an extension
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[String[]] |
false | 9 | false |
If set, will get help examples
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
If set, will output the full help for the extensions
| Type | Requried | Postion | PipelineInput |
|---|---|---|---|
[Switch] |
false | named | false |
Extension
Get-RoughDraftExtension [[-ExtensionPath] <String>] [-Force] [[-CommandName] <String[]>] [[-ExtensionName] <String[]>] [-Like] [-Match] [-DynamicParameter] [-CouldRun] [-Run] [-Stream] [[-DynamicParameterSetName] <String>] [[-DynamicParameterPositionOffset] <Int32>] [-NoMandatoryDynamicParameter] [[-ValidateInput] <PSObject>] [-AllValid] [[-ParameterSetName] <String>] [[-Parameter] <IDictionary>] [-SteppablePipeline] [-Help] [[-ParameterHelp] <String[]>] [-Example] [-FullHelp] [<CommonParameters>]