Skip to content

Commit 9fdada5

Browse files
isolenovIgor Solenov
andauthored
Generation of API version 2023-01-31 for Managed Service Identities (Azure#20921)
* 2023-01-31 generated * Test records are updated with version 2023-01-31 --------- Co-authored-by: Igor Solenov <[email protected]>
1 parent d0c1130 commit 9fdada5

26 files changed

+324
-299
lines changed

src/ManagedServiceIdentity/Az.ManagedServiceIdentity.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
@{
22
GUID = '1f09fbda-2563-4cfc-9098-100c27b52fa1'
33
RootModule = './Az.ManagedServiceIdentity.psm1'
4-
ModuleVersion = '0.2.0'
4+
ModuleVersion = '0.3.0'
55
CompatiblePSEditions = 'Core', 'Desktop'
66
Author = 'Microsoft Corporation'
77
CompanyName = 'Microsoft Corporation'

src/ManagedServiceIdentity/README.md

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,14 @@ branch: main
3434
require:
3535
- $(this-folder)/../readme.azure.noprofile.md
3636
input-file:
37+
- $(repo)/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json
3738
- $(repo)/specification/msi/resource-manager/Microsoft.ManagedIdentity/preview/2022-01-31-preview/ManagedIdentity.json
3839

3940
subject-prefix: ""
4041
resourcegroup-append: true
4142
nested-object-to-string: true
4243
identity-correction-for-post: true
43-
module-version: 0.2.0
44+
module-version: 0.3.0
4445

4546
directive:
4647
- where:
@@ -65,7 +66,7 @@ directive:
6566
set:
6667
parameter-name: Name
6768

68-
# Associated Resources
69+
# Associated Resources use 2022-01-31-preview API version
6970

7071
- where:
7172
subject: UserAssignedIdentityAssociatedResource
@@ -78,6 +79,8 @@ directive:
7879
set:
7980
preview-message: This is a preview version of the Associated Resources feature.
8081

82+
# END
83+
8184
# Federated identity credentials
8285

8386
- where:
@@ -132,8 +135,26 @@ directive:
132135
- Subject
133136
- Audience
134137

138+
# END
139+
140+
# Below instructions remove duplicate API methods which use 2022-01-31-preview. MUST be removed when 2022-01-31-preview is removed.
141+
135142
- where:
136143
subject: FederatedIdentityCredentials
137-
set:
138-
preview-message: This is a preview version of the Federated Identity Credentials feature.
144+
variant: ^Get1$|^List1$|^GetViaIdentity1$|^Create1$|^CreateExpanded1$|^CreateViaIdentity1$|^CreateViaIdentityExpanded1$|^Delete1$|^DeleteViaIdentity1$|^Update1$|^UpdateExpanded1$|^UpdateViaIdentity1$|^UpdateViaIdentityExpanded1$
145+
remove: true
146+
147+
- where:
148+
verb: Get
149+
subject: SystemAssignedIdentity
150+
variant: ^Get1$|^GetViaIdentity1$
151+
remove: true
152+
153+
- where:
154+
subject: UserAssignedIdentity
155+
variant: ^Get1$|^GetViaIdentity1$|^List2$|^List3$|^Create1$|^CreateExpanded1$|^CreateViaIdentity1$|^CreateViaIdentityExpanded1$|^Delete1$|^DeleteViaIdentity1$|^Update1$|^UpdateExpanded1$|^UpdateViaIdentity1$|^UpdateViaIdentityExpanded1$
156+
remove: true
157+
158+
# END
159+
139160
```

src/ManagedServiceIdentity/custom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ These provide functionality to our HTTP pipeline and other useful features. In s
3232
### Attributes
3333
For processing the cmdlets, we've created some additional attributes:
3434
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.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.
35+
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
3636
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.DoNotExportAttribute`
3737
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.ManagedServiceIdentity`.
3838
- `Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.InternalExportAttribute`

src/ManagedServiceIdentity/docs/Get-AzFederatedIdentityCredentials.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,8 @@ Accept wildcard characters: False
142142
```
143143
144144
### -ResourceGroupName
145-
The name of the Resource Group to which the identity belongs.
145+
The name of the resource group.
146+
The name is case insensitive.
146147
147148
```yaml
148149
Type: System.String
@@ -211,7 +212,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
211212
212213
## OUTPUTS
213214
214-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
215+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential
215216
216217
## NOTES
217218

src/ManagedServiceIdentity/docs/Get-AzSystemAssignedIdentity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7474
7575
## OUTPUTS
7676
77-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.ISystemAssignedIdentity
77+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.ISystemAssignedIdentity
7878
7979
## NOTES
8080

src/ManagedServiceIdentity/docs/Get-AzUserAssignedIdentity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
182182
183183
## OUTPUTS
184184
185-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
185+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity
186186
187187
## NOTES
188188

src/ManagedServiceIdentity/docs/New-AzFederatedIdentityCredentials.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@ Accept wildcard characters: False
130130
```
131131
132132
### -ResourceGroupName
133-
The name of the Resource Group to which the identity belongs.
133+
The name of the resource group.
134+
The name is case insensitive.
134135
135136
```yaml
136137
Type: System.String
@@ -212,7 +213,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
212213
213214
## OUTPUTS
214215
215-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
216+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential
216217
217218
## NOTES
218219

src/ManagedServiceIdentity/docs/New-AzUserAssignedIdentity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
166166
167167
## OUTPUTS
168168
169-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
169+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity
170170
171171
## NOTES
172172

src/ManagedServiceIdentity/docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ This directory contains the documentation of the cmdlets for the `Az.ManagedServ
88
- Packaged: yes
99

1010
## Details
11-
The process of documentation generation loads `Az.ManagedServiceIdentity` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.
11+
The process of documentation generation loads `Az.ManagedServiceIdentity` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `../exports` folder. Additionally, when writing custom cmdlets in the `../custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `../examples` folder.

src/ManagedServiceIdentity/docs/Remove-AzFederatedIdentityCredentials.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ Accept wildcard characters: False
122122
```
123123
124124
### -ResourceGroupName
125-
The name of the Resource Group to which the identity belongs.
125+
The name of the resource group.
126+
The name is case insensitive.
126127
127128
```yaml
128129
Type: System.String

src/ManagedServiceIdentity/docs/Update-AzFederatedIdentityCredentials.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,8 @@ Accept wildcard characters: False
152152
```
153153
154154
### -ResourceGroupName
155-
The name of the Resource Group to which the identity belongs.
155+
The name of the resource group.
156+
The name is case insensitive.
156157
157158
```yaml
158159
Type: System.String
@@ -236,7 +237,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
236237
237238
## OUTPUTS
238239
239-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IFederatedIdentityCredential
240+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IFederatedIdentityCredential
240241
241242
## NOTES
242243

src/ManagedServiceIdentity/docs/Update-AzUserAssignedIdentity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
204204
205205
## OUTPUTS
206206
207-
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20220131Preview.IIdentity
207+
### Microsoft.Azure.PowerShell.Cmdlets.ManagedServiceIdentity.Models.Api20230131.IIdentity
208208
209209
## NOTES
210210

src/ManagedServiceIdentity/how-to.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To generate documentation, the process is now integrated into the `build-module.
1414
To test the cmdlets, we use [Pester](https://github.com/pester/Pester). Tests scripts (`.ps1`) should be added to the `test` folder. To execute the Pester tests, run the `test-module.ps1` script. This will run all tests in `playback` mode within the `test` folder. To read more about testing cmdlets, look at the [README.md](examples/README.md) in the `examples` folder.
1515

1616
## Packing `Az.ManagedServiceIdentity`
17-
To pack `Az.ManagedServiceIdentity` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://learn.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
17+
To pack `Az.ManagedServiceIdentity` for distribution, run the `pack-module.ps1` script. This will take the contents of multiple directories and certain root-folder files to create a `.nupkg`. The structure of the `.nupkg` is created so it can be loaded part of a [PSRepository](https://docs.microsoft.com/powershell/module/powershellget/register-psrepository). Additionally, this package is in a format for distribution to the [PSGallery](https://www.powershellgallery.com/). For signing an Azure module, please contact the [Azure PowerShell](https://github.com/Azure/azure-powershell) team.
1818

1919
## Module Script Details
2020
There are multiple scripts created for performing different actions for developing `Az.ManagedServiceIdentity`.

0 commit comments

Comments
 (0)