Merge pull request Azure#6126 from dragav/preview

adding support for listing pending certificates

Author: cormacpayne

src/ResourceManager/KeyVault/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Current Release
+* Adding support for listing certificates in a pending state
 
 ## Version 5.0.0
 * Breaking changes to support piping scenarios

src/ResourceManager/KeyVault/Commands.KeyVault/Commands.KeyVault.csproj

@@ -91,6 +91,7 @@
     <Compile Include="Commands\UndoAzureKeyVaultKeyRemoval.cs" />
     <Compile Include="Commands\UndoAzureKeyVaultSecretRemoval.cs" />
     <Compile Include="Commands\UpdateAzureKeyVaultSecret.cs" />
+    <Compile Include="Models\KeyVaultCertificateFilterOptions.cs" />
     <Compile Include="Models\ManagedStorageAccounts\PSDeletedKeyVaultManagedStorageAccount.cs" />
     <Compile Include="Models\ManagedStorageAccounts\PSDeletedKeyVaultManagedStorageAccountIdentityItem.cs" />
     <Compile Include="Models\ManagedStorageAccounts\PSDeletedKeyVaultManagedStorageSasDefinition.cs" />

src/ResourceManager/KeyVault/Commands.KeyVault/Commands/GetAzureKeyVaultCertificate.cs

@@ -186,6 +186,20 @@ public class GetAzureKeyVaultCertificate : KeyVaultCmdletBase
                    ParameterSetName = ResourceIdByVaultNameParameterSet,
                    HelpMessage = "Specifies whether to show the previously deleted certificates in the output.")]
         public SwitchParameter InRemovedState { get; set; }
+
+        /// <summary>
+        /// Switch specifying whether to include the pending certificates in the enumeration.
+        /// </summary>
+        [Parameter(Mandatory = false,
+                   ParameterSetName = ByVaultNameParameterSet,
+                   HelpMessage = "Specifies whether to include the pending certificates in the output.")]
+        [Parameter(Mandatory = false,
+                   ParameterSetName = InputObjectByVaultNameParameterSet,
+                   HelpMessage = "Specifies whether to include the pending certificates in the output.")]
+        [Parameter(Mandatory = false,
+                   ParameterSetName = ResourceIdByVaultNameParameterSet,
+                   HelpMessage = "Specifies whether to include the pending certificates in the output.")]
+        public SwitchParameter IncludePending { get; set; }
         #endregion
 
         public override void ExecuteCmdlet()
@@ -241,10 +255,11 @@ public override void ExecuteCmdlet()
 
         private void GetAndWriteCertificates(string vaultName)
         {
-            KeyVaultObjectFilterOptions options = new KeyVaultObjectFilterOptions
+            var options = new KeyVaultCertificateFilterOptions
             {
                 VaultName = VaultName,
-                NextLink = null
+                NextLink = null,
+                IncludePending = IncludePending
             };
 
             do
@@ -272,10 +287,11 @@ private void GetAndWriteCertificatesVersions(string vaultName, string name, stri
 
         private void GetAndWriteDeletedCertificates( string vaultName )
         {
-            KeyVaultObjectFilterOptions options = new KeyVaultObjectFilterOptions
+            var options = new KeyVaultCertificateFilterOptions
             {
                 VaultName = VaultName,
-                NextLink = null
+                NextLink = null,
+                IncludePending = IncludePending
             };
 
             do

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

@@ -85,9 +85,9 @@ public interface IKeyVaultDataServiceClient
 
         PSDeletedKeyVaultCertificate GetDeletedCertificate( string vaultName, string certName );
 
-        IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificates(KeyVaultObjectFilterOptions options);
+        IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificates(KeyVaultCertificateFilterOptions options);
 
-        IEnumerable<PSDeletedKeyVaultCertificateIdentityItem> GetDeletedCertificates( KeyVaultObjectFilterOptions options );
+        IEnumerable<PSDeletedKeyVaultCertificateIdentityItem> GetDeletedCertificates( KeyVaultCertificateFilterOptions options );
 
         IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificateVersions(KeyVaultObjectFilterOptions options);
 

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

@@ -0,0 +1,21 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+namespace Microsoft.Azure.Commands.KeyVault.Models
+{
+    public sealed class KeyVaultCertificateFilterOptions : KeyVaultObjectFilterOptions
+    {
+        public bool? IncludePending { get; set; }
+    }
+}

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

@@ -340,7 +340,7 @@ public PSKeyVaultKey GetKey(string vaultName, string keyName, string keyVersion)
             return new PSKeyVaultKey(keyBundle, this.vaultUriHelper);
         }
 
-        public IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificates(KeyVaultObjectFilterOptions options)
+        public IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificates(KeyVaultCertificateFilterOptions options)
         {
             if (options == null)
                 throw new ArgumentNullException(nameof(options));
@@ -355,7 +355,7 @@ public IEnumerable<PSKeyVaultCertificateIdentityItem> GetCertificates(KeyVaultOb
                 IPage<CertificateItem> result;
 
                 if (string.IsNullOrEmpty(options.NextLink))
-                    result = this.keyVaultClient.GetCertificatesAsync(vaultAddress).GetAwaiter().GetResult();
+                    result = this.keyVaultClient.GetCertificatesAsync(vaultAddress, maxresults: null, includePending: options.IncludePending).GetAwaiter().GetResult();
                 else
                     result = this.keyVaultClient.GetCertificatesNextAsync(options.NextLink).GetAwaiter().GetResult();
 
@@ -1667,7 +1667,7 @@ public PSDeletedKeyVaultCertificate GetDeletedCertificate( string vaultName, str
             return new PSDeletedKeyVaultCertificate(deletedCertificate);
         }
 
-        public IEnumerable<PSDeletedKeyVaultCertificateIdentityItem> GetDeletedCertificates( KeyVaultObjectFilterOptions options )
+        public IEnumerable<PSDeletedKeyVaultCertificateIdentityItem> GetDeletedCertificates( KeyVaultCertificateFilterOptions options )
         {
             if ( options == null )
                 throw new ArgumentNullException( nameof( options ) );
@@ -1681,7 +1681,7 @@ public IEnumerable<PSDeletedKeyVaultCertificateIdentityItem> GetDeletedCertifica
                 IPage<DeletedCertificateItem> result;
 
                 if ( string.IsNullOrEmpty( options.NextLink ) )
-                    result = this.keyVaultClient.GetDeletedCertificatesAsync( vaultAddress ).GetAwaiter( ).GetResult( );
+                    result = this.keyVaultClient.GetDeletedCertificatesAsync( vaultAddress, maxresults: null, includePending: options.IncludePending ).GetAwaiter( ).GetResult( );
                 else
                     result = this.keyVaultClient.GetDeletedCertificatesNextAsync( options.NextLink ).GetAwaiter( ).GetResult( );
 

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

@@ -16,7 +16,7 @@ Gets a certificate from a key vault.
 ### ByName (Default)
 ```
 Get-AzureKeyVaultCertificate [-VaultName] <String> [[-Name] <String>] [-InRemovedState]
- [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+ [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### ByCertificateNameAndVersion
@@ -34,7 +34,7 @@ Get-AzureKeyVaultCertificate [-VaultName] <String> [-Name] <String> [-IncludeVer
 ### ByNameInputObject
 ```
 Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [[-Name] <String>] [-InRemovedState]
- [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+ [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### ByCertificateNameAndVersionInputObject
@@ -52,7 +52,7 @@ Get-AzureKeyVaultCertificate [-InputObject] <PSKeyVault> [-Name] <String> [-Incl
 ### ByNameResourceId
 ```
 Get-AzureKeyVaultCertificate [-ResourceId] <String> [[-Name] <String>] [-InRemovedState]
- [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
+ [-IncludePending] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
 ```
 
 ### ByCertificateNameAndVersionResourceId
@@ -252,6 +252,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -IncludePending
+Specifies whether to include pending certificates in the output
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: ByName, ByNameInputObject, ByNameResourceId
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+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).