Fix Output, Parameters, and Piping for KeyVault cmdlets

[markcowl]

Description

Work with KeyVault team to update KeyVault cmdlets to make the following changes. In this release, we want to identify proposed cmdlet changes, present these to the KeyVautl team, and make the changes ourselves, or in coordination with them.

We want to normalize the cmdlets in the following ways.

• Correctly specify output type
• Enumerate collections
• Take piepline input as appropriate
  • Get-AzureRmKeyVault | Get-AzureKeyVaultSecret
  • Get-AzureKeyVaultSecret | Get-AzureKeyVaultSecret
• Accept pipeline input using object parameter set
• Accept pipeline input using resourceid parameter set (control plane only)
• Accept multiple instances as well as single instances for parameters that specify a resource.

Additionally we need to:

• Ensure all cmdlets are covered by tests
• Ensure all tests are passing with the new changes and skipped tests are fixed and rerecorded
• All documentation is updated and all examples/help messages are updated or fixed

[maddieclayton]

General

• Fix all documentation and update examples
• Add "PS" prefix to PSObjects
• Set defaultparameterset for all cmdlets with multiple parameter sets
• Reorder parameters to make the most sense
• Convert from ProcessRecord to ExecuteCmdlet
• Remove default case for ParameterSetName in Switch blocks (impossible)
• Remove duplicate parameter set attributes
• Why are there different output types for lists and single objects, and will this affect piping?

Non-breaking Changes

Add-AzureKeyVaultCertificate

• **Fix piping for: New-AzureKeyVaultCertificatePolicy | Add-AzureKeyVaultCertificate
• Add mandatory attribute to -CertificatePolicy

Add-AzureKeyVaultCertificateContact

• Add piping scenarios: Get-AzureRmKeyVault | Add-AzureKeyVaultCertificateContact, Get-AzureRmResource | Add-AzureKeyVaultCertificateContact
• Fix WriteObject to use WriteObject(object, true) for list
• Change "EmailAddress" from string to string[] to allow multiple emails to be added at once
• Improve help message for PassThru

Add-AzureKeyVaultKey

• Add piping scenarios: Get-AzureRmKeyVault | Add-AzureKeyVaultKey
• Add position to mandatory parameters

Backup-AzureKeyVaultKey

• Add piping scenarios: Get-AzureRmKeyVaultKey | Backup-AzureKeyVaultKey (might just be renaming "KeyBundle" and creating an alias)

Backup-AzureKeyVaultSecret

• Add piping scenarios: Get-AzureRmKeyVaultSecret | Backup-AzureKeyVaultSecret (might just be renaming "Secret" and creating an alias)

Get-AzureRmKeyVault

• Set defaultparameterset
• Fix positions

Get-AzureKeyVaultCertificate

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultCertificate
• Combine parameter sets

Get-AzureKeyVaultCertificateContact

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultCertificateContact, Get-AzureRmResource | Get-AzureKeyVaultCertificateContact

Get-AzureKeyVaultCertificateIssuer

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultCertificateIssuer, Get-AzureRmResource | Get-AzureKeyVaultCertificateIssuer
• Combine existing two parameter sets into one parameter set where -Name is optional.

Get-AzureKeyVaultCertificateOperation (will be removed in breaking change release)

• Add piping scenarios: Get-AzureRmKeyVaultCertificate | Get-AzureKeyVaultCertificateOperation

Get-AzureKeyVaultCertificatePolicy

• Add piping scenarios: Get-AzureRmKeyVaultCertificate | Get-AzureKeyVaultCertificatePolicy

Get-AzureKeyVaultKey

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultKey, Get-AzureRmResource | Get-AzureKeyVaultKey
• Combine parameter sets

Get-AzureKeyVaultSecret

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultSecret, Get-AzureRmResource | Get-AzureKeyVaultSecret
• Combine parameter sets

Import-AzureKeyVaultCertificate

• Remove unnecessary parameter set
• Add alias from CertificateCollection to InputObject
• Add position to mandatory parameters

New-AzureRmKeyVault

• Change VaultName to Name and add alias

New-AzureKeyVaultCertificateAdministratorDetails

• Explicitly call out that parameters are not Mandatory

New-AzureKeyVaultCertificateOrganizationDetails

• Fix piping
• Explicitly call out that parameters are not Mandatory

New-AzureKeyVaultCertificatePolicy

• Explicitly call out that parameters are not Mandatory
• Make parameter sets so we can get rid of all the ArgumentExceptions (parameter set will take care of this validation).
• Get rid of all the other validations that I can through validateset/range
• Update documentation to include links to things that are validated

Remove-AzureRmKeyVault

• Add piping scenarios: Get-AzureRmKeyVault | Remove-AzureKeyVault

Remove-AzureRmKeyVaultAccessPolicy

• Add piping scenarios: Get-AzureRmKeyVault | Remove-AzureKeyVaultAccessPolicy
• Change switchparameter names to be more logical ("DisableDeployment") and add alias

Remove-AzureKeyVaultCertificate

• Add piping scenarios: Get-AzureKeyVaultCertificate | Remove-AzureKeyVaultCertificate

Remove-AzureKeyVaultCertificateContact

• Is it possible to remove all contacts from a KeyVault?
• Accept multiple emails

Remove-AzureKeyVaultCertificateIssuer

• Add piping scenarios: Get-AzureKeyVaultCertificateIssuer | Remove-AzureKeyVaultCertificateIssuer

Remove-AzureKeyVaultCertificateOperation

