Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[KeyVault] Doc update about SAN certificate #12785

Merged
merged 2 commits into from
Aug 28, 2020
Merged

[KeyVault] Doc update about SAN certificate #12785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99c8feb
Update help message for DnsName; add an example
isra-fel Aug 27, 2020
6479def
Format
isra-fel Aug 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/KeyVault/KeyVault/Commands/NewAzureKeyVaultCertificatePolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public class NewAzureKeyVaultCertificatePolicy : KeyVaultCmdletBase
Position = 1,
ParameterSetName = DNSNamesParameterSet,
ValueFromPipelineByPropertyName = true,
HelpMessage = "Specifies the DNS names in the certificate.")]
HelpMessage = "Specifies the DNS names in the certificate. Subject Alternative Names (SANs) can be specified as DNS names.")]
[Alias("DnsNames")]
public List<string> DnsName { get; set; }

Expand Down
32 changes: 31 additions & 1 deletion src/KeyVault/KeyVault/help/New-AzKeyVaultCertificatePolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,36 @@ Creates an in-memory certificate policy object. (autogenerated)
New-AzKeyVaultCertificatePolicy -IssuerName 'Self' -KeyType RSA -RenewAtNumberOfDaysBeforeExpiry <Int32> -SecretContentType application/x-pkcs12 -SubjectName 'CN=contoso.com' -ValidityInMonths 6
```

### Example 3: Create a Subject Alternate Name (or SAN) certificate

```powershell
PS C:\> New-AzKeyVaultCertificatePolicy -SecretContentType "application/x-pkcs12" -SubjectName "CN=contoso.com" -DnsName "contoso.com","support.contoso.com","docs.contoso.com" -IssuerName "Self"

SecretContentType : application/x-pkcs12
Kty : RSA
KeySize : 2048
Curve :
Exportable :
ReuseKeyOnRenewal : False
SubjectName : CN=contoso.com
DnsNames : {contoso.com, support.contoso.com, docs.contoso.com}
KeyUsage :
Ekus :
ValidityInMonths :
IssuerName : Self
CertificateType :
RenewAtNumberOfDaysBeforeExpiry :
RenewAtPercentageLifetime :
EmailAtNumberOfDaysBeforeExpiry :
EmailAtPercentageLifetime :
CertificateTransparency :
Enabled : True
Created :
Updated :
```

This example creates a SAN certificate with 3 DNS names.

## PARAMETERS

### -CertificateTransparency
Expand Down Expand Up @@ -165,7 +195,7 @@ Accept wildcard characters: False
```

### -DnsName
Specifies the DNS names in the certificate.
Specifies the DNS names in the certificate. Subject Alternative Names (SANs) can be specified as DNS names.

```yaml
Type: System.Collections.Generic.List`1[System.String]
Expand Down