Private/SIAArgumentCompleter.ps1
|
function Get-SIACompletionResult { <# .SYNOPSIS Turns objects returned by a Get-SIA* command into CompletionResult entries. .DESCRIPTION Shared formatting/filtering for the module's argument completers. Given the objects a Get-SIA* lookup returned, the word the user is completing, and the candidate property name(s) that hold the value to place on the command line (plus optional label property name(s) for the tooltip), it emits one [CompletionResult] per match. Matching is a prefix match, case-insensitive, against either the value or the label so a policy can be found by its id or its name. Values containing whitespace are single quoted so they bind as a single argument. .PARAMETER InputObject The objects returned by the Get-SIA* command. Accepts pipeline input. .PARAMETER WordToComplete The partial value the completion engine passed in. .PARAMETER ValueProperty Property name(s) holding the value to complete, tried in order; the first non-empty wins. .PARAMETER LabelProperty Optional property name(s) holding a friendly label for the tooltip, tried in order. .EXAMPLE $items | Get-SIACompletionResult -WordToComplete $wordToComplete -ValueProperty policyId -LabelProperty policyName #> [OutputType([System.Management.Automation.CompletionResult])] [CmdletBinding()] param( [parameter(Mandatory = $false, ValueFromPipeline = $true)] [object[]]$InputObject, [parameter(Mandatory = $false)] [string]$WordToComplete, [parameter(Mandatory = $true)] [string[]]$ValueProperty, [parameter(Mandatory = $false)] [string[]]$LabelProperty ) begin { #Drop any opening quote the user has already typed. $Word = "$WordToComplete".Trim("'`"") }#begin process { foreach ($Item in $InputObject) { $Value = $ValueProperty | ForEach-Object { $Item.$_ } | Where-Object { $_ } | Select-Object -First 1 if (-not $Value) { continue } $Label = $LabelProperty | ForEach-Object { $Item.$_ } | Where-Object { $_ } | Select-Object -First 1 #Force scalar strings - an empty $Label from an absent property would otherwise make the #-notlike below evaluate to an empty array and break the -and. $Value = "$Value" $Label = "$Label" if (($Value -notlike "$Word*") -and ($Label -notlike "$Word*")) { continue } $CompletionText = if ($Value -match '\s') { "'$($Value -replace "'", "''")'" } else { "$Value" } $ToolTip = if ($Label -and ($Label -ne $Value)) { "$Label ($Value)" } else { "$Value" } [System.Management.Automation.CompletionResult]::new($CompletionText, $ToolTip, 'ParameterValue', $ToolTip) } }#process end { }#end } function Get-SIAArgumentCompleter { <# .SYNOPSIS Builds an argument-completer scriptblock backed by a Get-SIA* command. .DESCRIPTION Returns a scriptblock suitable for Register-ArgumentCompleter. When invoked by the completion engine it dispatches the lookup into the owning module (& $Module { ... }, the way psPAS does it), skips the call when there is no active session, and swallows any error so tab completion stays silent rather than noisy. .PARAMETER RetrievalCommand Name of the Get-SIA* command to call for candidate objects. .PARAMETER ValueProperty Property name(s) on the returned objects holding the value to complete, tried in order. .PARAMETER LabelProperty Optional property name(s) holding a friendly label for the tooltip, tried in order. .EXAMPLE Register-ArgumentCompleter -ParameterName policyId -CommandName Set-SIAPolicy -ScriptBlock ( Get-SIAArgumentCompleter -RetrievalCommand Get-SIAPolicy -ValueProperty policyId -LabelProperty policyName ) #> [OutputType([scriptblock])] [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Captured by GetNewClosure and used inside the returned scriptblock')] [CmdletBinding()] param( [parameter(Mandatory = $true)] [string]$RetrievalCommand, [parameter(Mandatory = $true)] [string[]]$ValueProperty, [parameter(Mandatory = $false)] [string[]]$LabelProperty ) { param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters) #Standard ArgumentCompleter parameters that are not otherwise referenced. $null = $parameterName, $commandAst, $fakeBoundParameters try { $Module = (Get-Command $commandName -ErrorAction Stop).Module & $Module { param($Retrieval, $ValueProperty, $LabelProperty, $Word) #No point calling the API before Connect-SIATenant has run. if ([string]::IsNullOrWhiteSpace($ISPSSSession.tenant_url)) { return } & $Retrieval -ErrorAction Stop | Get-SIACompletionResult -WordToComplete $Word -ValueProperty $ValueProperty -LabelProperty $LabelProperty } $RetrievalCommand $ValueProperty $LabelProperty $wordToComplete } catch { return } }.GetNewClosure() } #region Registration $SIAConnectorIdCompleter = Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIAConnector' -ValueProperty 'id' -LabelProperty 'name' Register-ArgumentCompleter -ParameterName 'connector_id' -ScriptBlock $SIAConnectorIdCompleter -CommandName @( 'Get-SIAConnector' 'Remove-SIAConnector' 'Update-SIAConnector' 'Test-SIAConnector' 'Set-SIAConnectorMaintenanceMode' 'Invoke-SIAConnectorCertificateRotation' ) Register-ArgumentCompleter -ParameterName 'connectorId' -ScriptBlock $SIAConnectorIdCompleter -CommandName 'Add-SIAConnectorPoolMember' $SIAPolicyIdCompleter = Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIAPolicy' -ValueProperty 'policyId' -LabelProperty 'policyName' #Get-SIAPolicy / Remove-SIAPolicy / Set-SIAPolicy. foreach ($ParameterName in 'policyid') { Register-ArgumentCompleter -ParameterName $ParameterName -ScriptBlock $SIAPolicyIdCompleter -CommandName @( 'Get-SIAPolicy' 'Set-SIAPolicy' 'Remove-SIAPolicy' ) } Register-ArgumentCompleter -ParameterName 'policyName' -ScriptBlock ( Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIAPolicy' -ValueProperty 'policyName' ) -CommandName 'Set-SIAPolicy' Register-ArgumentCompleter -ParameterName 'strong_account_id' -ScriptBlock ( Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIADatabaseStrongAccount' -ValueProperty 'id' -LabelProperty 'name' ) -CommandName @( 'Get-SIADatabaseStrongAccount' 'Set-SIADatabaseStrongAccount' 'Remove-SIADatabaseStrongAccount' ) $SIASecretIdCompleter = Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIAStrongAccount' -ValueProperty 'secret_id' -LabelProperty 'secret_name' Register-ArgumentCompleter -ParameterName 'secret_id' -ScriptBlock $SIASecretIdCompleter -CommandName @( 'Remove-SIAStrongAccount' 'Set-SIAStrongAccount' 'Add-SIATargetSet' ) #Get-SIATargetSet takes the strong account's secret_id under a differently-cased parameter name. Register-ArgumentCompleter -ParameterName 'strongAccountId' -ScriptBlock $SIASecretIdCompleter -CommandName 'Get-SIATargetSet' Register-ArgumentCompleter -ParameterName 'name' -ScriptBlock ( Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIATargetSet' -ValueProperty 'name' -LabelProperty 'type' ) -CommandName @( 'Get-SIATargetSet' 'Remove-SIATargetSet' ) #Get-SIAHttpsRelay's item id field is unconfirmed against a live response - assumed 'id' by analogy #with every other SIA list endpoint. No label property, for the same reason. Register-ArgumentCompleter -ParameterName 'https_relay_id' -ScriptBlock ( Get-SIAArgumentCompleter -RetrievalCommand 'Get-SIAHttpsRelay' -ValueProperty 'id' ) -CommandName @( 'Remove-SIAHttpsRelay' 'Update-SIAHttpsRelay' 'Invoke-SIAHttpsRelayCertificateRotation' ) #endregion |