|
1 | 1 | ProxyCommand |
2 | 2 | ------------ |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
3 | 7 | ### Synopsis |
4 | 8 | Creates Proxy Commands |
5 | 9 |
|
| 10 | + |
| 11 | + |
6 | 12 | --- |
| 13 | + |
| 14 | + |
7 | 15 | ### Description |
8 | 16 |
|
9 | 17 | Generates a Proxy Command for an underlying PowerShell or PipeScript command. |
10 | 18 |
|
| 19 | + |
| 20 | + |
11 | 21 | --- |
| 22 | + |
| 23 | + |
12 | 24 | ### Examples |
13 | 25 | #### EXAMPLE 1 |
14 | 26 | ```PowerShell |
@@ -58,79 +70,79 @@ Invoke-PipeScript -ScriptBlock { |
58 | 70 | } | .>PipeScript |
59 | 71 | ``` |
60 | 72 |
|
| 73 | + |
| 74 | + |
61 | 75 | --- |
| 76 | + |
| 77 | + |
62 | 78 | ### Parameters |
63 | 79 | #### **ScriptBlock** |
64 | 80 |
|
65 | 81 | The ScriptBlock that will become a proxy command. This should be empty, since it is ignored. |
66 | 82 |
|
67 | 83 |
|
68 | 84 |
|
69 | | -> **Type**: ```[ScriptBlock]``` |
70 | 85 |
|
71 | | -> **Required**: false |
72 | 86 |
|
73 | | -> **Position**: named |
74 | 87 |
|
75 | | -> **PipelineInput**:true (ByValue) |
| 88 | +|Type |Required|Position|PipelineInput | |
| 89 | +|---------------|--------|--------|--------------| |
| 90 | +|`[ScriptBlock]`|false |named |true (ByValue)| |
76 | 91 |
|
77 | 92 |
|
78 | 93 |
|
79 | | ---- |
80 | 94 | #### **CommandName** |
81 | 95 |
|
82 | 96 | The name of the command being proxied. |
83 | 97 |
|
84 | 98 |
|
85 | 99 |
|
86 | | -> **Type**: ```[String]``` |
87 | 100 |
|
88 | | -> **Required**: true |
89 | 101 |
|
90 | | -> **Position**: 1 |
91 | 102 |
|
92 | | -> **PipelineInput**:false |
| 103 | +|Type |Required|Position|PipelineInput| |
| 104 | +|----------|--------|--------|-------------| |
| 105 | +|`[String]`|true |1 |false | |
93 | 106 |
|
94 | 107 |
|
95 | 108 |
|
96 | | ---- |
97 | 109 | #### **RemoveParameter** |
98 | 110 |
|
99 | 111 | If provided, will remove any number of parameters from the proxy command. |
100 | 112 |
|
101 | 113 |
|
102 | 114 |
|
103 | | -> **Type**: ```[String[]]``` |
104 | 115 |
|
105 | | -> **Required**: false |
106 | 116 |
|
107 | | -> **Position**: named |
108 | 117 |
|
109 | | -> **PipelineInput**:false |
| 118 | +|Type |Required|Position|PipelineInput| |
| 119 | +|------------|--------|--------|-------------| |
| 120 | +|`[String[]]`|false |named |false | |
110 | 121 |
|
111 | 122 |
|
112 | 123 |
|
113 | | ---- |
114 | 124 | #### **DefaultParameter** |
115 | 125 |
|
116 | 126 | Any default parameters for the ProxyCommand. |
117 | 127 |
|
118 | 128 |
|
119 | 129 |
|
120 | | -> **Type**: ```[IDictionary]``` |
121 | 130 |
|
122 | | -> **Required**: false |
123 | 131 |
|
124 | | -> **Position**: named |
125 | 132 |
|
126 | | -> **PipelineInput**:false |
| 133 | +|Type |Required|Position|PipelineInput| |
| 134 | +|---------------|--------|--------|-------------| |
| 135 | +|`[IDictionary]`|false |named |false | |
| 136 | + |
| 137 | + |
127 | 138 |
|
128 | 139 |
|
129 | 140 |
|
130 | 141 | --- |
| 142 | + |
| 143 | + |
131 | 144 | ### Syntax |
132 | 145 | ```PowerShell |
133 | 146 | ProxyCommand [-ScriptBlock <ScriptBlock>] [-CommandName] <String> [-RemoveParameter <String[]>] [-DefaultParameter <IDictionary>] [<CommonParameters>] |
134 | 147 | ``` |
135 | | ---- |
136 | 148 |
|
0 commit comments