Add-AzureAnalysisServicesAccount to support login with Service Principal #4389

liangyong79 · 2017-07-31T20:34:21Z

( both using password and certificate )

Description

This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

I have read the contribution guidelines.
If changes were made to any cmdlet, the XML help was regenerated using the platyPSHelp module.
If any large changes are made to a service, they are reflected in the respective change log.

General Guidelines

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

Pull request includes test coverage for the included changes.
PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

( both using password and certificate )

msftclas · 2017-07-31T20:34:25Z

@liangyong79,
Thanks for your contribution as a Microsoft full-time employee or intern. You do not need to sign a CLA.
Thanks,
Microsoft Pull Request Bot

azuresdkci · 2017-07-31T20:35:15Z

Can one of the admins verify this patch?

cormacpayne · 2017-08-01T22:42:04Z

@azuresdkci add to whitelist

cormacpayne

@liangyong79 a few minor comments. Also, please add tests for this new functionality so we can catch future regressions. You can view the Profile login tests for examples of how to test this functionality.

cormacpayne · 2017-08-02T20:58:39Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

+        private const string ServicePrincipalWithCertificateParameterSet = "ServicePrincipalWithCertificateParameterSetName";
+
+        [Parameter(ParameterSetName = UserParameterSet,
+            Mandatory = true, HelpMessage = "Name of the Azure Analysis Services environment to which to logon to", Position = 0)]


@liangyong79 RolloutEnvironment is being changed from optional to mandatory, which is a breaking change. Please make sure the parameters (RolloutEnvironment and Credential) in the previous parameter set have the same attributes in UserParameterSet as they did in the old one.

Actually this RolloutEnvironment is required even in previous version, they just forget to mark it as required.

I don't think this is true. You can log in currently as a user without this

cormacpayne · 2017-08-02T21:02:39Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

+            Mandatory = true)]
+        [Parameter(ParameterSetName = ServicePrincipalWithCertificateParameterSet,
+            Mandatory = true)]
+        public SwitchParameter ServicePrincipal { get; set; }


@liangyong79 this parameter doesn't seem to provide any value since the presence of TenantId, ApplicationId or CertificateThumbprint signify that you using one of the ServicePrincipal parameter sets

It will make it clear that ServicePrincipal will be used, and also the other Add-AzureRmAccount used the same parameter for SPN: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/add-azurermaccount?view=azurermps-4.2.0

cormacpayne · 2017-08-02T21:04:57Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

