functions/public/Get-QualysTag.ps1
|
function Get-QualysTag { <# .SYNOPSIS Gets a tag from Qualys. .DESCRIPTION This function takes a tag name or ID and returns the tag object. .PARAMETER TagName The name of the tag to be retrieved. .PARAMETER TagId The ID of the tag to be retrieved. .PARAMETER ParentTagId The ID of the parent tag to be retrieved. .PARAMETER Credential The credential object to log into Qualys. .EXAMPLE Get-QualysTag -tagName "Department:IT" $tag = Get-QualysTag -tagName "Department:IT" -Credential [PSCredential]::new("qapiuser", (Get-AzKeyVaultSecret -VaultName "MyAzKeyVault" -Name "qualys-password").SecretValue) $tag.id # returns the tag ID $tag = Get-QualysTag -tagId "123456789" -Credential [PSCredential]::new("qapiuser", (Get-AzKeyVaultSecret -VaultName "MyAzKeyVault" -Name "qualys-password").SecretValue) #> [CmdletBinding(DefaultParameterSetName = 'name')] param ( [Parameter(ParameterSetName = 'name', Mandatory = $true)] [string] $TagName, [Parameter(ParameterSetName = 'id', Mandatory = $true)] [Int64] $TagId, [Parameter(ParameterSetName = 'parent', Mandatory = $true)] [Int64] $ParentTagId, [Parameter(Mandatory = $true)] [pscredential] $Credential, [switch] $RetrieveParentTag, [switch] $RetrieveChildTags, [switch] $Recursive ) # Create a hashtable that maps parameter set names to parameter values $ParameterMap = @{ 'name' = $TagName 'id' = $TagId 'parent' = $ParentTagId } # Get the value for the current parameter set $ParameterValue = $ParameterMap[$PSCmdlet.ParameterSetName] # Build bodyTag, filtering on either tagName or tagId, depending on which was provided $BodyTag = "<ServiceRequest> <filters> <Criteria field=""$($PSCmdlet.ParameterSetName)"" operator=""EQUALS"">$ParameterValue</Criteria> </filters> </ServiceRequest>" Write-Verbose "Making API request for tag." # Store progress preference and set to SilentlyContinue $OrigProgressPreference = $ProgressPreference $ProgressPreference = 'SilentlyContinue' # Use Invoke-QualysTagRestCall to make the API request $RestSplat = @{ Method = 'POST' RelativeURI = 'qps/rest/2.0/search/am/tag' Credential = $Credential XmlBody = $BodyTag } $ResponseContent = [xml](Invoke-QualysTagRestCall @RestSplat) if ($null -eq $ResponseContent.ServiceResponse.data.Tag) { return $null } $ResponseTags = New-Object System.Collections.Generic.List[QualysTag] foreach ($tag in $ResponseContent.ServiceResponse.data.Tag) { $ResponseTags.Add( [QualysTag]::new($tag) ) } #pull parent tag and add to responseTag foreach ($ResponseTag in $ResponseTags) { if ( [string]::IsNullOrEmpty($ResponseTag.parentTagId) -eq $false -and $RetrieveParentTag ) { $params = @{ TagId = $ResponseTag.parentTagId Credential = $credential } if ($Recursive) { $params.Add("Recursive", $true) $params.Add("RetrieveParentTag", $true) } $ResponseTag.parentTag = Get-QualysTag @params } #pull child tags and add to responseTag if ( $RetrieveChildTags ) { $params = @{ ParentTagId = $ResponseTag.id Credential = $credential } if ($Recursive) { $params.Add("Recursive", $true) $params.Add("RetrieveChildTags", $true) } $resonseTag.childTags = Get-QualysTag @params # Don't add if there are no child tags } } # Restore progress preference $ProgressPreference = $OrigProgressPreference if ($ResponseTags.Count -eq 1) { return $ResponseTags[0] } return $ResponseTags } |