|
| 1 | + |
| 2 | +New-PipeScript |
| 3 | +-------------- |
| 4 | +### Synopsis |
| 5 | +Creates new PipeScript. |
| 6 | + |
| 7 | +--- |
| 8 | +### Description |
| 9 | + |
| 10 | +Creates new PipeScript and PowerShell ScriptBlocks. |
| 11 | + |
| 12 | +--- |
| 13 | +### Examples |
| 14 | +#### EXAMPLE 1 |
| 15 | +```PowerShell |
| 16 | +New-PipeScript -Parameter @{a='b'} |
| 17 | +``` |
| 18 | + |
| 19 | +--- |
| 20 | +### Parameters |
| 21 | +#### **Parameter** |
| 22 | + |
| 23 | +Defines one or more parameters for a ScriptBlock. |
| 24 | +Parameters can be defined in a few ways: |
| 25 | +* As a ```[Collections.Dictionary]``` of Parameters |
| 26 | +* As the ```[string]``` name of an untyped parameter. |
| 27 | +* As an ```[Object[]]```. |
| 28 | +* As a ```[ScriptBlock]``` |
| 29 | + |
| 30 | + |
| 31 | + |
| 32 | +|Type |Requried|Postion|PipelineInput | |
| 33 | +|--------------|--------|-------|---------------------| |
| 34 | +|```[Object]```|false |1 |true (ByPropertyName)| |
| 35 | +--- |
| 36 | +#### **DynamicParameter** |
| 37 | + |
| 38 | +The dynamic parameter block. |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +|Type |Requried|Postion|PipelineInput | |
| 43 | +|-------------------|--------|-------|---------------------| |
| 44 | +|```[ScriptBlock]```|false |2 |true (ByPropertyName)| |
| 45 | +--- |
| 46 | +#### **Begin** |
| 47 | + |
| 48 | +The begin block. |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +|Type |Requried|Postion|PipelineInput | |
| 53 | +|-------------------|--------|-------|---------------------| |
| 54 | +|```[ScriptBlock]```|false |3 |true (ByPropertyName)| |
| 55 | +--- |
| 56 | +#### **Process** |
| 57 | + |
| 58 | +The process block. |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +|Type |Requried|Postion|PipelineInput | |
| 63 | +|-------------------|--------|-------|---------------------| |
| 64 | +|```[ScriptBlock]```|false |4 |true (ByPropertyName)| |
| 65 | +--- |
| 66 | +#### **End** |
| 67 | + |
| 68 | +The end block. |
| 69 | + |
| 70 | + |
| 71 | + |
| 72 | +|Type |Requried|Postion|PipelineInput | |
| 73 | +|-------------------|--------|-------|---------------------| |
| 74 | +|```[ScriptBlock]```|false |5 |true (ByPropertyName)| |
| 75 | +--- |
| 76 | +#### **Header** |
| 77 | + |
| 78 | +The script header. |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | +|Type |Requried|Postion|PipelineInput | |
| 83 | +|--------------|--------|-------|---------------------| |
| 84 | +|```[String]```|false |6 |true (ByPropertyName)| |
| 85 | +--- |
| 86 | +### Syntax |
| 87 | +```PowerShell |
| 88 | +New-PipeScript [[-Parameter] <Object>] [[-DynamicParameter] <ScriptBlock>] [[-Begin] <ScriptBlock>] [[-Process] <ScriptBlock>] [[-End] <ScriptBlock>] [[-Header] <String>] [<CommonParameters>] |
| 89 | +``` |
| 90 | +--- |
| 91 | + |
| 92 | + |
0 commit comments