Skip to content

Commit

Permalink
update function markdown from platyPS
Browse files Browse the repository at this point in the history
  • Loading branch information
@rmbolger
rmbolger committed Sep 13, 2021
1 parent 913e406 commit bcb0a36
Show file tree
Hide file tree
Showing 32 changed files with 45 additions and 64 deletions.
3 changes: 1 addition & 2 deletions docs/Functions/Complete-PAOrder.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Exports cert files for a completed order and adds suggested renewal window to th
## Syntax

```powershell
Complete-PAOrder [[-Order] <PoshACME.PAOrder>] [<CommonParameters>]
Complete-PAOrder [[-Order] <Object>] [<CommonParameters>]
```

## Description
Expand Down Expand Up @@ -55,7 +55,6 @@ 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
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Export-PAAccountKey.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Get-KeyAuthorization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ 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
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/Get-PAAccount.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ Get ACME account details.
## Syntax

### Specific

```powershell
Get-PAAccount [[-ID] <String>] [-Refresh] [-ExtraParams <Object>] [<CommonParameters>]
```

### List

```powershell
Get-PAAccount [-List] [-Status <String>] [-Contact <String[]>] [-KeyLength <String[]>] [-Refresh]
[-ExtraParams <Object>] [<CommonParameters>]
Expand Down Expand Up @@ -177,7 +175,6 @@ 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).
## Outputs
Expand Down
2 changes: 0 additions & 2 deletions docs/Functions/Get-PAAuthorization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ Get-PAOrder | Get-PAAuthorization

Get the authorizations for the current order on the current account.


## Parameters

### -AuthURLs
Expand Down Expand Up @@ -75,7 +74,6 @@ 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
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/Get-PACertificate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ Get ACME certificate details.
## Syntax

### Specific

```powershell
Get-PACertificate [[-MainDomain] <String>] [-Name <String>] [<CommonParameters>]
```

### List

```powershell
Get-PACertificate [-List] [<CommonParameters>]
```
Expand Down Expand Up @@ -105,7 +103,6 @@ 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).
## Outputs
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/Get-PAOrder.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ Get ACME order details.
## Syntax

### Specific

```powershell
Get-PAOrder [[-MainDomain] <String>] [-Name <String>] [-Refresh] [<CommonParameters>]
```

### List

```powershell
Get-PAOrder [-List] [-Refresh] [<CommonParameters>]
```
Expand Down Expand Up @@ -129,7 +127,6 @@ 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).
## Outputs
Expand Down
5 changes: 0 additions & 5 deletions docs/Functions/Get-PAPlugin.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,21 @@ Show plugin details, help, or launch the online guide.
## Syntax

### Basic (Default)

```powershell
Get-PAPlugin [[-Plugin] <String>] [<CommonParameters>]
```

### Params

```powershell
Get-PAPlugin [-Plugin] <String> [-Params] [<CommonParameters>]
```

### Guide

```powershell
Get-PAPlugin [-Plugin] <String> [-Guide] [<CommonParameters>]
```

### Help

```powershell
Get-PAPlugin [-Plugin] <String> [-Help] [<CommonParameters>]
```
Expand Down Expand Up @@ -145,7 +141,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Get-PAPluginArgs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ 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).
## Outputs
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/Get-PAServer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,11 @@ Get ACME server details.
## Syntax

### Specific (Default)

```powershell
Get-PAServer [[-DirectoryUrl] <String>] [-Name <String>] [-Refresh] [-Quiet] [<CommonParameters>]
```

### List

```powershell
Get-PAServer [-List] [-Refresh] [<CommonParameters>]
```
Expand Down Expand Up @@ -145,7 +143,6 @@ 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).
## Outputs
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Install-PACertificate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ 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
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Invoke-HttpChallengeListener.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,6 @@ 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).
## Outputs
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/New-PAAccount.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,13 @@ Create a new account on the current ACME server.
## Syntax

### Generate (Default)

```powershell
New-PAAccount [[-Contact] <String[]>] [[-KeyLength] <String>] [-ID <String>] [-AcceptTOS] [-Force]
[-ExtAcctKID <String>] [-ExtAcctHMACKey <String>] [-ExtAcctAlgorithm <String>] [-UseAltPluginEncryption]
[-ExtraParams <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ImportKey

```powershell
New-PAAccount [[-Contact] <String[]>] -KeyFile <String> [-ID <String>] [-AcceptTOS] [-OnlyReturnExisting]
[-Force] [-ExtAcctKID <String>] [-ExtAcctHMACKey <String>] [-ExtAcctAlgorithm <String>]
Expand Down Expand Up @@ -303,7 +301,6 @@ 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).

## Outputs
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/New-PAAuthorization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ 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
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/New-PACertificate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Request a new certificate
## Syntax

### FromScratch (Default)

```powershell
New-PACertificate [-Domain] <String[]> [-Name <String>] [-Contact <String[]>] [-CertKeyLength <String>]
[-AlwaysNewKey] [-AcceptTOS] [-AccountKeyLength <String>] [-DirectoryUrl <String>] [-Plugin <String[]>]
Expand All @@ -24,7 +23,6 @@ New-PACertificate [-Domain] <String[]> [-Name <String>] [-Contact <String[]>] [-
```

### FromCSR

```powershell
New-PACertificate [-CSRPath] <String> [-Name <String>] [-Contact <String[]>] [-AcceptTOS]
[-AccountKeyLength <String>] [-DirectoryUrl <String>] [-Plugin <String[]>] [-PluginArgs <Hashtable>]
Expand Down Expand Up @@ -476,7 +474,6 @@ 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).

## Outputs
Expand Down
5 changes: 0 additions & 5 deletions docs/Functions/New-PAOrder.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Create a new order on the current ACME account.
## Syntax

### FromScratch (Default)

```powershell
New-PAOrder [-Domain] <String[]> [[-KeyLength] <String>] [-Name <String>] [-Plugin <String[]>]
[-PluginArgs <Hashtable>] [-DnsAlias <String[]>] [-OCSPMustStaple] [-AlwaysNewKey] [-FriendlyName <String>]
Expand All @@ -23,7 +22,6 @@ New-PAOrder [-Domain] <String[]> [[-KeyLength] <String>] [-Name <String>] [-Plug
```

### ImportKey

```powershell
New-PAOrder [-Domain] <String[]> -KeyFile <String> [-Name <String>] [-Plugin <String[]>]
[-PluginArgs <Hashtable>] [-DnsAlias <String[]>] [-OCSPMustStaple] [-AlwaysNewKey] [-FriendlyName <String>]
Expand All @@ -32,7 +30,6 @@ New-PAOrder [-Domain] <String[]> -KeyFile <String> [-Name <String>] [-Plugin <St
```

### FromCSR

```powershell
New-PAOrder [-CSRPath] <String> [-Name <String>] [-Plugin <String[]>] [-PluginArgs <Hashtable>]
[-DnsAlias <String[]>] [-UseSerialValidation] [-DnsSleep <Int32>] [-ValidationTimeout <Int32>]
Expand Down Expand Up @@ -94,7 +91,6 @@ New-PAOrder -CSRPath .\myreq.csr

Create a new order using an externally generated certificate request.


## Parameters

### -Domain
Expand Down Expand Up @@ -439,7 +435,6 @@ 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).

## Outputs
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Publish-Challenge.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ 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).

## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Remove-PAAccount.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Remove-PAOrder.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Remove-PAServer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Revoke-PAAuthorization.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ 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
Expand Down
3 changes: 0 additions & 3 deletions docs/Functions/Revoke-PACertificate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,12 @@ Revoke an ACME certificate
## Syntax

### MainDomain (Default)

```powershell
Revoke-PACertificate [[-MainDomain] <String>] [-Name <String>] [-Reason <RevocationReasons>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### CertFile

```powershell
Revoke-PACertificate -CertFile <String> [-KeyFile <String>] [-Reason <RevocationReasons>] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
Expand Down Expand Up @@ -189,7 +187,6 @@ 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).
## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Save-Challenge.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ 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).

## Related Links
Expand Down
1 change: 0 additions & 1 deletion docs/Functions/Send-ChallengeAck.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ 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
Expand Down
4 changes: 0 additions & 4 deletions docs/Functions/Set-PAAccount.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,18 @@ Set the current ACME account and/or update account details.
## Syntax

### Edit (Default)

```powershell
Set-PAAccount [[-ID] <String>] [[-Contact] <String[]>] [-NewName <String>] [-UseAltPluginEncryption]
[-ResetAltPluginEncryption] [-Deactivate] [-Force] [-NoSwitch] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### RolloverImportKey

```powershell
Set-PAAccount [[-ID] <String>] [-KeyRollover] -KeyFile <String> [-NoSwitch] [-WhatIf] [-Confirm]
[<CommonParameters>]
```

### Rollover

```powershell
Set-PAAccount [[-ID] <String>] [-KeyRollover] [-KeyLength <String>] [-NoSwitch] [-WhatIf] [-Confirm]
[<CommonParameters>]
Expand Down Expand Up @@ -313,7 +310,6 @@ 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).

## Related Links
Expand Down
Loading

0 comments on commit bcb0a36

Please sign in to comment.