Update KeyVault documentation #6308

maddieclayton · 2018-05-25T20:32:39Z

Description

#6215
#6034

Checklist

I have read the Submitting Changes section of CONTRIBUTING.md
The title of the PR is clear and informative
The appropriate change log has been updated
The PR does not introduce breaking changes
If applicable, the changes made in the PR have proper test coverage
For public API changes to cmdlets:
- the changes have gone through a cmdlet design review
- the cmdlet markdown files were generated using the platyPS module

RandalliLama

This is awesome. Thanks for doing this.

RandalliLama · 2018-05-29T16:31:55Z

src/ResourceManager/KeyVault/Commands.KeyVault/Models/PSDeletedKeyVaultCertificate.cs

@@ -67,7 +67,7 @@ internal PSDeletedKeyVaultCertificate(DeletedCertificateBundle deletedCertificat

            if (deletedCertificateBundle.Tags != null)
            {
-                Tags = (Hashtable) deletedCertificateBundle.Tags;
+                Tags = (deletedCertificateBundle.Tags == null) ? null : deletedCertificateBundle.Tags.ConvertToHashtable();


Why is the check for null necessary here? This code is already wrapped in a check for null.

You're right - reverted. It was the cast that was failing.

RandalliLama · 2018-05-29T16:33:07Z

src/ResourceManager/KeyVault/Commands.KeyVault/Models/PSDeletedKeyVaultCertificate.cs

@@ -123,7 +123,7 @@ internal PSDeletedKeyVaultCertificate(DeletedCertificateBundle deletedCertificat

            if (deletedCertificateBundle.Tags != null)
            {
-                Tags = (Hashtable) deletedCertificateBundle.Tags;
+                Tags = (deletedCertificateBundle.Tags == null) ? null : deletedCertificateBundle.Tags.ConvertToHashtable();


Check for null on this line is unnecessary.

RandalliLama · 2018-05-29T16:38:59Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md

-```
-PS C:\>Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
+```powershell
+PS C:\Users\username\> Backup-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'


Why was the path changed from root of the drive to a users directory for this example, but not the others in this file?

I wanted to demonstrate the the file created would be placed in the current directory, which I thought wasn't shown too well by just using the root. If you want me to revert this and just mention in the comment that the output file is put in the current directory, I can do that as well.

I was just curious. I don't have any objections.

RandalliLama · 2018-05-29T16:43:36Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md

-PS C:\>Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'
+```powershell
+PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
+PS C:\> Backup-AzureKeyVaultSecret -InputObject $secret -OutputFile 'C:\Backup.blob'


I see that Secret is just an alias for InputObject, but why is it better to use InputObject in the example. Isn't that going to be harder for the user to remember and grok? If this is necessary for some reason, are there alternatives such as swapping the alias with the proper name?

I'll change back to "Secret"

…nto kvdoc

…o kvdoc

cormacpayne · 2018-05-29T17:08:05Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md

@@ -174,8 +178,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

 ## INPUTS

-### None
-This cmdlet does not accept any input.
+### System.String


@maddieclayton shouldn't this be Microsoft.Azure.Commands.KeyVault.Models.PSKeyVault (from InputObject)?

cormacpayne · 2018-05-29T17:09:30Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md

@@ -230,11 +261,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## INPUTS

 ### None
-This cmdlet does not accept any input.


@maddieclayton any reason to remove this text?

I didn't think it added more value than "None"

cormacpayne · 2018-05-29T17:11:20Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md

 CancellationRequested     : False
 CertificateSigningRequest : MIICpjCCAY4CAQAwFjEUMBIGA1UEAxMLY29udG9zby5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC73w3VRBOlgJ5Od1PjDh+2ytngNZp+ZP4fkuX8K1Ti5LA6Ih7eWx1fgAN/iTb6l
                            5K6LvAIJvsTNVePMNxfSdaEIJ70Inm45wVU4A/kf+UxQWAYVMsBrLtDFWxnVhzf6n7RGYke6HLBj3j5ASb9g+olSs6eON25ibF0t+u6JC+sIR0LmVGar9Q0eZys1rdfzJBIKq+laOM7z2pJijb5ANqve9
                            i7rH5mnhQk4V8WsRstOhYR9jgLqSSxokDoeaBClIOidSBYqVc1yNv4ASe1UWUCR7ZK6OQXiecNWSWPmgWEyawu6AR9eb1YotCr2ScheMOCxlm3103luitxrd8A7kMjAgMBAAGgSzBJBgkqhkiG9w0BCQ4
                            xPDA6MA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAIHhsDJV37PKi8hor5eQf7+Tct1preIvSwqV0NF6Uo7O6
                            YnC9Py7Wp7CHfKzuqeptUk2Tsu7B5dHB+o9Ypeeqw8fWhTN0GFGRKO7WjZQlDqL+lRNcjlFSaP022oIP0kmvVhBcmZqRQlALXccAaxEclFA/3y/aNj2gwWeKpH/pwAkZ39zMEzpQCaRfnQk7e3l4MV8cf
                            eC2HPYdRWkXxAeDcNPxBuVmKy49AzYvly+APNVDU3v66gxl3fIKrGRsKi2Cp/nO5rBxG2h8t+0Za4l/HJ7ZWR9wKbd/xg7JhdZZFVBxMHYzw8KQ0ys13x8HY+PXU92Y7yD3uC2Rcj+zbAf+Kg==
-ErrorCode                 : 
+                            ==


@maddieclayton is this line needed?

cormacpayne · 2018-05-29T17:15:03Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md

 ```

-This command removes Patti Fuller as a certificate contact for the Contoso01 key vault.
+This command removes Patti Fuller as a certificate contact for the Contoso01 key vault.  If PassThru is specified, the cmdlet returns the list of remaining certificate contacts.


@maddieclayton just making sure, but is the above output correct even though the user didn't provide PassThru?

Good catch, added -PassThru

RandalliLama · 2018-05-29T19:51:12Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultCertificate.md

-PS C:\>Backup-AzureKeyVaultCertificate -Certificate $cert -OutputFile 'C:\Backup.blob' -Force
+```powershell
+PS C:\> $cert = Get-AzureKeyVaultCertificate -VaultName 'MyKeyVault' -Name 'MyCert'
+PS C:\> Backup-AzureKeyVaultCertificate -InputObject $cert -OutputFile 'C:\Backup.blob' -Force


Should InputObject we changed back to Certificate here?

RandalliLama · 2018-05-29T19:51:36Z

src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md

-PS C:\>Backup-AzureKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force
+```powershell
+PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
+PS C:\> Backup-AzureKeyVaultKey -InputObject $key -OutputFile 'C:\Backup.blob' -Force


Change back to Key?

RandalliLama · 2018-05-29T19:52:02Z

...ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultManagedStorageAccount.md

-PS C:\>Backup-AzureKeyVaultManagedStorageAccount -StorageAccount $msak -OutputFile 'C:\Backup.blob' -Force
+```powershell
+PS C:\> $msak = Get-AzureKeyVaultManagedStorageAccount -VaultName 'MyKeyVault' -Name 'MyMSAK'
+PS C:\> Backup-AzureKeyVaultManagedStorageAccount -InputObject $msak -OutputFile 'C:\Backup.blob' -Force


Change back to StorageAccount?

maddieclayton · 2018-05-29T23:11:08Z

@RandalliLama Addressed the three comments - if this is looking good to you, I will target it for the release going out on Tuesday morning.

RandalliLama · 2018-05-30T00:27:31Z

maddieclayton added 5 commits May 23, 2018 12:57

add docs

a7f9025

more changes

476f4fe

fix keyvault docs

1d318f1

fixes

acaecd6

update changelog

6672c8a

maddieclayton added the needs-review label May 25, 2018

maddieclayton assigned RandalliLama, cormacpayne and dragav May 25, 2018

azuresdkci added the needs-review label May 25, 2018

maddieclayton added 2 commits May 25, 2018 15:38

fix build

4f0146c

Update Restore-AzureKeyVaultManagedStorageAccount.md

89c7ef0

RandalliLama reviewed May 29, 2018

View reviewed changes

RandalliLama requested a review from schaabs May 29, 2018 16:48

RandalliLama unassigned dragav May 29, 2018

maddieclayton added 4 commits May 29, 2018 09:57

address comments

a5b0e61

Merge branch 'preview' of https://github.com/Azure/azure-powershell i…

96b1093

…nto kvdoc

Merge branch 'kvdoc' of github.com:maddieclayton/azure-powershell int…

b802da1

…o kvdoc

add exception

97d6337

cormacpayne suggested changes May 29, 2018

View reviewed changes

maddieclayton added 2 commits May 29, 2018 10:54

address comments

fe514ec

fix issues

f748d14

RandalliLama reviewed May 29, 2018

View reviewed changes

cormacpayne previously approved these changes May 29, 2018

View reviewed changes

cormacpayne removed their assignment May 29, 2018

Update Backup-AzureKeyVaultCertificate.md

66d2b53

maddieclayton dismissed cormacpayne’s stale review via 66d2b53 May 29, 2018 23:08

Update Backup-AzureKeyVaultKey.md

2f26321

Update Backup-AzureKeyVaultManagedStorageAccount.md

4164e20

RandalliLama removed the request for review from schaabs May 30, 2018 00:27

RandalliLama approved these changes May 30, 2018

View reviewed changes

maddieclayton changed the base branch from preview to release-6.2.0 May 30, 2018 00:30

maddieclayton added Waiting for CI and removed needs-review labels May 30, 2018

maddieclayton assigned maddieclayton and unassigned RandalliLama May 30, 2018

maddieclayton merged commit bd1f44b into Azure:release-6.2.0 May 30, 2018

maddieclayton deleted the kvdoc branch May 30, 2018 03:04

Update KeyVault documentation #6308

Update KeyVault documentation #6308

Uh oh!

Conversation

maddieclayton commented May 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

RandalliLama left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maddieclayton commented May 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RandalliLama commented May 30, 2018

Uh oh!

Uh oh!

maddieclayton commented May 25, 2018 •

edited

Loading

maddieclayton commented May 29, 2018 •

edited

Loading