Update manifest and docs to 5.2.2

Venafi · Nov 30, 2022 · 47457fc · 47457fc
1 parent 575beb7
commit 47457fc
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 5.2.2
+- Add specific event webhook subscription, not just types, and criticality option to `New-VaasConnector`
+- Fix `Get-TppObject` returning invalid parent path, [#166](https://github.com/Venafi/VenafiPS/issues/166)
+- Fix `Get-VenafiCertificate -All` not paging through all results, [#164](https://github.com/Venafi/VenafiPS/issues/164)
+- Update `Remove-TppCertificate` and `Remove-TppCertificateAssociation` to align with latest `Get-TppAttribute` changes, [#168](https://github.com/Venafi/VenafiPS/issues/168)
+
+
 ## 5.2.1
 - Fix `Set-TppAttribute` not setting integer values, [#145](https://github.com/Venafi/VenafiPS/issues/145)
 - Fix `New-VenafiSession` sending null header for windows integrated authentication, [#162](https://github.com/Venafi/VenafiPS/issues/162)
@@ -480,5 +487,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 11/08/2022
+# Generated on: 11/30/2022
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.2.1'
+ModuleVersion = '5.2.2'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,10 @@
+## 5.2.2
+- Add specific event webhook subscription, not just types, and criticality option to `New-VaasConnector`
+- Fix `Get-TppObject` returning invalid parent path, [#166](https://github.com/Venafi/VenafiPS/issues/166)
+- Fix `Get-VenafiCertificate -All` not paging through all results, [#164](https://github.com/Venafi/VenafiPS/issues/164)
+- Update `Remove-TppCertificate` and `Remove-TppCertificateAssociation` to align with latest `Get-TppAttribute` changes, [#168](https://github.com/Venafi/VenafiPS/issues/168)
+
+
 ## 5.2.1
 - Fix `Set-TppAttribute` not setting integer values, [#145](https://github.com/Venafi/VenafiPS/issues/145)
 - Fix `New-VenafiSession` sending null header for windows integrated authentication, [#162](https://github.com/Venafi/VenafiPS/issues/162)
@@ -480,5 +487,6 @@
 
 
 
+
 
 
diff --git a/docs/functions/New-VaasConnector.md b/docs/functions/New-VaasConnector.md
@@ -5,9 +5,16 @@ Create a new connector
 
 ## SYNTAX
 
+### EventName (Default)
 ```
-New-VaasConnector [-Name] <String> [-Url] <String> [-EventType] <String[]> [[-Token] <PSCredential>]
- [-PassThru] [[-VenafiSession] <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
+New-VaasConnector -Name <String> -Url <String> -EventName <String[]> [-Secret <String>] [-CriticalOnly]
+ [-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+### EventType
+```
+New-VaasConnector -Name <String> -Url <String> -EventType <String[]> [-Secret <String>] [-CriticalOnly]
+ [-PassThru] [-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -20,7 +27,7 @@ Create a new connector
 New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventType 'Authentication'
 ```
 
-Create a new connector
+Create a new connector for one event type
 
 ### EXAMPLE 2
 ```
@@ -31,13 +38,28 @@ Create a new connector with multiple event types
 
 ### EXAMPLE 3
 ```
-New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventType 'Authentication' -Token $myTokenCred
+New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventName 'Certificate Validation Started'
 ```
 
-Create a new connector with optional token
+Create a new connector with event names as opposed to event types.
+This will result in fewer messages received as opposed to subscribing at the event type level.
 
 ### EXAMPLE 4
 ```
+New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventType 'Certificates' -CriticalOnly
+```
+
+Subscribe to critical messages only for a specific event type
+
+### EXAMPLE 5
+```
+New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventType 'Authentication' -Secret 'MySecret'
+```
+
+Create a new connector with optional secret
+
+### EXAMPLE 6
+```
 New-VaasConnector -Name 'MyConnector' -Url 'https://my.com/endpoint' -EventType 'Authentication' -PassThru
 ```
 
@@ -54,22 +76,23 @@ Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 1
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
 ### -Url
-Endpoint to be called when the event type is triggered
+Endpoint to be called when the event type/name is triggered.
+This should be the full url and will be validated during connector creation.
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -81,32 +104,61 @@ You can retrieve a list of possible values from the Event Log and filtering on E
 
 ```yaml
 Type: String[]
-Parameter Sets: (All)
+Parameter Sets: EventType
 Aliases:
 
 Required: True
-Position: 3
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -Token
-Token/secret to pass to Url for authentication.
-Set the token as the password on a pscredential.
+### -EventName
+One or more event names to trigger on.
 
 ```yaml
-Type: PSCredential
-Parameter Sets: (All)
+Type: String[]
+Parameter Sets: EventName
 Aliases:
 
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Secret
+Secret value used to calculate signature which will be sent to the endpoint in the header
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: token
+
 Required: False
-Position: 4
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -CriticalOnly
+Only subscribe to log messages deemed as critical
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -PassThru
 Return newly created connector object
 
@@ -133,7 +185,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 5
+Position: Named
 Default value: $script:VenafiSession
 Accept pipeline input: False
 Accept wildcard characters: False