[ApiManagement] Secure Parameter for Cmdlets #4837

solankisamir · 2017-10-23T19:32:05Z

Description

Breaking Changes in Cmdlet to Manage Api Management Users [Nov Release] Update Cmdlets to use SecureString and PsCredentialType #4595
- New-AzureRmApiManagementUser Parameter Password is changed from String to SecureString
- Set-AzureRmApiManagementBackend Parameter Password is changed from String to SecureString
Breaking Changes in Cmdlet to Create Backend Proxy Object
- New-AzureRmApiManagementBackendProxy Parameter Password and UserName has been replaced with ProxyCredentials of type PSCredential
Updated Cmdlet Get-AzureRmApiManagementUser to fix issue Get-AzureRmApiManagementUser - Parameter set name 'Find users' is not supported #4510
Updated Cmdlet New-AzureRmApiManagementApi to create Api with Empty Path New-AzureRmApiManagement should allow creating API with Empty Path #4069
Updated documentation for issue Get-AzureRmApiManagementSubscription ByProduct does not return same Type consistently #4676

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.

* Breaking Changes in Cmdlet to Manage Api Management Users Azure#4595 - New-AzureRmApiManagementUser Parameter `Password` is changed from String to SecureString - Set-AzureRmApiManagementBackend Parameter `Password` is changed from String to SecureString * Breaking Changes in Cmdlet to Create Backend Proxy Object - New-AzureRmApiManagementBackendProxy Parameter `Password` and `UserName` has been replaced with `ProxyCredentials` of type PSCredential

* Updated Cmdlet Get-AzureRmApiManagementUser to fix issue Azure#4510

* Updated Cmdlet New-AzureRmApiManagementApi to create Api with Empty Path Azure#4069

* Updated documentation for issue Azure#4676

maddieclayton

A few small things to fix.

maddieclayton · 2017-10-23T20:52:26Z

src/ResourceManager/ApiManagement/Commands.SMAPI.Test/ScenarioTests/ApiManagementTests.ps1

@@ -2039,10 +2043,9 @@ Param($resourceGroupName, $serviceName)
    $backendId = getAssetName
    try
    {        


Please fix spacing issues with this test

fixed formatting throughout the file using VSCode extension for Powershell

maddieclayton · 2017-10-23T20:56:33Z

...ApiManagement/Commands.ApiManagement.ServiceManagement/Commands/GetAzureApiManagementUser.cs

+            {
+                var user = Client.UsersList(Context, FirstName, LastName, Email, State, GroupId);
+                WriteObject(user, true);
+            }
            else


You shouldn't need this else statement anymore because all three parameter sets are covered (and powershell will always resolve to one parameter set).

maddieclayton · 2017-10-23T21:03:51Z

src/ResourceManager/ApiManagement/Commands.SMAPI.Test/ScenarioTests/ApiManagementTests.ps1

@@ -916,6 +916,55 @@ Param($resourceGroupName, $serviceName)
        Assert-AreEqual $userNote $user.Note
        Assert-AreEqual $userState $user.State

+        #find user by email


Can you add a few tests with multiple byId parameters (both first and last name for example)?

maddieclayton · 2017-10-23T21:06:42Z

src/ResourceManager/ApiManagement/ChangeLog.md

+    - Set-AzureRmApiManagementBackend Parameter `Password` is changed from String to SecureString
+
+* Breaking Changes in Cmdlet to Create Backend Proxy Object
+    - New-AzureRmApiManagementBackendProxy Parameter `Password` and `UserName` has been replaced with `ProxyCredentials` of type PSCredential


Should be "... Parameters Password and UserName have been replaced..."

maddieclayton · 2017-10-23T21:09:01Z

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Get-AzureRmApiManagementApi.md

@@ -39,20 +43,23 @@ The **Get-AzureRmApiManagementApi** cmdlet gets one or more Azure API Management

 ### Example 1: Get all management APIs
 ```
-PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext


It would be nice if these examples also had sample output, but not a blocker for this PR.

maddieclayton · 2017-10-23T21:24:44Z

...ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementContext.md

@@ -24,13 +25,28 @@ The context is used for all of the API Management service cmdlets.

 ### Example 1: Create a PsApiManagementContext instance
 ```
-PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "ContosoResources" -ServiceName "Contoso"
+PS C:\>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "ContosoResources" -ServiceName "Contoso"


Remove extra powershell prompt

maddieclayton · 2017-10-23T21:26:51Z

...sourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementOperation.md

@@ -58,7 +58,7 @@ $RequestRepresentation.Sample = '{ "propName": "propValue" }'
 $Request.Representations = @($requestRepresentation)
 $Response = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse
 $Response.StatusCode = 204
-New-AzureRmApiManagementOperation -Context $APImContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response)
+New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response)


Add "PS C:>" to all separate powershell commands

maddieclayton · 2017-10-23T21:28:31Z

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/New-AzureRmApiManagementUser.md

@@ -25,7 +25,8 @@ The **New-AzureRmApiManagementUser** cmdlet registers a new user.

 ### Example 1: Register a new user
 ```
-PS C:\>New-AzureRmApiManagementUser -Context $apimContext -FirstName "Patti" -LastName "Fuller" -Email "[email protected]" -Password "qwerty"
+$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force


Add "PS C:>"

maddieclayton · 2017-10-23T21:29:34Z

...ger/ApiManagement/Commands.ApiManagement/help/Remove-AzureRmApiManagementIdentityProvider.md

 ```
+PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
 Remove-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru


Add "PS C:>"

maddieclayton · 2017-10-23T21:32:50Z

src/ResourceManager/ApiManagement/Commands.ApiManagement/help/Set-AzureRmApiManagementUser.md

@@ -25,7 +25,9 @@ The **Set-AzureRmApiManagementUser** cmdlet sets user details.

 ### Example 1: Change a user's password, email address and state
 ```
-PS C:\>Set-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Email "[email protected]" -Password "asdfgh" -State "Blocked"
+PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
+$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force


Add "PS C:>"

maddieclayton · 2017-10-24T16:42:44Z

On demand run here: https://azuresdkci.westus2.cloudapp.azure.com/view/PowerShell/job/powershell-demand/28/

KedarJoshi · 2017-10-24T16:46:41Z

#sign-off

solankisamir added 4 commits October 23, 2017 12:19

Fix Issue 4510 Get-AzureRmApiManagementUser

675422b

* Updated Cmdlet Get-AzureRmApiManagementUser to fix issue Azure#4510

Fix Issue 4069

9aa8b2e

* Updated Cmdlet New-AzureRmApiManagementApi to create Api with Empty Path Azure#4069

Update all documentation for issue 4676

07828fb

* Updated documentation for issue Azure#4676

solankisamir requested a review from maddieclayton October 23, 2017 19:32

azuresdkci added the needs-review label Oct 23, 2017

maddieclayton self-assigned this Oct 23, 2017

maddieclayton suggested changes Oct 23, 2017

View reviewed changes

maddieclayton added needs-revision and removed needs-review labels Oct 23, 2017

maddieclayton assigned solankisamir and unassigned maddieclayton Oct 23, 2017

Doc updates and add more test

b516f71

solankisamir assigned maddieclayton Oct 24, 2017

maddieclayton previously approved these changes Oct 24, 2017

View reviewed changes

maddieclayton added Waiting for On Demand and removed needs-revision labels Oct 24, 2017

maddieclayton unassigned solankisamir Oct 24, 2017

more minor doc updates

3baf55f

solankisamir dismissed maddieclayton’s stale review via 3baf55f October 24, 2017 04:20

maddieclayton approved these changes Oct 24, 2017

View reviewed changes

cormacpayne approved these changes Oct 25, 2017

View reviewed changes

cormacpayne merged commit 76989a3 into Azure:preview Oct 25, 2017

maddieclayton mentioned this pull request Oct 25, 2017

Password parameter and other password-like parameters expect a plain-text string #4359

Closed

[ApiManagement] Secure Parameter for Cmdlets #4837

[ApiManagement] Secure Parameter for Cmdlets #4837

Uh oh!

Conversation

solankisamir commented Oct 23, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

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

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!

maddieclayton commented Oct 24, 2017

Uh oh!

KedarJoshi commented Oct 24, 2017

Uh oh!

Uh oh!

solankisamir commented Oct 23, 2017 •

edited

Loading