Remove-AzureKeyVaultKey

• Add piping scenarios: Get-AzureKeyVaultKey | Remove-AzureKeyVaultKey

Remove-AzureKeyVaultSecret

• Add piping scenarios: Get-AzureKeyVaultSecret | Remove-AzureKeyVaultSecret

Restore-AzureKeyVaultKey

• Add piping scenarios: Get-AzureKeyVault | Restore-AzureKeyVaultKey, Get-AzureRmResource | Restore-AzureKeyVaultKey
• Accept multiple input files

Restore-AzureKeyVaultSecret

• Add piping scenarios: Get-AzureKeyVault | Restore-AzureKeyVaultSecret, Get-AzureRmResource | Restore-AzureKeyVaultSecret
• Accept multiple input files

Set-AzureRmKeyVaultAccessPolicy

• Add piping scenarios: Get-AzureKeyVault | Set-AzureRmKeyVaultAccessPolicy, Get-AzureRmResource | Set-AzureRmKeyVaultAccessPolicy

Set-AzureKeyVaultCertificateAttribute

• Add piping scenarios: Get-AzureKeyVaultCertificate | Set-AzureKeyVaultCertificateAttribute

Set-AzureKeyVaultCertificateIssuer

• Add piping scenarios: Get-AzureRmKeyVault | Set-AzureKeyVaultCertificateIssuer

Set-AzureKeyVaultCertificatePolicy

• Rename certificate object to InputObject and add alias
• Remove validation where possible and add ValidateRange

Set-AzureKeyVaultKeyAttribute

• Add piping scenarios: Get-AzureKeyVaultKey | Set-AzureKeyVaultKey

Set-AzureKeyVaultSecret

• Add piping scenarios: Get-AzureKeyVaultSecret | Set-AzureKeyVaultSecret

Set-AzureKeyVaultSecretAttribute

• Add piping scenarios: Get-AzureKeyVaultSecret | Set-AzureKeyVaultSecretAttribute

Stop-AzureKeyVaultCertificateOperation (will be removed at breaking change release)

• Add piping scenarios: Get-AzureKeyVaultCertificateOperation | Stop-AzureKeyVaultCertificateOperation

Undo-AzureKeyVaultCertificateRemoval

• Add piping scenarios: Get-AzureKeyVaultCertificate | Undo-AzureKeyVaultCertificateRemoval

Undo-AzureKeyVaultKeyRemoval

• Add piping scenarios: Get-AzureKeyVaultKey | Undo-AzureKeyVaultKeyRemoval

Undo-AzureRmKeyVaultRemoval

• Add piping scenarios: Get-AzureRmKeyVault | Undo-AzureRmKeyVaultRemoval

Undo-AzureKeyVaultSecretRemoval

• Add piping scenarios: Get-AzureKeyVaultSecret | Undo-AzureKeyVaultSecretRemoval

---

Add-AzureKeyVaultManagedStorageAccount

• Add piping scenarios: Get-AzureRmStorageAccount | Add-AzureKeyVaultManagedStorageAccount, Get-AzureRmResource | Add-AzureKeyVaultManagedStorageAccount
• Have an interactive scenario that does not require ResourceId

Get-AzureKeyVaultManagedStorageAccount

• Add piping scenarios: Get-AzureRmKeyVault | Get-AzureKeyVaultManagedStorageAccount, Get-AzureRmResource | Get-AzureKeyVaultManagedStorageAccount
• Combine two parameter sets into one where -AccountName is optional

Get-AzureKeyVaultManagedStorageSasDefinition

• Add piping scenarios: Get-AzureKeyVaultManagedStorageAccount | Get-AzureKeyVaultManagedStorageSasDefinition
• Combine two parameter sets into one where -Name is optional

Remove-AzureKeyVaultManagedStorageAccount

• Add piping scenarios: Get-AzureKeyVaultManagedStorageAccount | Remove-AzureKeyVaultManagedStorageAccount

Remove-AzureKeyVaultManagedStorageSasDefinition

• Add piping scenarios: Get-AzureKeyVaultManagedStorageSasDefinition | Remove-AzureKeyVaultManagedStorageSasDefinition

Set-AzureKeyVaultManagedStorageSasDefinition

• Add piping scenarios?
• Remove unnecessary parameter sets
• Reorder parameters to make more sense

Update-AzureKeyVaultManagedStorageAccount

• Add piping scenarios: Get-AzureKeyVaultManagedStorageAccount | Update-AzureKeyVaultManagedStorageAccount

Update-AzureKeyVaultManagedStorageAccountKey

• Add piping scenarios: Get-AzureKeyVaultManagedStorageAccountKey | Update-AzureKeyVaultManagedStorageAccount
• Is this the best name for the cmdlet?

[maddieclayton]

Breaking Changes

General

• Remove ConfirmImpact (possibly add shouldcontinue in its place)
• Remove ValueFromPipelineByPropertyName where necessary to enable piping
• Add missing piping scenarios

Add-AzureKeyVaultCertificate

• Make policy mandatory as cmdlet fails without it.

New-AzureRmKeyVault

• Add AsJob and make call synchronous

Set-AzureRmKeyVaultAccessPolicy

• Remove "all" from validateset

Set-AzureKeyVaultCertificateIssuer

• Make issuerprovider required, as parameter set will fail without it

Set-AzureKeyVaultSecretAttribute

• Delete, make Set-AzureKeyVaultSecret have -SecureValue as optional

Undo-AzureKeyVaultCertificateRemove

• Change type to PSType