Migrate remaining Get-Pfb* cmdlets to Add-PfbCommonQueryParams (#33)

Public/Admin/Get-PfbAdmin.ps1

@@ -53,11 +53,7 @@ function Get-PfbAdmin {
     }
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbAdminCache.ps1

@@ -55,11 +55,7 @@ function Get-PfbAdminCache {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/cache' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbAdminManagementAccessPolicy.ps1

@@ -48,12 +48,11 @@ function Get-PfbAdminManagementAccessPolicy {
     Assert-PfbConnection -Array ([ref]$Array)
 
     $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($MemberName) { $queryParams['member_names'] = $MemberName -join ',' }
     if ($MemberId)   { $queryParams['member_ids']   = $MemberId -join ',' }
     if ($PolicyName) { $queryParams['policy_names'] = $PolicyName -join ',' }
     if ($PolicyId)   { $queryParams['policy_ids']   = $PolicyId -join ',' }
-    if ($Filter)     { $queryParams['filter']       = $Filter }
-    if ($Limit -gt 0) { $queryParams['limit']       = $Limit }
 
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/management-access-policies' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbAdminSetting.ps1

@@ -6,6 +6,12 @@ function Get-PfbAdminSetting {
         The Get-PfbAdminSetting cmdlet returns global administrator settings from the connected
         Pure Storage FlashBlade. These settings include lockout policy, single sign-on
         configuration, and other administrative-level options.
+    .PARAMETER Filter
+        A server-side filter expression to narrow results.
+    .PARAMETER Sort
+        Sort field and direction.
+    .PARAMETER Limit
+        Maximum number of items to return.
     .PARAMETER Array
         The FlashBlade connection object. If not specified, the default connection is used.
     .EXAMPLE
@@ -23,6 +29,9 @@ function Get-PfbAdminSetting {
     #>
     [CmdletBinding()]
     param(
+        [Parameter()] [string]$Filter,
+        [Parameter()] [string]$Sort,
+        [Parameter()] [int]$Limit,
         [Parameter()] [PSCustomObject]$Array
     )
 
@@ -31,6 +40,9 @@ function Get-PfbAdminSetting {
     }
 
     process {
-        Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/settings'
+        $queryParams = @{}
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
+
+        Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/settings' -QueryParams $queryParams
     }
 }

Public/Admin/Get-PfbAdminSshCaPolicy.ps1

@@ -48,12 +48,11 @@ function Get-PfbAdminSshCaPolicy {
     Assert-PfbConnection -Array ([ref]$Array)
 
     $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($MemberName) { $queryParams['member_names'] = $MemberName -join ',' }
     if ($MemberId)   { $queryParams['member_ids']   = $MemberId -join ',' }
     if ($PolicyName) { $queryParams['policy_names'] = $PolicyName -join ',' }
     if ($PolicyId)   { $queryParams['policy_ids']   = $PolicyId -join ',' }
-    if ($Filter)     { $queryParams['filter']       = $Filter }
-    if ($Limit -gt 0) { $queryParams['limit']       = $Limit }
 
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/ssh-certificate-authority-policies' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbApiClient.ps1

@@ -55,11 +55,7 @@ function Get-PfbApiClient {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'api-clients' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbApiToken.ps1

@@ -53,11 +53,7 @@ function Get-PfbApiToken {
     }
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'admins/api-tokens' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbManagementAccessPolicy.ps1

@@ -54,11 +54,7 @@ function Get-PfbManagementAccessPolicy {
     }
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'management-access-policies' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbManagementAccessPolicyAdmin.ps1

@@ -47,12 +47,11 @@ function Get-PfbManagementAccessPolicyAdmin {
     Assert-PfbConnection -Array ([ref]$Array)
 
     $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($PolicyName) { $queryParams['policy_names'] = $PolicyName -join ',' }
     if ($PolicyId)   { $queryParams['policy_ids']   = $PolicyId -join ',' }
     if ($MemberName) { $queryParams['member_names'] = $MemberName -join ',' }
     if ($MemberId)   { $queryParams['member_ids']   = $MemberId -join ',' }
-    if ($Filter)     { $queryParams['filter']       = $Filter }
-    if ($Limit -gt 0) { $queryParams['limit']       = $Limit }
 
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'management-access-policies/admins' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbManagementAccessPolicyDirectoryRole.ps1

@@ -47,12 +47,11 @@ function Get-PfbManagementAccessPolicyDirectoryRole {
     Assert-PfbConnection -Array ([ref]$Array)
 
     $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($PolicyName) { $queryParams['policy_names'] = $PolicyName -join ',' }
     if ($PolicyId)   { $queryParams['policy_ids']   = $PolicyId -join ',' }
     if ($MemberName) { $queryParams['member_names'] = $MemberName -join ',' }
     if ($MemberId)   { $queryParams['member_ids']   = $MemberId -join ',' }
-    if ($Filter)     { $queryParams['filter']       = $Filter }
-    if ($Limit -gt 0) { $queryParams['limit']       = $Limit }
 
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'management-access-policies/directory-services/roles' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbManagementAccessPolicyMember.ps1

@@ -47,12 +47,11 @@ function Get-PfbManagementAccessPolicyMember {
     Assert-PfbConnection -Array ([ref]$Array)
 
     $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($PolicyName) { $queryParams['policy_names'] = $PolicyName -join ',' }
     if ($PolicyId)   { $queryParams['policy_ids']   = $PolicyId -join ',' }
     if ($MemberName) { $queryParams['member_names'] = $MemberName -join ',' }
     if ($MemberId)   { $queryParams['member_ids']   = $MemberId -join ',' }
-    if ($Filter)     { $queryParams['filter']       = $Filter }
-    if ($Limit -gt 0) { $queryParams['limit']       = $Limit }
 
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'management-access-policies/members' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbOidcIdp.ps1

@@ -54,11 +54,7 @@ function Get-PfbOidcIdp {
     }
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'sso/oidc/idps' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbPasswordPolicy.ps1

@@ -6,6 +6,12 @@ function Get-PfbPasswordPolicy {
         The Get-PfbPasswordPolicy cmdlet returns the password policy settings from the connected
         Pure Storage FlashBlade. This is a singleton resource that returns the current password
         complexity and expiration requirements configured on the array.
+    .PARAMETER Filter
+        A server-side filter expression to narrow results.
+    .PARAMETER Sort
+        Sort field and direction.
+    .PARAMETER Limit
+        Maximum number of items to return.
     .PARAMETER Array
         The FlashBlade connection object. If not specified, the default connection is used.
     .EXAMPLE
@@ -23,9 +29,16 @@ function Get-PfbPasswordPolicy {
     #>
     [CmdletBinding()]
     param(
+        [Parameter()] [string]$Filter,
+        [Parameter()] [string]$Sort,
+        [Parameter()] [int]$Limit,
         [Parameter()] [PSCustomObject]$Array
     )
 
     Assert-PfbConnection -Array ([ref]$Array)
-    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'password-policies' -AutoPaginate
+
+    $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
+
+    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'password-policies' -QueryParams $queryParams -AutoPaginate
 }

Public/Admin/Get-PfbPublicKey.ps1

@@ -55,11 +55,7 @@ function Get-PfbPublicKey {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'public-keys' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbSaml2Idp.ps1

@@ -54,11 +54,7 @@ function Get-PfbSaml2Idp {
     }
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'sso/saml2/idps' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Admin/Get-PfbSession.ps1

@@ -55,11 +55,7 @@ function Get-PfbSession {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'sessions' -QueryParams $queryParams -AutoPaginate
     }
 }

Public/Alert/Get-PfbAlert.ps1

@@ -49,11 +49,7 @@ function Get-PfbAlert {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']   = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']     = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter']  = $Filter }
-        if ($Sort)                 { $queryParams['sort']    = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']   = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
         if ($PSBoundParameters.ContainsKey('Flagged'))    { $queryParams['flagged'] = ([bool]$Flagged).ToString().ToLower() }
 
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'alerts' -QueryParams $queryParams -AutoPaginate

Public/Alert/Get-PfbAlertWatcher.ps1

@@ -44,11 +44,7 @@ function Get-PfbAlertWatcher {
 
     end {
         $queryParams = @{}
-        if ($allNames.Count -gt 0) { $queryParams['names']  = $allNames -join ',' }
-        if ($allIds.Count -gt 0)   { $queryParams['ids']    = $allIds -join ',' }
-        if ($Filter)               { $queryParams['filter'] = $Filter }
-        if ($Sort)                 { $queryParams['sort']   = $Sort }
-        if ($Limit -gt 0)         { $queryParams['limit']  = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters -Names $allNames -Ids $allIds
 
         Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'alert-watchers' -QueryParams $queryParams -AutoPaginate
     }

Public/Array/Get-PfbArray.ps1

@@ -4,6 +4,12 @@ function Get-PfbArray {
         Retrieves FlashBlade array information.
     .DESCRIPTION
         Returns array attributes including name, OS version, model, and configuration.
+    .PARAMETER Filter
+        A server-side filter expression to narrow results.
+    .PARAMETER Sort
+        Sort field and direction.
+    .PARAMETER Limit
+        Maximum number of items to return.
     .PARAMETER Array
         The FlashBlade connection object. If not specified, uses the default connection.
     .EXAMPLE
@@ -13,11 +19,23 @@ function Get-PfbArray {
     #>
     [CmdletBinding()]
     param(
+        [Parameter()]
+        [string]$Filter,
+
+        [Parameter()]
+        [string]$Sort,
+
+        [Parameter()]
+        [int]$Limit,
+
         [Parameter()]
         [PSCustomObject]$Array
     )
 
     Assert-PfbConnection -Array ([ref]$Array)
 
-    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'arrays' -AutoPaginate
+    $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
+
+    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'arrays' -QueryParams $queryParams -AutoPaginate
 }

Public/Array/Get-PfbArrayClientPerformance.ps1

@@ -46,9 +46,7 @@ function Get-PfbArrayClientPerformance {
 
     process {
         $queryParams = @{}
-        if ($Filter)       { $queryParams['filter']     = $Filter }
-        if ($Sort)         { $queryParams['sort']       = $Sort }
-        if ($Limit -gt 0)  { $queryParams['limit']      = $Limit }
+        Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
         if ($StartTime)    { $queryParams['start_time'] = $StartTime }
         if ($EndTime)      { $queryParams['end_time']   = $EndTime }
         if ($Resolution)   { $queryParams['resolution'] = $Resolution }

Public/Array/Get-PfbArrayClientS3Performance.ps1

@@ -43,9 +43,7 @@ function Get-PfbArrayClientS3Performance {
     )
     Assert-PfbConnection -Array ([ref]$Array)
     $queryParams = @{}
-    if ($Filter) { $queryParams['filter'] = $Filter }
-    if ($Sort) { $queryParams['sort'] = $Sort }
-    if ($Limit -gt 0) { $queryParams['limit'] = $Limit }
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     if ($StartTime) { $queryParams['start_time'] = $StartTime }
     if ($EndTime) { $queryParams['end_time'] = $EndTime }
     if ($Resolution) { $queryParams['resolution'] = $Resolution }

Public/Array/Get-PfbArrayErasure.ps1

@@ -33,8 +33,6 @@ function Get-PfbArrayErasure {
     )
     Assert-PfbConnection -Array ([ref]$Array)
     $queryParams = @{}
-    if ($Filter) { $queryParams['filter'] = $Filter }
-    if ($Sort) { $queryParams['sort'] = $Sort }
-    if ($Limit -gt 0) { $queryParams['limit'] = $Limit }
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
     Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'arrays/erasures' -QueryParams $queryParams -AutoPaginate
 }

Public/Array/Get-PfbArrayEula.ps1

@@ -5,6 +5,12 @@ function Get-PfbArrayEula {
     .DESCRIPTION
         The Get-PfbArrayEula cmdlet returns the current End User License Agreement acceptance
         status from the connected Pure Storage FlashBlade. This is a singleton endpoint.
+    .PARAMETER Filter
+        A server-side filter expression to narrow results.
+    .PARAMETER Sort
+        Sort field and direction.
+    .PARAMETER Limit
+        Maximum number of items to return.
     .PARAMETER Array
         The FlashBlade connection object. If not specified, the default connection is used.
     .EXAMPLE
@@ -21,7 +27,16 @@ function Get-PfbArrayEula {
         Retrieves the EULA status and displays whether it has been accepted.
     #>
     [CmdletBinding()]
-    param([Parameter()] [PSCustomObject]$Array)
+    param(
+        [Parameter()] [string]$Filter,
+        [Parameter()] [string]$Sort,
+        [Parameter()] [int]$Limit,
+        [Parameter()] [PSCustomObject]$Array
+    )
     Assert-PfbConnection -Array ([ref]$Array)
-    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'arrays/eula'
+
+    $queryParams = @{}
+    Add-PfbCommonQueryParams -Into $queryParams -BoundParameters $PSBoundParameters
+
+    Invoke-PfbApiRequest -Array $Array -Method GET -Endpoint 'arrays/eula' -QueryParams $queryParams
 }