Update manifest and docs to 4.4.0

Venafi · May 25, 2022 · 354daf1 · 354daf1
1 parent 97b24c3
commit 354daf1
Show file tree

Hide file tree

Showing 9 changed files with 416 additions and 101 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 4.4.0
+- Add `New-VaasApplication` to create a new application on VaaS
+- Add `Get-VaasIssuingTemplate` to retrieve 1 or all certificate issuing templates on VaaS
+- Add `-All` parameter to `Get-VaasApplication` to retrieve all applications
+- Deprecate `Get-VaasOrgUnit` as it's being deprecated by VaaS
+
+
 ## 4.3.0
 - Add new output format for `Get-TppAttribute` using the parameter `-New`.  Attributes will now be provided as object properties as opposed to individual objects for each property, which made it difficult to retrieve the value itself.  This new format is available for all ways of using the function including attribute, effective attribute, and policy retrieval.  This new format will become the default in the future.
 - Add `Get-TppAttribute -PolicyClass -All` to retrieve all policy attributes at once
@@ -371,3 +378,4 @@
 
 
 
+
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 05/12/2022
+# Generated on: 05/25/2022
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '4.4'
+ModuleVersion = '4.4.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,10 @@
+## 4.4.0
+- Add `New-VaasApplication` to create a new application on VaaS
+- Add `Get-VaasIssuingTemplate` to retrieve 1 or all certificate issuing templates on VaaS
+- Add `-All` parameter to `Get-VaasApplication` to retrieve all applications
+- Deprecate `Get-VaasOrgUnit` as it's being deprecated by VaaS
+
+
 ## 4.3.0
 - Add new output format for `Get-TppAttribute` using the parameter `-New`.  Attributes will now be provided as object properties as opposed to individual objects for each property, which made it difficult to retrieve the value itself.  This new format is available for all ways of using the function including attribute, effective attribute, and policy retrieval.  This new format will become the default in the future.
 - Add `Get-TppAttribute -PolicyClass -All` to retrieve all policy attributes at once
@@ -371,3 +378,4 @@
 
 
 
+
diff --git a/docs/functions/Get-VaasApplication.md b/docs/functions/Get-VaasApplication.md
@@ -5,14 +5,14 @@ Get application info
 
 ## SYNTAX
 
-### All (Default)
+### ID (Default)
 ```
-Get-VaasApplication [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-VaasApplication -ID <Guid> [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
-### Id
+### All
 ```
-Get-VaasApplication -ApplicationId <Guid> [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-VaasApplication [-All] [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -23,25 +23,27 @@ Venafi as a Service only, not for TPP.
 
 ### EXAMPLE 1
 ```
-Get-VaasApplication
-Get info for all applications
+Get-VaasApplication -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2'
 ```
 
+Get info for a specific application
+
 ### EXAMPLE 2
 ```
-Get-VaasApplication -ApplicationId 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2'
-Get info for a specific application
+Get-VaasApplication -All
 ```
 
+Get info for all applications
+
 ## PARAMETERS
 
-### -ApplicationId
+### -ID
 Id to get info for a specific application
 
 ```yaml
 Type: Guid
-Parameter Sets: Id
-Aliases:
+Parameter Sets: ID
+Aliases: applicationId
 
 Required: True
 Position: Named
@@ -50,11 +52,25 @@ Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
+### -All
+Get all applications
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: All
+Aliases:
+
+Required: True
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -VenafiSession
 Authentication for the function.
 The value defaults to the script session object $VenafiSession created by New-VenafiSession.
-A TPP token or VaaS key can also provided.
-If providing a TPP token, an environment variable named TppServer must also be set.
+A VaaS key can also provided.
 
 ```yaml
 Type: PSObject
@@ -73,10 +89,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### ApplicationId
+### ID
 ## OUTPUTS
 
 ### PSCustomObject
 ## NOTES
 
 ## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasApplication/](http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasApplication/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasApplication.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasApplication.ps1)
+
+[https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Applications/applications_getAll](https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Applications/applications_getAll)
+
+[https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Applications/applications_getById](https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Applications/applications_getById)
+
diff --git a/docs/functions/Get-VaasIssuingTemplate.md b/docs/functions/Get-VaasIssuingTemplate.md
@@ -0,0 +1,103 @@
+# Get-VaasIssuingTemplate
+
+## SYNOPSIS
+Get issuing templates
+
+## SYNTAX
+
+### ID (Default)
+```
+Get-VaasIssuingTemplate -ID <Guid> [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+### All
+```
+Get-VaasIssuingTemplate [-All] [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get info for either a specific template or all templates.
+Venafi as a Service only, not for TPP.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-VaasIssuingTemplate -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2'
+```
+
+Get info for a specific template
+
+### EXAMPLE 2
+```
+Get-VaasIssuingTemplate -All
+```
+
+Get info for all templates
+
+## PARAMETERS
+
+### -ID
+Id to get info for a specific template
+
+```yaml
+Type: Guid
+Parameter Sets: ID
+Aliases: certificateIssuingTemplateId
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -All
+Get all templates
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: All
+Aliases:
+
+Required: True
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -VenafiSession
+Authentication for the function.
+The value defaults to the script session object $VenafiSession created by New-VenafiSession.
+A VaaS key can also provided.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+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
+
+### ID
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasIssuingTemplate/](http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasIssuingTemplate/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasIssuingTemplate.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasIssuingTemplate.ps1)
+
diff --git a/docs/functions/Get-VaasOrgUnit.md b/docs/functions/Get-VaasOrgUnit.md
diff --git a/docs/functions/Get-VenafiIdentity.md b/docs/functions/Get-VenafiIdentity.md
@@ -114,8 +114,7 @@ Accept wildcard characters: False
 ```
 
 ### -All
-Return a complete list of users. 
-VaaS only.
+Return a complete list of local users.
 
 ```yaml
 Type: SwitchParameter