Add cmdlets for managing Backend Entity in ApiManagement #3586

solankisamir · 2017-03-07T00:36:32Z

Description

Add Cmdlets for Managing the Backend Entity in ApiManagement.

New-AzureRmApiManagementBackend
Get-AzureRmApiManagementBackend
Set-AzureRmApiManagementBackend
Remove-AzureRmApiManagementBackend

Below cmdlets only create In-Memory Object:

New-AzureRmApiManagementBackendCredential
New-AzureRmApiManagementBackendProxy

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.

New-AzureRmApiManagementBackend Get-AzureRmApiManagementBackend Set-AzureRmApiManagementBackend Remove-AzureRmApiManagementBackend

markcowl · 2017-03-07T02:38:39Z

...Management/Commands.ApiManagement.ServiceManagement/Commands/NewAzureApiManagementBackend.cs

+    using System;
+    using System.Management.Automation;
+
+    [Cmdlet(VerbsCommon.New, Constants.ApiManagementBackend)]


This needs to support ShouldProcess

#Fixed

In reply to: 104577049 [](ancestors = 104577049)

markcowl · 2017-03-07T02:40:16Z

...Management/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementBackend.cs

+        public PsApiManagementBackendProxy Proxy { get; set; }
+
+        [Parameter(
+            ValueFromPipelineByPropertyName = true,


?? why from pipeline?

#Fixed

In reply to: 104577220 [](ancestors = 104577220)

markcowl · 2017-03-07T02:42:18Z

...Management/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementBackend.cs

+    [OutputType(typeof(PsApiManagementBackend))]
+    public class SetAzureApiManagementBackend : AzureApiManagementCmdletBase
+    {
+        [Parameter(


With this many named parameters, the strong suggestion is to add a new parameter set that that accepts a PSApiManagementBackEnd as one of the parameters, and use ValueFromPipeline there instead. This is not required, but it is a suggestion.

markcowl · 2017-03-07T02:43:14Z

...Management/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementBackend.cs

+
+        public override void ExecuteApiManagementCmdlet()
+        {
+            Client.BackendSet(


Where is the SHouldProcess implementation?

#Fixed

In reply to: 104577504 [](ancestors = 104577504)

markcowl · 2017-03-07T02:43:35Z

...iceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj

@@ -5894,7 +5894,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope
      </ParamSets>
      <Syntax>


This is no longe rused for help, please remove. Instead, follow the instructions here: https://github.com/Azure/azure-powershell/blob/dev/documentation/platyPSHelp-documentation.md for creating and using the platyPS tool for markdown files.

Generated documentation using platyPS for new cmdlets

markcowl · 2017-03-07T02:46:00Z

...Management/Commands.ApiManagement.ServiceManagement/Commands/SetAzureApiManagementBackend.cs

+    using System;
+    using System.Management.Automation;
+
+    [Cmdlet(VerbsCommon.Set, Constants.ApiManagementBackend)]


needs to support SHoudlProcess

#Fixed

In reply to: 104577790 [](ancestors = 104577790)

markcowl · 2017-03-07T02:46:08Z

tools/StaticAnalysis/Exceptions/SignatureIssues.csv

+"Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll","Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands.NewAzureApiManagementBackendProxy","New-AzureRmApiManagementBackendProxy","1","8100","New-AzureRmApiManagementBackendProxy Does not support ShouldProcess but the cmdlet verb New indicates that it should.","Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue"
+"Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll","Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands.NewAzureApiManagementBackendCredential","New-AzureRmApiManagementBackendCredential","1","8100","New-AzureRmApiManagementBackendCredential Does not support ShouldProcess but the cmdlet verb New indicates that it should.","Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue"
+"Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll","Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands.RemoveAzureApiManagementBackend","Remove-AzureRmApiManagementBackend","2","8210","Remove-AzureRmApiManagementBackend does not have a Force parameter but the cmdlet verb 'Remove' indicates that it may perform destructive actions under certain circumstances. Consider whether the cmdlet should have a Force parameter anduse ShouldContinue under some circumstances. ","Consider wether the cmdlet should have a Force parameter and use ShouldContinue under some circumstances. "
+"Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll","Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Commands.SetAzureApiManagementBackend","Set-AzureRmApiManagementBackend","1","8100","Set-AzureRmApiManagementBackend Does not support ShouldProcess but the cmdlet verb Set indicates that it should.","Determine if the cmdlet should implement ShouldProcess and if so determine if it should implement Force / ShouldContinue"


Set- needs to support SHouldProcess, as noted

solankisamir · 2017-03-07T15:57:01Z

On demand run 1428

Add cmdlets for managing Backend Entity

1b27545

New-AzureRmApiManagementBackend Get-AzureRmApiManagementBackend Set-AzureRmApiManagementBackend Remove-AzureRmApiManagementBackend

msftclas added the cla-not-required label Mar 7, 2017

solankisamir changed the title ~~Add cmdlets for managing Backend Entity~~ Add cmdlets for managing Backend Entity in ApiManagement Mar 7, 2017

markcowl requested changes Mar 7, 2017

View reviewed changes

markcowl assigned solankisamir Mar 7, 2017

markcowl added the Changes Requested label Mar 7, 2017

solankisamir added 2 commits March 6, 2017 22:17

Implement ShouldProcess and generate new documentation using PlatyPS

4cdcf81

Update markdown files based on Validate-ServiceMarkdownHelp

b9f96ff

solankisamir added 2 commits March 7, 2017 10:04

Updated Change Log

dd4ec72

Merge remote-tracking branch 'refs/remotes/Azure/dev' into dev

96a1fda

markcowl approved these changes Mar 7, 2017

View reviewed changes

markcowl removed the Changes Requested label Mar 7, 2017

markcowl merged commit e94fd3a into Azure:dev Mar 7, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add cmdlets for managing Backend Entity in ApiManagement #3586

Add cmdlets for managing Backend Entity in ApiManagement #3586

Uh oh!

solankisamir commented Mar 7, 2017 •

edited

Loading

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir Mar 7, 2017

Uh oh!

markcowl Mar 7, 2017

Uh oh!

solankisamir commented Mar 7, 2017

Uh oh!

Uh oh!

		@@ -5894,7 +5894,7 @@ New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –Ope
		</ParamSets>
		<Syntax>

Add cmdlets for managing Backend Entity in ApiManagement #3586

Add cmdlets for managing Backend Entity in ApiManagement #3586

Uh oh!

Conversation

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

Uh oh!

Description

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!

solankisamir commented Mar 7, 2017

Uh oh!

Uh oh!

solankisamir commented Mar 7, 2017 •

edited

Loading