en-US/pwshCloudCommands-help.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-CloudCommand</command:name> <command:verb>Find</command:verb> <command:noun>CloudCommand</command:noun> <maml:description> <maml:para>Finds PowerShell cloud command(s) that match the provided query.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Performs query search on a dynamically updated cache of known PowerShell cloud commands. Results are returned based on provided criteria. Based on the query provided, a different form of search is performed. If a function name is provided (Verb-Noun), a function name query is performed. If a wildcard is provided (Ve*-Noun), a wildcard query is performed. Anything else is treated as a free-form query. Order of query efficiency is: 1. Function name query 2. Wildcard query 3. Free-form query Query performance will also be greatly increased if you filter to the specific cloud platform you are using (AWS/Azure/Oracle). Free-form queries can generate many results and by default only the top 30 results are returned. Use the -AllResults parameter with free-form queries to return all results.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-CloudCommand</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Query</maml:name> <maml:Description> <maml:para>PowerShell cloud command search input</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Filter results to specific cloud platform (AWS/Azure/Oracle)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AllResults</maml:name> <maml:Description> <maml:para>Return all results, regardless of the number of results returned</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Query</maml:name> <maml:Description> <maml:para>PowerShell cloud command search input</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Filter results to specific cloud platform (AWS/Azure/Oracle)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AllResults</maml:name> <maml:Description> <maml:para>Return all results, regardless of the number of results returned</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query Write-S3Object -Filter AWS</dev:code> <dev:remarks> <maml:para>Search for a specific function name (Verb-Noun) and filter to AWS.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query New-OCIComputeInstance -Filter Oracle</dev:code> <dev:remarks> <maml:para>Search for a specific function name (Verb-Noun) and filter to Oracle.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query New-MLDataSourceFromRedshift</dev:code> <dev:remarks> <maml:para>Search for a specific function name (Verb-Noun) against all cloud platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query New*VM* -Filter Azure</dev:code> <dev:remarks> <maml:para>Wildcard function search that is filtered to Azure.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query Get*WAF*</dev:code> <dev:remarks> <maml:para>Wildcard function search against all cloud platforms.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query 'I want to create a new compute instance' -Filter Oracle</dev:code> <dev:remarks> <maml:para>Free-form query that is filtered to Oracle.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 7 --------------------------</maml:title> <dev:code>Find-CloudCommand -Query 'download an object from a S3 bucket' -Filter AWS -AllResults</dev:code> <dev:remarks> <maml:para>Free-form query that is filtered to AWS and returns all results.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://docs.aws.amazon.com/powershell/latest/reference/</maml:linkText> <maml:uri>https://docs.aws.amazon.com/powershell/latest/reference/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://github.com/Azure/azure-powershell/blob/main/documentation/azure-powershell-modules.md</maml:linkText> <maml:uri>https://github.com/Azure/azure-powershell/blob/main/documentation/azure-powershell-modules.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/powershell.htm</maml:linkText> <maml:uri>https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/powershell.htm</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AllCloudCommandInfo</command:name> <command:verb>Get</command:verb> <command:noun>AllCloudCommandInfo</command:noun> <maml:description> <maml:para>Returns module and function information for all known PowerShell cloud commands.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns results from the entire PowerShell cloud command catalog. It is recommended to use the Filter parameter to reduce the size of the result set.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AllCloudCommandInfo</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Filter results to specific cloud platform (AWS/Azure/Oracle)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>Filter results to specific cloud platform (AWS/Azure/Oracle)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-AllCloudCommandInfo -Filter AWS</dev:code> <dev:remarks> <maml:para>Returns module and function information of all known AWS PowerShell cloud commands.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-AllCloudCommandInfo</dev:code> <dev:remarks> <maml:para>Returns module and function information of all known PowerShell cloud commands.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.aws.amazon.com/powershell/latest/reference/</maml:uri> </maml:navigationLink> </command:relatedLinks> </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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-CloudCommandFromFile</command:name> <command:verb>Get</command:verb> <command:noun>CloudCommandFromFile</command:noun> <maml:description> <maml:para>Evaluates PowerShell files in specified path and identifies a list of PowerShell cloud functions and their associated modules.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Discovers all PowerShell files in the specified path. Parses each file and identifies all PowerShell cloud functions and their associated modules.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-CloudCommandFromFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>File or Folder Path to evaluate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Path</maml:name> <maml:Description> <maml:para>File or Folder Path to evaluate.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Author: Jake Morrison - @jakemorrison - https://www.techthoughts.info/</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>$psCloud = Get-CloudCommandFromFile -Path "$env:HOME\pathToEvaluate" $psCloud</dev:code> <dev:remarks> <maml:para>Returns a list of PowerShell cloud functions and their associated modules found in files in the specified path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>$psCloud = Get-CloudCommandFromFile -Path "$env:HOME\pathToEvaluate" $psCloud.CloudCommands.ModuleName | Select-Object -Unique</dev:code> <dev:remarks> <maml:para>Returns a list of unique module names found in use in files in the specified path.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.aws.amazon.com/powershell/latest/reference/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |