Update IdentifierUris of ADApp and DisplayName of ADServicePrincipal (#…

…14952) * Update AAD SDK and add missing attributes. * Add exception * Update code * Update code * Update IdentifierUris * update code
Azure · May 12, 2021 · 2281c88 · 2281c88
1 parent cdb2ed1
commit 2281c88
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 66 deletions.
diff --git a/src/Resources/Resources/ActiveDirectory/Cmdlets/NewAzureADApplicationCommand.cs b/src/Resources/Resources/ActiveDirectory/Cmdlets/NewAzureADApplicationCommand.cs
@@ -13,7 +13,6 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.WindowsAzure.Commands.Common;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Management.Automation;
@@ -40,19 +39,19 @@ public class NewAzureADApplicationCommand : ActiveDirectoryBaseCmdlet
         [ValidateNotNullOrEmpty]
         public string DisplayName { get; set; }
 
-        [CmdletParameterBreakingChange("IdentifierUris", ChangeDescription = "The value will be considered valid only if it exists as a verified domain in a tenant.")]
-        [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithoutCredential,
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithoutCredential,
             HelpMessage = "The URIs that identify the application.")]
-        [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithPasswordPlain,
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithPasswordPlain,
             HelpMessage = "The URIs that identify the application.")]
-        [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithPasswordCredential,
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithPasswordCredential,
             HelpMessage = "The URIs that identify the application.")]
-        [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyPlain,
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyPlain,
             HelpMessage = "The URIs that identify the application.")]
-        [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyCredential,
+        [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithKeyCredential,
             HelpMessage = "The URIs that identify the application.")]
         [ValidateNotNullOrEmpty]
-        public string[] IdentifierUris { get; set; }
+        [Alias("IdentifierUris")]
+        public string[] IdentifierUri { get; set; }
 
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationWithoutCredential,
             HelpMessage = "The URL to the applicationâ€™s homepage.")]
@@ -140,7 +139,7 @@ public override void ExecuteCmdlet()
             {
                 DisplayName = DisplayName,
                 HomePage = HomePage,
-                IdentifierUris = IdentifierUris,
+                IdentifierUris = (IdentifierUri == null) ? new string[] { } : IdentifierUri,
                 ReplyUrls = ReplyUrls,
                 AvailableToOtherTenants = AvailableToOtherTenants
             };

diff --git a/src/Resources/Resources/ActiveDirectory/Cmdlets/NewAzureADServicePrincipalCommand.cs b/src/Resources/Resources/ActiveDirectory/Cmdlets/NewAzureADServicePrincipalCommand.cs
@@ -16,12 +16,10 @@
 using Microsoft.Azure.Commands.Resources.Models;
 using Microsoft.Azure.Commands.Resources.Models.Authorization;
 using Microsoft.WindowsAzure.Commands.Common;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Management.Automation;
-using System.Security;
-using System.Threading;
+using System.Web;
 using ProjectResources = Microsoft.Azure.Commands.Resources.Properties.Resources;
 
 namespace Microsoft.Azure.Commands.ActiveDirectory
@@ -48,7 +46,6 @@ public class NewAzureADServicePrincipalCommand : ActiveDirectoryBaseCmdlet
         [Parameter(Mandatory = false, ParameterSetName = SimpleParameterSet, HelpMessage = "The application id for which service principal is created.")]
         public Guid ApplicationId { get; set; }
 
-        [CmdletParameterBreakingChange("DisplayName", ChangeDescription = "DisplayName is used as the IdentifierUri of created application. The value will be considered valid only if it exists as a verified domain in a tenant.")]
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.DisplayNameWithoutCredential,
             HelpMessage = "The display name for the application.")]
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.DisplayNameWithPasswordPlain,
@@ -59,8 +56,7 @@ public class NewAzureADServicePrincipalCommand : ActiveDirectoryBaseCmdlet
             HelpMessage = "The display name for the application.")]
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.DisplayNameWithKeyCredential,
             HelpMessage = "The display name for the application.")]
-        [Parameter(Mandatory = false, ParameterSetName = SimpleParameterSet, HelpMessage = "The display name for the application. If a display name is not provided, " +
-            "this value will default to 'azure-powershell-MM-dd-yyyy-HH-mm-ss', where the suffix is the time of application creation.")]
+        [Parameter(Mandatory = false, ParameterSetName = SimpleParameterSet, HelpMessage = "The display name for the service principal is derived from the IdentifierUris of created application.")]
         [ValidateNotNullOrEmpty]
         public string DisplayName { get; set; }
 
@@ -196,15 +192,17 @@ public override void ExecuteCmdlet()
 
                 if (ApplicationId == Guid.Empty)
                 {
-                    string uri = "http://" + DisplayName.Trim().Replace(' ', '_');
+
 
                     // Create an application and get the applicationId
-                    CreatePSApplicationParameters appParameters = new CreatePSApplicationParameters
+                    CreatePSApplicationParameters appParameters = new CreatePSApplicationParameters();
+
+                    if(this.IsParameterBound(c => c.DisplayName) && !string.IsNullOrEmpty(DisplayName))
                     {
-                        DisplayName = DisplayName,
-                        IdentifierUris = new[] { uri },
-                        HomePage = uri
-                    };
+                        string uri = "http://" + HttpUtility.UrlEncode(DisplayName.Trim());
+                        appParameters.IdentifierUris = new string[] { };
+                        appParameters.DisplayName = DisplayName;
+                    }
 
                     if (this.IsParameterBound(c => c.PasswordCredential))
                     {
@@ -271,8 +269,6 @@ private void CreateSimpleServicePrincipal()
                 WriteVerbose(string.Format("No display name provided - using the default display name of '{0}'", DisplayName));
             }
 
-            var identifierUri = "http://" + DisplayName;
-
             bool printPassword = false;
             bool printUseExistingSecret = true;
 
@@ -286,8 +282,7 @@ private void CreateSimpleServicePrincipal()
                 CreatePSApplicationParameters appParameters = new CreatePSApplicationParameters
                 {
                     DisplayName = DisplayName,
-                    IdentifierUris = new[] { identifierUri },
-                    HomePage = identifierUri,
+                    HomePage = "http://" + HttpUtility.UrlEncode(DisplayName.Trim()),
                     PasswordCredentials = new PSADPasswordCredential[]
                     {
                         new PSADPasswordCredential()

diff --git a/src/Resources/Resources/ActiveDirectory/Cmdlets/UpdateAzureADApplicationCommand.cs b/src/Resources/Resources/ActiveDirectory/Cmdlets/UpdateAzureADApplicationCommand.cs
@@ -13,7 +13,6 @@
 // ----------------------------------------------------------------------------------
 
 using Microsoft.Azure.Graph.RBAC.Models;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
 using System.Management.Automation;
@@ -57,7 +56,6 @@ public class UpdateAzureADApplicationCommand : ActiveDirectoryBaseCmdlet
         [ValidateNotNullOrEmpty]
         public string HomePage { get; set; }
 
-        [CmdletParameterBreakingChange("IdentifierUri", ChangeDescription = "The value will be considered valid only if it exists as a verified domain in a tenant.")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationObjectIdWithUpdateParams,
             HelpMessage = "The URIs that identify the application.")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.ApplicationIdWithUpdateParams,
@@ -102,7 +100,7 @@ public override void ExecuteCmdlet()
                 {
                     DisplayName = DisplayName,
                     Homepage = HomePage,
-                    IdentifierUris = IdentifierUri,
+                    IdentifierUris = (IdentifierUri == null) ? new string[] { } : IdentifierUri,
                     ReplyUrls = ReplyUrl,
                     AvailableToOtherTenants = this.IsParameterBound(c => c.AvailableToOtherTenants) ? AvailableToOtherTenants : (bool?)null
                 };

diff --git a/src/Resources/Resources/ActiveDirectory/Cmdlets/UpdateAzureADServicePrincipalCommand.cs b/src/Resources/Resources/ActiveDirectory/Cmdlets/UpdateAzureADServicePrincipalCommand.cs
@@ -15,10 +15,9 @@
 using Microsoft.Azure.Graph.RBAC.Models;
 using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using System;
-using System.Linq;
 using System.Collections.Generic;
+using System.Linq;
 using System.Management.Automation;
-using Microsoft.WindowsAzure.Commands.Common.CustomAttributes;
 
 namespace Microsoft.Azure.Commands.ActiveDirectory
 {
@@ -48,7 +47,6 @@ public class UpdateAzureADServicePrincipalCommand : ActiveDirectoryBaseCmdlet
         [ValidateNotNullOrEmpty]
         public PSADServicePrincipal InputObject { get; set; }
 
-        [CmdletParameterBreakingChange("DisplayName", ChangeDescription = "DisplayName is used as the IdentifierUris of created application. The value will be considered valid only if it exists as a verified domain in a tenant.")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.SpObjectIdWithDisplayName, HelpMessage = "The display name for the service principal.")]
         [Parameter(Mandatory = false, ValueFromPipelineByPropertyName = true, ParameterSetName = ParameterSet.SPNWithDisplayName, HelpMessage = "The display name for the service principal.")]
         [Parameter(Mandatory = false, ParameterSetName = ParameterSet.InputObjectWithDisplayName, HelpMessage = "The display name for the service principal.")]
@@ -58,7 +56,6 @@ public class UpdateAzureADServicePrincipalCommand : ActiveDirectoryBaseCmdlet
         [Parameter(Mandatory = false, HelpMessage = "The homepage for the service principal.")]
         public string Homepage { get; set; }
 
-        [CmdletParameterBreakingChange("IdentifierUri", ChangeDescription = "The value will be considered valid only if it exists as a verified domain in a tenant.")]
         [Parameter(Mandatory = false, HelpMessage = "The identifier URI(s) for the service principal.")]
         public string[] IdentifierUri { get; set; }
 
@@ -107,7 +104,7 @@ public override void ExecuteCmdlet()
                 {
                     DisplayName = DisplayName,
                     Homepage = Homepage,
-                    IdentifierUris = IdentifierUri,
+                    IdentifierUris = (IdentifierUri == null) ? new string[] { } : IdentifierUri,
                     KeyCredentials = KeyCredential,
                     PasswordCredentials = PasswordCredential
                 };

diff --git a/src/Resources/Resources/ChangeLog.md b/src/Resources/Resources/ChangeLog.md
@@ -19,6 +19,8 @@
 -->
 
 ## Upcoming Release
+* Changed `-IdentifierUris` in `New-AzADApplication` to optional parameter
+* Removed default DisplayName of ADServicePrincipal when it is not specified
 * Updated SDK to 3.13.1-preview to use GA TemplateSpecs API version
 * Added `AdditionalProperties` to PSADUser and PSADGroup [#14568]
 * Supported `CustomKeyIdentifier` in `New-AzADAppCredential` and `Get-AzADAppCredential` [#11457], [#13723]

diff --git a/src/Resources/Resources/help/New-AzADApplication.md b/src/Resources/Resources/help/New-AzADApplication.md
@@ -15,35 +15,35 @@ Creates a new azure active directory application.
 
 ### ApplicationWithoutCredentialParameterSet (Default)
 ```
-New-AzADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
+New-AzADApplication -DisplayName <String> [-IdentifierUri <String[]>] [-HomePage <String>]
  [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] [-DefaultProfile <IAzureContextContainer>]
  [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ApplicationWithPasswordPlainParameterSet
 ```
-New-AzADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
+New-AzADApplication -DisplayName <String> [-IdentifierUri <String[]>] [-HomePage <String>]
  [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -Password <SecureString> [-StartDate <DateTime>]
  [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ApplicationWithPasswordCredentialParameterSet
 ```
-New-AzADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
+New-AzADApplication -DisplayName <String> [-IdentifierUri <String[]>] [-HomePage <String>]
  [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -PasswordCredentials <PSADPasswordCredential[]>
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ApplicationWithKeyPlainParameterSet
 ```
-New-AzADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
+New-AzADApplication -DisplayName <String> [-IdentifierUri <String[]>] [-HomePage <String>]
  [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -CertValue <String> [-StartDate <DateTime>]
  [-EndDate <DateTime>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### ApplicationWithKeyCredentialParameterSet
 ```
-New-AzADApplication -DisplayName <String> -IdentifierUris <String[]> [-HomePage <String>]
+New-AzADApplication -DisplayName <String> [-IdentifierUri <String[]>] [-HomePage <String>]
  [-ReplyUrls <String[]>] [-AvailableToOtherTenants <Boolean>] -KeyCredentials <PSADKeyCredential[]>
  [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
@@ -172,15 +172,15 @@ Accept pipeline input: True (ByPropertyName)
 Accept wildcard characters: False
 ```
 
-### -IdentifierUris
+### -IdentifierUri
 The URIs that identify the application.
 
 ```yaml
 Type: System.String[]
 Parameter Sets: (All)
-Aliases:
+Aliases: IdentifierUris
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: True (ByPropertyName)