Update manifest and docs to 3.1.0 ***NO_CI***

VenafiPS/VenafiPS.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Greg Brownstein
 #
-# Generated on: 6/14/2021
+# Generated on: 6/24/2021
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '3.1'
+ModuleVersion = '3.1.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

docs/changelog.md

@@ -1,3 +1,10 @@
+## 3.1.0
+- Add `-CountOnly` to `Find-TppCertificate` to return the number of certificates found based on the filters provided, [#12](https://github.com/gdbarron/VenafiPS/issues/12)
+- Move from `Invoke-RestMethod` to `Invoke-WebRequest` in `Invoke-VenafiRestMethod` so we get response headers, to be used with `-CountOnly` above.  `Invoke-VenafiRestMethod` has a new parameter, `-FullResponse`, to retrieve the complete response, not just content value.
+- Add `New-HttpQueryString` private function to support HEAD api calls which require a query string and not body.
+- Fix `Test-TppIdentityFormat` which was failing when the identity guid was surrounded with curly braces
+- Replace `-Limit` parameter and standardize on `-First`
+
 ## 3.0.3
 - Fix [#10](https://github.com/gdbarron/VenafiPS/issues/10), Get-VenafiCertificate not recognizing session.
 

docs/functions/Find-TppCertificate.md

@@ -7,7 +7,7 @@ Find certificates based on various attributes
 
 ### NoPath (Default)
 ```
-Find-TppCertificate [-Limit <Int32>] [-Offset <Int32>] [-Country <String>] [-CommonName <String>]
+Find-TppCertificate [-First <Int32>] [-Offset <Int32>] [-Country <String>] [-CommonName <String>]
  [-Issuer <String>] [-KeyAlgorithm <String[]>] [-KeySize <Int32[]>] [-KeySizeGreaterThan <Int32>]
  [-KeySizeLessThan <Int32>] [-Locale <String[]>] [-Organization <String[]>] [-OrganizationUnit <String[]>]
  [-State <String[]>] [-SanDns <String>] [-SanEmail <String>] [-SanIP <String>] [-SanUpn <String>]
@@ -16,28 +16,13 @@ Find-TppCertificate [-Limit <Int32>] [-Offset <Int32>] [-Country <String>] [-Com
  [-Enabled] [-InError <Boolean>] [-NetworkValidationEnabled <Boolean>] [-CreatedDate <DateTime>]
  [-CreatedAfter <DateTime>] [-CreatedBefore <DateTime>] [-ManagementType <TppManagementType[]>]
  [-PendingWorkflow] [-Stage <TppCertificateStage[]>] [-StageGreaterThan <TppCertificateStage>]
- [-StageLessThan <TppCertificateStage>] [-ValidationEnabled] [-ValidationState <String[]>]
+ [-StageLessThan <TppCertificateStage>] [-ValidationEnabled] [-ValidationState <String[]>] [-CountOnly]
  [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
-### ByObject
-```
-Find-TppCertificate -InputObject <TppObject> [-Recursive] [-Limit <Int32>] [-Offset <Int32>]
- [-Country <String>] [-CommonName <String>] [-Issuer <String>] [-KeyAlgorithm <String[]>] [-KeySize <Int32[]>]
- [-KeySizeGreaterThan <Int32>] [-KeySizeLessThan <Int32>] [-Locale <String[]>] [-Organization <String[]>]
- [-OrganizationUnit <String[]>] [-State <String[]>] [-SanDns <String>] [-SanEmail <String>] [-SanIP <String>]
- [-SanUpn <String>] [-SanUri <String>] [-SerialNumber <String>] [-SignatureAlgorithm <String>]
- [-Thumbprint <String>] [-IssueDate <DateTime>] [-ExpireDate <DateTime>] [-ExpireAfter <DateTime>]
- [-ExpireBefore <DateTime>] [-Enabled] [-InError <Boolean>] [-NetworkValidationEnabled <Boolean>]
- [-CreatedDate <DateTime>] [-CreatedAfter <DateTime>] [-CreatedBefore <DateTime>]
- [-ManagementType <TppManagementType[]>] [-PendingWorkflow] [-Stage <TppCertificateStage[]>]
- [-StageGreaterThan <TppCertificateStage>] [-StageLessThan <TppCertificateStage>] [-ValidationEnabled]
- [-ValidationState <String[]>] [-VenafiSession <VenafiSession>] [<CommonParameters>]
-```
-
 ### ByPath
 ```
-Find-TppCertificate -Path <String> [-Recursive] [-Limit <Int32>] [-Offset <Int32>] [-Country <String>]
+Find-TppCertificate -Path <String> [-Recursive] [-First <Int32>] [-Offset <Int32>] [-Country <String>]
  [-CommonName <String>] [-Issuer <String>] [-KeyAlgorithm <String[]>] [-KeySize <Int32[]>]
  [-KeySizeGreaterThan <Int32>] [-KeySizeLessThan <Int32>] [-Locale <String[]>] [-Organization <String[]>]
  [-OrganizationUnit <String[]>] [-State <String[]>] [-SanDns <String>] [-SanEmail <String>] [-SanIP <String>]
@@ -47,12 +32,12 @@ Find-TppCertificate -Path <String> [-Recursive] [-Limit <Int32>] [-Offset <Int32
  [-CreatedDate <DateTime>] [-CreatedAfter <DateTime>] [-CreatedBefore <DateTime>]
  [-ManagementType <TppManagementType[]>] [-PendingWorkflow] [-Stage <TppCertificateStage[]>]
  [-StageGreaterThan <TppCertificateStage>] [-StageLessThan <TppCertificateStage>] [-ValidationEnabled]
- [-ValidationState <String[]>] [-VenafiSession <VenafiSession>] [<CommonParameters>]
+ [-ValidationState <String[]>] [-CountOnly] [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ### ByGuid
 ```
-Find-TppCertificate -Guid <Guid> [-Recursive] [-Limit <Int32>] [-Offset <Int32>] [-Country <String>]
+Find-TppCertificate -Guid <Guid> [-Recursive] [-First <Int32>] [-Offset <Int32>] [-Country <String>]
  [-CommonName <String>] [-Issuer <String>] [-KeyAlgorithm <String[]>] [-KeySize <Int32[]>]
  [-KeySizeGreaterThan <Int32>] [-KeySizeLessThan <Int32>] [-Locale <String[]>] [-Organization <String[]>]
  [-OrganizationUnit <String[]>] [-State <String[]>] [-SanDns <String>] [-SanEmail <String>] [-SanIP <String>]
@@ -62,7 +47,7 @@ Find-TppCertificate -Guid <Guid> [-Recursive] [-Limit <Int32>] [-Offset <Int32>]
  [-CreatedDate <DateTime>] [-CreatedAfter <DateTime>] [-CreatedBefore <DateTime>]
  [-ManagementType <TppManagementType[]>] [-PendingWorkflow] [-Stage <TppCertificateStage[]>]
  [-StageGreaterThan <TppCertificateStage>] [-StageLessThan <TppCertificateStage>] [-ValidationEnabled]
- [-ValidationState <String[]>] [-VenafiSession <VenafiSession>] [<CommonParameters>]
+ [-ValidationState <String[]>] [-CountOnly] [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -79,14 +64,14 @@ Find all certificates expiring before a certain date
 
 ### EXAMPLE 2
 ```
-Find-TppCertificate -ExpireBefore "2018-01-01" -Limit 5
+Find-TppCertificate -ExpireBefore "2018-01-01" -First 5
 ```
 
 Find 5 certificates expiring before a certain date
 
 ### EXAMPLE 3
 ```
-Find-TppCertificate -ExpireBefore "2018-01-01" -Limit 5 -Offset 2
+Find-TppCertificate -ExpireBefore "2018-01-01" -First 5 -Offset 2
 ```
 
 Find 5 certificates expiring before a certain date, starting at the 3rd certificate found.
@@ -114,7 +99,7 @@ Find all certificates in a specific path and all subfolders
 
 ### EXAMPLE 7
 ```
-Find-TppCertificate -ExpireBefore "2018-01-01" -Limit 5 | Get-TppCertificateDetail
+Find-TppCertificate -ExpireBefore "2018-01-01" -First 5 | Get-TppCertificateDetail
 ```
 
 Get detailed certificate info on the first 5 certificates expiring before a certain date
@@ -128,21 +113,6 @@ Renew all certificates expiring before a certain date
 
 ## PARAMETERS
 
-### -InputObject
-TppObject of type 'Policy' which represents a starting path
-
-```yaml
-Type: TppObject
-Parameter Sets: ByObject
-Aliases:
-
-Required: True
-Position: Named
-Default value: None
-Accept pipeline input: True (ByValue)
-Accept wildcard characters: False
-```
-
 ### -Path
 Starting path to search from
 
@@ -154,7 +124,7 @@ Aliases: DN
 Required: True
 Position: Named
 Default value: None
-Accept pipeline input: True (ByValue)
+Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
@@ -178,7 +148,7 @@ Search recursively starting from the search path.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: ByObject, ByPath, ByGuid
+Parameter Sets: ByPath, ByGuid
 Aliases:
 
 Required: False
@@ -188,15 +158,15 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Limit
+### -First
 Limit how many items are returned. 
 Default is 0 for no limit.
 It is definitely recommended to filter on another property when searching with no limit.
 
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases:
+Aliases: Limit
 
 Required: False
 Position: Named
@@ -766,6 +736,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -CountOnly
+Return the count of certificates found from the query as opposed to the certificates themselves
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -VenafiSession
 Session object created from New-VenafiSession method. 
 The value defaults to the script session object $VenafiSession.
@@ -787,10 +772,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### InputObject, Path, Guid
+### Path, Guid
 ## OUTPUTS
 
-### TppObject
+### TppObject, Int when CountOnly provided
 ## NOTES
 
 ## RELATED LINKS

docs/functions/Find-TppIdentity.md

@@ -7,7 +7,7 @@ Search for identity details
 
 ### Find (Default)
 ```
-Find-TppIdentity -Name <String[]> [-Limit <Int32>] [-IncludeUsers] [-IncludeSecurityGroups]
+Find-TppIdentity -Name <String[]> [-First <Int32>] [-IncludeUsers] [-IncludeSecurityGroups]
  [-IncludeDistributionGroups] [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
@@ -53,13 +53,13 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -Limit
-Limit how many items are returned, the default is 500, but is limited by the provider.
+### -First
+First how many items are returned, the default is 500, but is limited by the provider.
 
 ```yaml
 Type: Int32
 Parameter Sets: Find
-Aliases:
+Aliases: Limit
 
 Required: False
 Position: Named

docs/functions/Invoke-VenafiRestMethod.md

@@ -8,13 +8,13 @@ Generic REST API call
 ### Session (Default)
 ```
 Invoke-VenafiRestMethod -VenafiSession <VenafiSession> [-Method <String>] [-UriRoot <String>] -UriLeaf <String>
- [-Header <Hashtable>] [-Body <Hashtable>] [<CommonParameters>]
+ [-Header <Hashtable>] [-Body <Hashtable>] [-FullResponse] [<CommonParameters>]
 ```
 
 ### URL
 ```
 Invoke-VenafiRestMethod -ServerUrl <String> [-UseDefaultCredentials] [-Method <String>] [-UriRoot <String>]
- -UriLeaf <String> [-Header <Hashtable>] [-Body <Hashtable>] [<CommonParameters>]
+ -UriLeaf <String> [-Header <Hashtable>] [-Body <Hashtable>] [-FullResponse] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -153,6 +153,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -FullResponse
+{{ Fill FullResponse Description }}
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 

docs/functions/Read-TppLog.md

@@ -8,21 +8,21 @@ Read entries from the TPP log
 ### Default (Default)
 ```
 Read-TppLog [-Severity <TppEventSeverity>] [-StartTime <DateTime>] [-EndTime <DateTime>] [-Text1 <String>]
- [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-Limit <Int32>] [-VenafiSession <VenafiSession>]
+ [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-First <Int32>] [-VenafiSession <VenafiSession>]
  [<CommonParameters>]
 ```
 
 ### ByObject
 ```
 Read-TppLog -InputObject <TppObject> [-Severity <TppEventSeverity>] [-StartTime <DateTime>]
- [-EndTime <DateTime>] [-Text1 <String>] [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-Limit <Int32>]
+ [-EndTime <DateTime>] [-Text1 <String>] [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-First <Int32>]
  [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ### ByPath
 ```
 Read-TppLog -Path <String> [-Severity <TppEventSeverity>] [-StartTime <DateTime>] [-EndTime <DateTime>]
- [-Text1 <String>] [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-Limit <Int32>]
+ [-Text1 <String>] [-Text2 <String>] [-Value1 <Int32>] [-Value2 <Int32>] [-First <Int32>]
  [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
@@ -33,7 +33,7 @@ Read entries from the TPP log
 
 ### EXAMPLE 1
 ```
-Read-TppLog -Limit 10
+Read-TppLog -First 10
 ```
 
 Get the most recent 10 log items
@@ -183,14 +183,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Limit
+### -First
 Specify the number of items to retrieve, starting with most recent. 
 The default is 100 and there is no maximum.
 
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases:
+Aliases: Limit
 
 Required: False
 Position: Named

docs/functions/Set-TppPermission.md

@@ -38,7 +38,7 @@ Permission a user/group on an object specified by path
 
 ### EXAMPLE 3
 ```
-$id = Find-TppIdentity -Name 'brownstein' | Select-Object -ExpandProperty IdentityId
+$id = Find-TppIdentity -Name 'brownstein' | Select-Object -ExpandProperty Id
 ```
 
 Find-TppObject -Path '\VED' -Recursive | Get-TppPermission -IdentityId $id | Set-TppPermission -Permission $TppPermObject -Force