Update manifest and docs to 3.3.0 ***NO_CI***

Venafi · Nov 1, 2021 · 8d2b687 · 8d2b687
1 parent eeae3db
commit 8d2b687
Show file tree

Hide file tree

Showing 6 changed files with 303 additions and 65 deletions.
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Greg Brownstein
 #
-# Generated on: 10/1/2021
+# Generated on: 11/1/2021
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '3.3'
+ModuleVersion = '3.3.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -69,26 +69,27 @@ PowerShellVersion = '5.1'
 # NestedModules = @()
 
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
-FunctionsToExport = 'Add-TppCertificateAssociation', 'ConvertTo-TppGuid',
-               'ConvertTo-TppPath', 'Export-VenafiCertificate',
-               'Find-TppCertificate', 'Find-TppCodeSignEnvironment',
-               'Find-TppCodeSignProject', 'Find-TppCodeSignTemplate',
-               'Find-TppIdentity', 'Find-TppObject', 'Get-TppAttribute',
-               'Get-TppCodeSignConfig', 'Get-TppCodeSignEnvironment',
-               'Get-TppCodeSignProject', 'Get-TppCustomField', 'Get-TppIdentity',
-               'Get-TppIdentityAttribute', 'Get-TppObject', 'Get-TppPermission',
-               'Get-TppSystemStatus', 'Get-TppVersion', 'Get-TppWorkflowTicket',
-               'Get-VaasApplication', 'Get-VaasOrgUnit', 'Get-VenafiCertificate',
-               'Import-TppCertificate', 'Invoke-TppCertificatePush',
-               'Invoke-TppCertificateRenewal', 'Invoke-VenafiRestMethod',
-               'Move-TppObject', 'New-TppCapiApplication', 'New-TppCertificate',
-               'New-TppCodeSignProject', 'New-TppDevice', 'New-TppObject',
-               'New-TppPolicy', 'New-TppToken', 'New-VenafiSession', 'Read-TppLog',
-               'Remove-TppCertificate', 'Remove-TppCertificateAssociation',
-               'Remove-TppCodeSignEnvironment', 'Remove-TppCodeSignProject',
-               'Remove-TppPermission', 'Rename-TppObject', 'Revoke-TppCertificate',
-               'Revoke-TppToken', 'Set-TppAttribute', 'Set-TppCodeSignProjectStatus',
-               'Set-TppPermission', 'Set-TppWorkflowTicketStatus', 'Test-ModuleHash',
+FunctionsToExport = 'Add-TppCertificateAssociation', 'ConvertTo-TppGuid', 
+               'ConvertTo-TppPath', 'Export-VenafiCertificate', 
+               'Find-TppCertificate', 'Find-TppCodeSignEnvironment', 
+               'Find-TppCodeSignProject', 'Find-TppCodeSignTemplate', 
+               'Find-TppIdentity', 'Find-TppObject', 'Get-TppAttribute', 
+               'Get-TppClassAttribute', 'Get-TppCodeSignConfig', 
+               'Get-TppCodeSignEnvironment', 'Get-TppCodeSignProject', 
+               'Get-TppCustomField', 'Get-TppIdentity', 'Get-TppIdentityAttribute', 
+               'Get-TppObject', 'Get-TppPermission', 'Get-TppSystemStatus', 
+               'Get-TppVersion', 'Get-TppWorkflowTicket', 'Get-VaasApplication', 
+               'Get-VaasOrgUnit', 'Get-VenafiCertificate', 'Import-TppCertificate', 
+               'Invoke-TppCertificatePush', 'Invoke-TppCertificateRenewal', 
+               'Invoke-VenafiRestMethod', 'Move-TppObject', 'New-TppCapiApplication', 
+               'New-TppCertificate', 'New-TppCodeSignProject', 'New-TppDevice', 
+               'New-TppObject', 'New-TppPolicy', 'New-TppToken', 'New-VenafiSession', 
+               'Read-TppLog', 'Remove-TppCertificate', 
+               'Remove-TppCertificateAssociation', 'Remove-TppCodeSignEnvironment', 
+               'Remove-TppCodeSignProject', 'Remove-TppPermission', 
+               'Rename-TppObject', 'Revoke-TppCertificate', 'Revoke-TppToken', 
+               'Set-TppAttribute', 'Set-TppCodeSignProjectStatus', 
+               'Set-TppPermission', 'Set-TppWorkflowTicketStatus', 'Test-ModuleHash', 
                'Test-TppIdentity', 'Test-TppObject', 'Test-TppToken', 'Write-TppLog'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,7 @@