@@ -33,14 +33,49 @@ namespace Microsoft.Azure.Commands.AnalysisServices.Dataplane
    [OutputType(typeof(AsAzureProfile))]
    public class AddAzureASAccountCommand : AzurePSCmdlet, IModuleAssemblyInitializer
    {
-        [Parameter(Position = 0, Mandatory = false, HelpMessage = "Name of the Azure Analysis Services environment to which to logon to")]


@liangyong79 now that there are multiple parameter sets used in this cmdlet, there will need to be a DefaultParameterSetName defined at the top (inside of the Cmdlet attribute). I would recommend using UserParameterSet as the default.

cormacpayne · 2017-08-02T22:11:48Z

...nalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md

@@ -32,12 +45,38 @@ This example will add the account specified by the $UserCredential variable to t

 ## PARAMETERS

+### -ApplicationId
+SPN```yaml


@liangyong79 please make sure that the ```yaml strings appear on a line by themselves so the markdown gets rendered properly. You can look at the Credential parameter below for an example.

This change should be made for all parameters with this issue in this file.

Also, can we change "SPN" to be a more meaningful description?

cormacpayne · 2017-08-02T22:12:18Z

...nalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md

@@ -62,6 +113,34 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```

+### -ServicePrincipal
+{{Fill ServicePrincipal Description}}


@liangyong79 please fill out this description if you decide to keep this parameter

markcowl · 2017-08-03T00:41:07Z

...lysisServices/Commands.AnalysisServices.Dataplane/Commands.AnalysisServices.Dataplane.csproj

@@ -129,6 +129,10 @@
      <Project>{70527617-7598-4aef-b5bd-db9186b8184b}</Project>
      <Name>Commands.Common.Authentication.Abstractions</Name>
    </ProjectReference>
+    <ProjectReference Include="..\..\..\Common\Commands.Common.Authentication\Commands.Common.Authentication.csproj">


This is problematic. Since you are using ADAL directly, you should not include a dependency on this library. This will cause problems when the ADAL library is updted in the runtime.

…hell into preview

markcowl · 2017-08-03T03:40:34Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

@@ -123,6 +173,7 @@ public void OnImport()
        {
            try
            {
+                AzureSessionInitializer.InitializeAzureSession();


Do not add this - this potentially causes problems for all Azure RM modules, because you are taking chanreg of injecting depednencies used by all modules. If your cmdlet needs to use AzureSession, then it shoudl use the existing authentication mechanism. If it does not, then it should not initialize it.

The base class AzurePSCmdlet.BeginProcessing() call SetupDebuggingTraces(), which call DebugStreamTraceListener.AddAdalTracing( ), and AddAdalTracing( ) require that AzureSession.Instance not be null:

public static void AddAdalTracing(DebugStreamTraceListener listener)
{
AzureSession.Instance.AuthenticationTraceListeners.Add(listener);
AzureSession.Instance.AuthenticationTraceSourceLevel = SourceLevels.All;
}

…ands.Common.Authentication library

liangyong79

Addressed the review comments, please take a look again.

liangyong79 · 2017-08-02T22:59:42Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

+            Mandatory = true)]
+        [Parameter(ParameterSetName = ServicePrincipalWithCertificateParameterSet,
+            Mandatory = true)]
+        public SwitchParameter ServicePrincipal { get; set; }


It will make it clear that ServicePrincipal will be used, and also the other Add-AzureRmAccount used the same parameter for SPN: https://docs.microsoft.com/en-us/powershell/module/azurerm.profile/add-azurermaccount?view=azurermps-4.2.0

liangyong79 · 2017-08-03T17:27:16Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

@@ -123,6 +173,7 @@ public void OnImport()
        {
            try
            {
+                AzureSessionInitializer.InitializeAzureSession();


The base class AzurePSCmdlet.BeginProcessing() call SetupDebuggingTraces(), which call DebugStreamTraceListener.AddAdalTracing( ), and AddAdalTracing( ) require that AzureSession.Instance not be null:

public static void AddAdalTracing(DebugStreamTraceListener listener)
{
AzureSession.Instance.AuthenticationTraceListeners.Add(listener);
AzureSession.Instance.AuthenticationTraceSourceLevel = SourceLevels.All;
}

markcowl · 2017-08-04T20:45:56Z

...ceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/Commands/AddAzureASAccount.cs

+        private const string ServicePrincipalWithCertificateParameterSet = "ServicePrincipalWithCertificateParameterSetName";
+
+        [Parameter(ParameterSetName = UserParameterSet,
+            Mandatory = true, HelpMessage = "Name of the Azure Analysis Services environment to which to logon to", Position = 0)]


I don't think this is true. You can log in currently as a user without this

…eter as before for UserParameterSet.

markcowl · 2017-08-04T23:26:25Z

on demand run here: http://azuresdkci.cloudapp.net/job/powershell-demand/1817/

taiwu · 2017-08-05T00:22:58Z

According to the log, the build failed due to no work space for the build.

markcowl · 2017-08-05T01:37:17Z

@azuresdkci retest this please

markcowl · 2017-08-05T01:38:05Z

new on demand: http://azuresdkci.cloudapp.net/job/powershell-demand/1818/

All comments addressed

liangyong79 · 2017-08-05T03:03:08Z

Ondemand build 1818 passed. :)

Add-AzureAnalysisServicesAccount to support login with Service Principal

0b28baf

( both using password and certificate )

msftclas added the cla-not-required label Jul 31, 2017

Merge branch 'preview' into preview

3c7cb8f

azuresdkci added the needs-review label Jul 31, 2017

azuresdkci assigned shahabhijeet Jul 31, 2017

cormacpayne assigned markcowl and cormacpayne and unassigned shahabhijeet Aug 2, 2017

cormacpayne previously requested changes Aug 2, 2017

View reviewed changes

cormacpayne added needs-revision and removed needs-review labels Aug 2, 2017

cormacpayne assigned liangyong79 and unassigned markcowl and cormacpayne Aug 2, 2017

markcowl requested changes Aug 3, 2017

View reviewed changes

liangyong79 added 2 commits August 2, 2017 19:39

Address review comments - update help file and add test

c71d4c4

Merge branch 'preview' of https://github.com/liangyong79/azure-powers…

1670ff4

…hell into preview

markcowl requested changes Aug 3, 2017

View reviewed changes

Address review comments 2 - remove dependency to Microsoft.Azure.Comm…

47535ea

…ands.Common.Authentication library

liangyong79 commented Aug 4, 2017

View reviewed changes

cormacpayne changed the base branch from preview to release-4.3.0 August 4, 2017 16:03

markcowl approved these changes Aug 4, 2017

View reviewed changes

markcowl requested changes Aug 4, 2017

View reviewed changes

Address review comments 3 - Mark RolloutEnvironment as optional param…

b1345f2

…eter as before for UserParameterSet.

markcowl approved these changes Aug 4, 2017

View reviewed changes

markcowl added the Waiting for On Demand label Aug 4, 2017

markcowl removed the needs-revision label Aug 4, 2017

markcowl merged commit 497a8de into Azure:release-4.3.0 Aug 5, 2017

Add-AzureAnalysisServicesAccount to support login with Service Principal #4389

Add-AzureAnalysisServicesAccount to support login with Service Principal #4389

Uh oh!

Conversation

liangyong79 commented Jul 31, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

msftclas commented Jul 31, 2017

Uh oh!

azuresdkci commented Jul 31, 2017

Uh oh!

cormacpayne commented Aug 1, 2017

Uh oh!

cormacpayne 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!

liangyong79 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!

markcowl commented Aug 4, 2017

Uh oh!

taiwu commented Aug 5, 2017

Uh oh!

markcowl commented Aug 5, 2017

Uh oh!

markcowl commented Aug 5, 2017

Uh oh!

liangyong79 commented Aug 5, 2017

Uh oh!

Uh oh!

liangyong79 commented Jul 31, 2017 •

edited by azuresdkci

Loading