Skip to content

Commit 258c5d7

Browse files
ajayknajaykn
authored
support azure powershell for new RP Managed DevOps Pools (#26482)
* support azure powershell for new RP Managed DevOps Pools * Add example for GetAzMdpPool * Add example for GEtAzMdpPoolAgent * Add example for other cmdlets * update docs * add tests * add recordings * fix build
1 parent 82bb7b7 commit 258c5d7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+3149
-0
lines changed

‎src/Mdp/Mdp.Autorest/.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎src/Mdp/Mdp.Autorest/.gitignore

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
bin
2+
obj
3+
.vs
4+
generated
5+
internal
6+
exports
7+
tools
8+
custom/*.psm1
9+
custom/autogen-model-cmdlets
10+
test/*-TestResults.xml
11+
license.txt
12+
/*.ps1
13+
/*.psd1
14+
/*.ps1xml
15+
/*.psm1
16+
/*.snk
17+
/*.csproj
18+
/*.nuspec

‎src/Mdp/Mdp.Autorest/Properties/AssemblyInfo.cs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0 (the ""License"");
3+
// you may not use this file except in compliance with the License.
4+
// You may obtain a copy of the License at
5+
// http://www.apache.org/licenses/LICENSE-2.0
6+
// Unless required by applicable law or agreed to in writing, software
7+
// distributed under the License is distributed on an ""AS IS"" BASIS,
8+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
9+
// See the License for the specific language governing permissions and
10+
// limitations under the License.
11+
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
12+
// is regenerated.
13+
14+
using System;
15+
using System.Reflection;
16+
using System.Runtime.CompilerServices;
17+
using System.Runtime.InteropServices;
18+
19+
[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
20+
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
21+
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
22+
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - ManagedDevOpsPools")]
23+
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")]
24+
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")]
25+
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
26+
[assembly: System.CLSCompliantAttribute(false)]

‎src/Mdp/Mdp.Autorest/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!-- region Generated -->
2+
# Az.Mdp
3+
This directory contains the PowerShell module for the Mdp service.
4+
5+
---
6+
## Info
7+
- Modifiable: yes
8+
- Generated: all
9+
- Committed: yes
10+
- Packaged: yes
11+
12+
---
13+
## Detail
14+
This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension.
15+
16+
## Module Requirements
17+
- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater
18+
19+
## Authentication
20+
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.
21+
22+
## Development
23+
For information on how to develop for `Az.Mdp`, see [how-to.md](how-to.md).
24+
<!-- endregion -->
25+
26+
### AutoRest Configuration
27+
> see https://aka.ms/autorest
28+
29+
```yaml
30+
# pin the swagger version by using the commit id instead of branch name
31+
commit: 8b9c9e84b2ed9da6d74ce0856bb0d8973912cb2f
32+
require:
33+
# readme.azure.noprofile.md is the common configuration file
34+
- $(this-folder)/../../readme.azure.noprofile.md
35+
- $(repo)/specification/devopsinfrastructure/resource-manager/readme.md
36+
37+
try-require:
38+
- $(repo)/specification/devopsinfrastructure/resource-manager/readme.powershell.md
39+
40+
# For new RP, the version is 0.1.0
41+
module-version: 0.1.0
42+
title: Managed DevOps Pools
43+
service-name: Mdp
44+
subject-prefix: $(service-name)
45+
46+
directive:
47+
# Dont expose images and usages endpoints
48+
- remove-operation: ImageVersions_ListByImage
49+
- remove-operation: SubscriptionUsages_Usages
50+
# Hide set cmdlets
51+
- where:
52+
verb: Set
53+
hide: true
54+
# Rename to pool agents
55+
- where:
56+
verb: Get
57+
subject: ResourceDetail
58+
set:
59+
subject: PoolAgent
60+
# Dont flatten hash objects
61+
- no-inline:
62+
- AgentProfile
63+
- OrganizationProfile
64+
- FabricProfile
65+
```

‎src/Mdp/Mdp.Autorest/UX/Microsoft.DevOpsInfrastructure/pools.json

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
{
2+
"resourceType": "pools",
3+
"apiVersion": "2024-10-19",
4+
"learnMore": {
5+
"url": "https://learn.microsoft.com/powershell/module/az.mdp"
6+
},
7+
"commands": [
8+
{
9+
"name": "Get-AzMdpPool",
10+
"description": "Get a Pool",
11+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}",
12+
"help": {
13+
"learnMore": {
14+
"url": "https://learn.microsoft.com/powershell/module/az.mdp/get-azmdppool"
15+
},
16+
"parameterSets": [
17+
{
18+
"parameters": [
19+
"-Name <String>",
20+
"-ResourceGroupName <String>",
21+
"[-SubscriptionId <String[]>]"
22+
]
23+
}
24+
]
25+
},
26+
"examples": [
27+
{
28+
"description": "Get a Pool",
29+
"parameters": [
30+
{
31+
"name": "-Name",
32+
"value": "[Path.poolName]"
33+
},
34+
{
35+
"name": "-ResourceGroupName",
36+
"value": "[Path.resourceGroupName]"
37+
},
38+
{
39+
"name": "-SubscriptionId",
40+
"value": "[Path.subscriptionId]"
41+
}
42+
]
43+
}
44+
]
45+
},
46+
{
47+
"name": "Remove-AzMdpPool",
48+
"description": "Delete a Pool",
49+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevOpsInfrastructure/pools/{poolName}",
50+
"help": {
51+
"learnMore": {
52+
"url": "https://learn.microsoft.com/powershell/module/az.mdp/remove-azmdppool"
53+
},
54+
"parameterSets": [
55+
{
56+
"parameters": [
57+
"-Name <String>",
58+
"-ResourceGroupName <String>",
59+
"[-SubscriptionId <String>]"
60+
]
61+
}
62+
]
63+
},
64+
"examples": [
65+
{
66+
"description": "Delete a Pool",
67+
"parameters": [
68+
{
69+
"name": "-Name",
70+
"value": "[Path.poolName]"
71+
},
72+
{
73+
"name": "-ResourceGroupName",
74+
"value": "[Path.resourceGroupName]"
75+
},
76+
{
77+
"name": "-SubscriptionId",
78+
"value": "[Path.subscriptionId]"
79+
}
80+
]
81+
}
82+
]
83+
}
84+
]
85+
}

‎src/Mdp/Mdp.Autorest/custom/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Custom
2+
This directory contains custom implementation for non-generated cmdlets for the `Az.Mdp` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `../exports` folder. The only generated file into this folder is the `Az.Mdp.custom.psm1`. This file should not be modified.
3+
4+
## Info
5+
- Modifiable: yes
6+
- Generated: partial
7+
- Committed: yes
8+
- Packaged: yes
9+
10+
## Details
11+
For `Az.Mdp` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
12+
13+
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.Mdp.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
14+
15+
For script cmdlets, these are loaded via the `Az.Mdp.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
16+
17+
## Purpose
18+
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `../exports` folder.
19+
20+
## Usage
21+
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `../exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
22+
- Break
23+
- DefaultProfile
24+
- HttpPipelineAppend
25+
- HttpPipelinePrepend
26+
- Proxy
27+
- ProxyCredential
28+
- ProxyUseDefaultCredentials
29+
30+
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.Mdp`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
31+
32+
### Attributes
33+
For processing the cmdlets, we've created some additional attributes:
34+
- `Microsoft.Azure.PowerShell.Cmdlets.Mdp.DescriptionAttribute`
35+
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
36+
- `Microsoft.Azure.PowerShell.Cmdlets.Mdp.DoNotExportAttribute`
37+
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.Mdp`.
38+
- `Microsoft.Azure.PowerShell.Cmdlets.Mdp.InternalExportAttribute`
39+
- Used in C# cmdlets to route exported cmdlets to the `../internal`, which are *not exposed* by `Az.Mdp`. For more information, see [README.md](../internal/README.md) in the `../internal` folder.
40+
- `Microsoft.Azure.PowerShell.Cmdlets.Mdp.ProfileAttribute`
41+
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.

‎src/Mdp/Mdp.Autorest/docs/Az.Mdp.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
Module Name: Az.Mdp
3+
Module Guid: 4c60c500-c04d-4399-ba6e-e364357af76a
4+
Download Help Link: https://learn.microsoft.com/powershell/module/az.mdp
5+
Help Version: 1.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# Az.Mdp Module
10+
## Description
11+
Microsoft Azure PowerShell: Mdp cmdlets
12+
13+
## Az.Mdp Cmdlets
14+
### [Get-AzMdpPool](Get-AzMdpPool.md)
15+
Get a Pool
16+
17+
### [Get-AzMdpPoolAgent](Get-AzMdpPoolAgent.md)
18+
List ResourceDetailsObject resources by Pool
19+
20+
### [Get-AzMdpSku](Get-AzMdpSku.md)
21+
List ResourceSku resources by subscription ID
22+
23+
### [New-AzMdpPool](New-AzMdpPool.md)
24+
create a Pool
25+
26+
### [Remove-AzMdpPool](Remove-AzMdpPool.md)
27+
Delete a Pool
28+
29+
### [Update-AzMdpPool](Update-AzMdpPool.md)
30+
update a Pool
31+

0 commit comments

Comments
 (0)