+## 3.3.0
+- Add support for local token/key storage with [PowerShell SecretManagement](https://devblogs.microsoft.com/powershell/secretmanagement-and-secretstore-are-generally-available/).  Store your access or refresh token securely and have VenafiPS use it to create a new session.
+- Add `Get-TppClassAttribute` to list all attributes for a specific class.  Helpful for attribute validation and getting values for all attributes.
+
 ## 3.2.0
 - Add support for token refresh to `New-VenafiSession` and `New-TppToken`.  Auto-refresh $VenafiSession when token expires and we have a refresh token.  [#33](https://github.com/gdbarron/VenafiPS/issues/33)
 - Fix invalid grant details in `Test-TppToken`, [#32](https://github.com/gdbarron/VenafiPS/issues/32)

diff --git a/docs/functions/Get-TppAttribute.md b/docs/functions/Get-TppAttribute.md
@@ -5,21 +5,14 @@ Get attributes for a given object
 
 ## SYNTAX
 
-### ByObject (Default)
+### ByPath (Default)
 ```
-Get-TppAttribute -InputObject <TppObject> [-Attribute <String[]>] [-VenafiSession <VenafiSession>]
- [<CommonParameters>]
-```
-
-### EffectiveByObject
-```
-Get-TppAttribute -InputObject <TppObject> -Attribute <String[]> [-Effective] [-VenafiSession <VenafiSession>]
- [<CommonParameters>]
+Get-TppAttribute -Path <String[]> [-Attribute <String[]>] [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
-### ByPath
+### AllByPath
 ```
-Get-TppAttribute -Path <String[]> [-Attribute <String[]>] [-VenafiSession <VenafiSession>] [<CommonParameters>]
+Get-TppAttribute -Path <String[]> [-VenafiSession <VenafiSession>] [<CommonParameters>]
 ```
 
 ### EffectiveByPath
@@ -70,34 +63,19 @@ Retrieve all the value for attribute driver name from certificate myapp.company.
 
 ## PARAMETERS
 
-### -InputObject
-TppObject which represents a unique object
-
-```yaml
-Type: TppObject
-Parameter Sets: ByObject, EffectiveByObject
-Aliases:
-
-Required: True
-Position: Named
-Default value: None
-Accept pipeline input: True (ByValue)
-Accept wildcard characters: False
-```
-
 ### -Path
 Path to the object to retrieve configuration attributes. 
 Just providing DN will return all attributes.
 
 ```yaml
 Type: String[]
-Parameter Sets: ByPath, EffectiveByPath
+Parameter Sets: ByPath, AllByPath, EffectiveByPath
 Aliases: DN
 
 Required: True
 Position: Named
 Default value: None
-Accept pipeline input: True (ByValue)
+Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
@@ -122,7 +100,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: String[]
-Parameter Sets: ByObject, ByPath, ByGuid
+Parameter Sets: ByPath, ByGuid
 Aliases:
 
 Required: False
@@ -134,7 +112,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: String[]
-Parameter Sets: EffectiveByObject, EffectiveByPath, EffectiveByGuid
+Parameter Sets: EffectiveByPath, EffectiveByGuid
 Aliases:
 
 Required: True
@@ -149,7 +127,7 @@ Get the effective values of the attribute
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: EffectiveByObject, EffectiveByPath, EffectiveByGuid
+Parameter Sets: EffectiveByPath, EffectiveByGuid
 Aliases: EffectivePolicy
 
 Required: True
@@ -180,7 +158,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### InputObject, Path, Guid
+### Path, Guid
 ## OUTPUTS
 
 ### PSCustomObject with properties Name, Value, IsCustomField, and CustomName

diff --git a/docs/functions/Get-TppClassAttribute.md b/docs/functions/Get-TppClassAttribute.md
@@ -0,0 +1,67 @@
+# Get-TppClassAttribute
+
+## SYNOPSIS
+List all attributes for a specified class
+
+## SYNTAX
+
+```
+Get-TppClassAttribute [-ClassName] <String> [[-VenafiSession] <VenafiSession>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+List all attributes for a specified class, helpful for validation or to pass to Get-TppAttribute
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-TppClassAttribute -ClassName 'X509 Server Certificate'
+```
+
+Get all attributes for the specified class
+
+## PARAMETERS
+
+### -ClassName
+{{ Fill ClassName Description }}
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -VenafiSession
+{{ Fill VenafiSession Description }}
+
+```yaml
+Type: VenafiSession
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: $script:VenafiSession
+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).
+
+## INPUTS
+
+### ClassName
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS