Partner cmdlet feature update (#249)

Author: Isaiah Williams

CHANGELOG.md

@@ -20,6 +20,15 @@
 
 # Change Log
 
+## Upcoming Release
+
+* Authentication
+  * Addressed an issue where NullReferenceException exception was being encountered when invoking [Connect-PartnerCenter](https://docs.microsoft.com/powershell/module/partnercenter/Connect-PartnerCenter) using a certificate
+  * Addressed an issue where NullReferenceException exception was being encountered when invoking [New-PartnerAccessToken](https://docs.microsoft.com/powershell/module/partnercenter/New-PartnerAccessToken) using a certificate
+  * Defined the refresh token parameter set for the [New-PartnerAccessToken](https://docs.microsoft.com/powershell/module/partnercenter/New-PartnerAccessToken) command to make it easier to ensure all the appropriate parameters have been specified when exchanging a refresh token for an access token
+* Module
+  * All commands now perform operations asynchronously
+
 ## 3.0.3 - December 2019
 
 * Authentication

docs/help/Connect-PartnerCenter.md

@@ -28,9 +28,8 @@ Connect-PartnerCenter -AccessToken <String> [-Environment <EnvironmentName>] [-T
 
 ### RefreshToken
 ```powershell
-Connect-PartnerCenter -ApplicationId <String> [-CertificateThumbprint <String>] [-Credential <PSCredential>]
- [-Environment <EnvironmentName>] -RefreshToken <String> [-Tenant <String>] [-WhatIf] [-Confirm]
- [<CommonParameters>]
+Connect-PartnerCenter -ApplicationId <String> [-Credential <PSCredential>] [-Environment <EnvironmentName>]
+ -RefreshToken <String> [-Tenant <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ServicePrincipalCertificate
@@ -122,18 +121,6 @@ Accept wildcard characters: False
 ### -CertificateThumbprint
 Certificate Hash (Thumbprint)
 
-```yaml
-Type: String
-Parameter Sets: RefreshToken
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ```yaml
 Type: String
 Parameter Sets: ServicePrincipalCertificate

docs/help/Get-PartnerCustomerUser.md

@@ -16,14 +16,19 @@ Gets a list of all customer users or a specified user for the tenant.
 
 ### ByCustomerId (Default)
 ```powershell
-Get-PartnerCustomerUser [-CustomerId] <String> [-ReturnDeletedUsers] [<CommonParameters>]
+Get-PartnerCustomerUser [-CustomerId] <String> [<CommonParameters>]
 ```
 
 ### ByUserId
 ```powershell
 Get-PartnerCustomerUser [-CustomerId] <String> -UserId <String> [<CommonParameters>]
 ```
 
+### ByUserState
+```powershell
+Get-PartnerCustomerUser [-CustomerId] <String> [-ReturnDeletedUsers] [<CommonParameters>]
+```
+
 ### ByUpn
 ```powershell
 Get-PartnerCustomerUser [-CustomerId] <String> -UserPrincipalName <String> [<CommonParameters>]
@@ -77,10 +82,10 @@ Specifies whether to show deleted users.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: ByCustomerId
+Parameter Sets: ByUserState
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False

docs/help/Get-PartnerInvoiceLineItem.md

@@ -40,7 +40,7 @@ The billing provide for the line items.
 Type: BillingProvider
 Parameter Sets: (All)
 Aliases:
-Accepted values: All, Azure, Office, OneTime, Marketplace
+Accepted values: All, Azure, Marketplace, Office, OneTime
 
 Required: True
 Position: Named

docs/help/New-PartnerAccessToken.md

@@ -17,33 +17,37 @@ Acquires an access token from Azure Active Directory.
 ### AccessToken
 ```powershell
 New-PartnerAccessToken -AccessToken <String> -ApplicationId <String> [-Credential <PSCredential>]
- [-Environment <EnvironmentName>] [-RefreshToken <String>] -Scopes <String[]> [-Tenant <String>]
- [-UseAuthorizationCode] [<CommonParameters>]
+ [-Environment <EnvironmentName>] -Scopes <String[]> [-Tenant <String>] [<CommonParameters>]
+```
+
+### RefreshToken
+```powershell
+New-PartnerAccessToken [-ApplicationId <String>] [-Credential <PSCredential>] [-Environment <EnvironmentName>]
+ [-Module <ModuleName>] -RefreshToken <String> -Scopes <String[]> [-ServicePrincipal] [-Tenant <String>]
+ [<CommonParameters>]
 ```
 
 ### ServicePrincipal
 ```powershell
 New-PartnerAccessToken -ApplicationId <String> -Credential <PSCredential> [-Environment <EnvironmentName>]
- [-RefreshToken <String>] -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode]
- [<CommonParameters>]
+ -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode] [<CommonParameters>]
 ```
 
 ### ServicePrincipalCertificate
 ```powershell
 New-PartnerAccessToken -ApplicationId <String> -CertificateThumbprint <String> [-Environment <EnvironmentName>]
- [-RefreshToken <String>] -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode]
- [<CommonParameters>]
+ -Scopes <String[]> [-ServicePrincipal] -Tenant <String> [-UseAuthorizationCode] [<CommonParameters>]
 ```
 
 ### User
 ```powershell
-New-PartnerAccessToken -ApplicationId <String> [-Environment <EnvironmentName>] [-RefreshToken <String>]
- -Scopes <String[]> [-Tenant <String>] [-UseAuthorizationCode] [-UseDeviceAuthentication] [<CommonParameters>]
+New-PartnerAccessToken -ApplicationId <String> [-Environment <EnvironmentName>] -Scopes <String[]>
+ [-Tenant <String>] [-UseAuthorizationCode] [-UseDeviceAuthentication] [<CommonParameters>]
 ```
 
 ### ByModule
 ```powershell
-New-PartnerAccessToken [-Environment <EnvironmentName>] -Module <ModuleName> [-RefreshToken <String>]
+New-PartnerAccessToken [-Environment <EnvironmentName>] -Module <ModuleName> -Scopes <String[]>
  [-Tenant <String>] [-UseAuthorizationCode] [<CommonParameters>]
 ```
 
@@ -103,6 +107,18 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+```yaml
+Type: String
+Parameter Sets: RefreshToken
+Aliases: ClientId
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -CertificateThumbprint
 Certificate Hash (Thumbprint)
 
@@ -123,7 +139,7 @@ Credentials that represents the service principal.
 
 ```yaml
 Type: PSCredential
-Parameter Sets: AccessToken
+Parameter Sets: AccessToken, RefreshToken
 Aliases:
 
 Required: False
@@ -164,6 +180,19 @@ Accept wildcard characters: False
 ### -Module
 The module that an access token is being generated.
 
+```yaml
+Type: ModuleName
+Parameter Sets: RefreshToken
+Aliases: ModuleName
+Accepted values: ExchangeOnline
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ```yaml
 Type: ModuleName
 Parameter Sets: ByModule
@@ -182,10 +211,10 @@ The refresh token to use during authentication.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: RefreshToken
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -197,7 +226,7 @@ Scopes requested to access a protected API.
 
 ```yaml
 Type: String[]
-Parameter Sets: AccessToken, ServicePrincipal, ServicePrincipalCertificate, User
+Parameter Sets: (All)
 Aliases:
 
 Required: True
@@ -212,10 +241,10 @@ Indicates that this account authenticates by providing service principal credent
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: ServicePrincipal
+Parameter Sets: RefreshToken, ServicePrincipalCertificate
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -224,10 +253,10 @@ Accept wildcard characters: False
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: ServicePrincipalCertificate
+Parameter Sets: ServicePrincipal
 Aliases:
 
-Required: False
+Required: True
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -239,7 +268,7 @@ The identifier of the Azure AD tenant.
 
 ```yaml
 Type: String
-Parameter Sets: AccessToken, User, ByModule
+Parameter Sets: AccessToken, RefreshToken, User, ByModule
 Aliases: Domain, TenantId
 
 Required: False
@@ -266,7 +295,7 @@ Use the authorization code flow during authentication.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: (All)
+Parameter Sets: ServicePrincipal, ServicePrincipalCertificate, User, ByModule
 Aliases: AuthCode
 
 Required: False

src/PowerShell/Authenticators/AccessTokenAuthenticator.cs

@@ -4,8 +4,6 @@
 namespace Microsoft.Store.PartnerCenter.PowerShell.Authenticators
 {
     using System;
-    using System.Linq;
-    using System.Management.Automation;
     using System.Security.Claims;
     using System.Threading;
     using System.Threading.Tasks;
@@ -32,16 +30,7 @@ internal class AccessTokenAuthenticator : DelegatingAuthenticator
         public override async Task<AuthenticationResult> AuthenticateAsync(AuthenticationParameters parameters, CancellationToken cancellationToken = default)
         {
             JsonWebToken token;
-            string value;
-
-            if (parameters.Scopes.Contains($"{parameters.Environment.PartnerCenterEndpoint}/user_impersonation"))
-            {
-                value = parameters.Account.GetProperty(PartnerAccountPropertyType.AccessToken);
-            }
-            else
-            {
-                throw new PSInvalidOperationException("This operation is not supported when you connect using an access token. Please connect interactively or using a refresh token.");
-            }
+            string value = parameters.Account.GetProperty(PartnerAccountPropertyType.AccessToken);
 
             token = new JsonWebToken(value);
 

src/PowerShell/Commands/AddPartnerCustomerCartLineItem.cs

@@ -9,15 +9,17 @@ namespace Microsoft.Store.PartnerCenter.PowerShell.Commands
     using System.Management.Automation;
     using System.Text.RegularExpressions;
     using Extensions;
+    using Models.Authentication;
     using Models.Carts;
     using PartnerCenter.Models.Carts;
     using Properties;
 
     /// <summary>
     /// Adds a cart line item to the specified cart.
     /// </summary>
-    [Cmdlet(VerbsCommon.Add, "PartnerCustomerCartLineItem", SupportsShouldProcess = true), OutputType(typeof(PSCart))]
-    public class AddPartnerCustomerCartLineItem : PartnerCmdlet
+    [Cmdlet(VerbsCommon.Add, "PartnerCustomerCartLineItem", SupportsShouldProcess = true)]
+    [OutputType(typeof(PSCart))]
+    public class AddPartnerCustomerCartLineItem : PartnerAsyncCmdlet
     {
         /// <summary>
         /// Gets or sets the required cart identifier.
@@ -45,24 +47,29 @@ public class AddPartnerCustomerCartLineItem : PartnerCmdlet
         /// </summary>
         public override void ExecuteCmdlet()
         {
-            Cart cart;
-            CartLineItem cartLineItem;
-            List<CartLineItem> lineItems;
-
-            if (ShouldProcess(string.Format(CultureInfo.CurrentCulture, Resources.AddPartnerCustomerCartLineItemWhatIf, CartId)))
+            Scheduler.RunTask(async () =>
             {
-                cart = Partner.Customers[CustomerId].Carts[CartId].GetAsync().ConfigureAwait(false).GetAwaiter().GetResult();
-                lineItems = cart.LineItems.ToList();
+                Cart cart;
+                CartLineItem cartLineItem;
+                List<CartLineItem> lineItems;
+
+                if (ShouldProcess(string.Format(CultureInfo.CurrentCulture, Resources.AddPartnerCustomerCartLineItemWhatIf, CartId)))
+                {
+                    IPartner partner = await PartnerSession.Instance.ClientFactory.CreatePartnerOperationsAsync(CorrelationId, CancellationToken).ConfigureAwait(false);
+
+                    cart = await partner.Customers[CustomerId].Carts[CartId].GetAsync(CancellationToken).ConfigureAwait(false);
+                    lineItems = cart.LineItems.ToList();
 
-                cartLineItem = new CartLineItem();
-                cartLineItem.CopyFrom(LineItem);
+                    cartLineItem = new CartLineItem();
+                    cartLineItem.CopyFrom(LineItem);
 
-                lineItems.Add(cartLineItem);
+                    lineItems.Add(cartLineItem);
 
-                cart = Partner.Customers[CustomerId].Carts[CartId].PutAsync(cart).GetAwaiter().GetResult();
+                    cart = await partner.Customers[CustomerId].Carts[CartId].PutAsync(cart, CancellationToken).ConfigureAwait(false);
 
-                WriteObject(new PSCart(cart));
-            }
+                    WriteObject(new PSCart(cart));
+                }
+            }, true);
         }
     }
 }