en-US/pwshCloudCommands-help.xml
|
<?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>Searches for PowerShell cloud commands matching a given query.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function searches a dynamically updated cache of PowerShell cloud commands, returning results that match specific criteria. The nature of the search depends on the type of query: - Function Name Query: Directly uses the function name format (Verb-Noun). - Wildcard Query: Utilizes wildcards (e.g., Ve*-Noun) for broader searches. - Free-form Query: Handles any other text as a general search term. The efficiency of queries follows this order: function name, wildcard, then free-form. Specifying a cloud platform (AWS/Azure/Oracle) enhances performance, especially for free-form queries. By default, free-form queries return the top 30 results; use the -AllResults parameter to retrieve all matches.</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>Search input for PowerShell cloud commands.</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>Filters the search to a 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>Retrieves all search results without limiting the number.</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>Search input for PowerShell cloud commands.</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>Filters the search to a 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>Retrieves all search results without limiting the number.</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>Searches for the 'Write-S3Object' function specifically within AWS services.</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>Looks for the 'New-OCIComputeInstance' function within Oracle cloud services.</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>Searches for 'New-MLDataSourceFromRedshift' across 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>Performs a wildcard search for VM-related functions within 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>Uses a wildcard search for WAF-related functions across all 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>Conducts a free-form search related to compute instances in Oracle cloud.</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>Executes a comprehensive free-form search for downloading objects from S3 in AWS.</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 detailed module and function information on all available PowerShell cloud commands.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function provides comprehensive details on modules and functions from the entire catalog of PowerShell cloud commands. To manage the volume of data returned, it's advisable to use the 'Filter' parameter to focus on a specific cloud provider's commands.</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>Filters the search to a 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>Filters the search to a 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>Retrieves a complete list of modules and functions for AWS-specific 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 information on all available PowerShell cloud commands across various cloud platforms.</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>Identifies PowerShell cloud functions and modules within files at a specified path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function scans and analyzes PowerShell files in a given directory or path. It parses each file to identify all PowerShell cloud functions and their associated modules, providing a comprehensive overview of cloud-related commands used in the project.</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 directory path to be evaluated for cloud command usage.</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 directory path to be evaluated for cloud command usage.</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>Examines the specified path for PowerShell files, returning a list of cloud functions and their modules found in these files.</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>After analyzing files at the specified path, this returns a list of unique module names utilized in those files.</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> |