Skip to content

Commit 23d0b05

Browse files
authored
[Monitor] Breaking change update Managed Identity (#26376)
* [Breakingchenge Update] Update Managed Identity(UserAssignedIdentity, IdentityType) * Create breakingchangeissues.csv * update * update * update docs * update docs * update * update * delete breakingchange.csv * create BreakingChangeIssues.csv
1 parent 4a5d080 commit 23d0b05

21 files changed

+603
-424
lines changed

src/Monitor/DataCollectionRule.Autorest/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ tools
88
custom/*.psm1
99
custom/autogen-model-cmdlets
1010
test/*-TestResults.xml
11+
license.txt
1112
/*.ps1
13+
/*.psd1
1214
/*.ps1xml
1315
/*.psm1
1416
/*.snk
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 - DataCollectionRule")]
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/Monitor/DataCollectionRule.Autorest/README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ title: DataCollectionRule
4343
module-version: 0.1.0
4444
namespace: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection
4545
subject-prefix: ''
46-
disable-transform-identity-type: true
47-
flatten-userassignedidentity: false
4846

4947
directive:
5048
# custom required body
@@ -191,24 +189,4 @@ directive:
191189
- model-name: StorageBlobDestination
192190
# string Name, string StorageAccountResourceId, string TableName
193191
- model-name: StorageTableDestination
194-
195-
##### announce upcoming MI-related breaking changes
196-
- where:
197-
parameter-name: IdentityType
198-
set:
199-
breaking-change:
200-
change-description: IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities.
201-
deprecated-by-version: 2.0.0
202-
deprecated-by-azversion: 13.0.0
203-
change-effective-date: 2024/11/19
204-
- where:
205-
parameter-name: UserAssignedIdentity
206-
set:
207-
breaking-change:
208-
old-parameter-type: Hashtable
209-
new-parameter-type: string[]
210-
change-description: UserAssignedIdentity's type will be simplified as string array.
211-
deprecated-by-version: 2.0.0
212-
deprecated-by-azversion: 13.0.0
213-
change-effective-date: 2024/11/19
214192
```

src/Monitor/DataCollectionRule.Autorest/docs/New-AzDataCollectionEndpoint.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Create a data collection endpoint.
1515
### CreateExpanded (Default)
1616
```
1717
New-AzDataCollectionEndpoint -Name <String> -ResourceGroupName <String> -Location <String>
18-
[-SubscriptionId <String>] [-Description <String>] [-IdentityType <String>] [-ImmutableId <String>]
18+
[-SubscriptionId <String>] [-Description <String>] [-EnableSystemAssignedIdentity] [-ImmutableId <String>]
1919
[-Kind <String>] [-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>]
20-
[-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
20+
[-UserAssignedIdentity <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
2121
```
2222

2323
### CreateViaJsonFilePath
@@ -163,11 +163,11 @@ Accept pipeline input: False
163163
Accept wildcard characters: False
164164
```
165165
166-
### -IdentityType
167-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
166+
### -EnableSystemAssignedIdentity
167+
Determines whether to enable a system-assigned identity for the resource.
168168
169169
```yaml
170-
Type: System.String
170+
Type: System.Management.Automation.SwitchParameter
171171
Parameter Sets: CreateExpanded
172172
Aliases:
173173

@@ -332,12 +332,11 @@ Accept wildcard characters: False
332332
```
333333
334334
### -UserAssignedIdentity
335-
The set of user assigned identities associated with the resource.
336-
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
337-
The dictionary values can be empty objects ({}) in requests.
335+
The array of user assigned identities associated with the resource.
336+
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
338337
339338
```yaml
340-
Type: System.Collections.Hashtable
339+
Type: System.String[]
341340
Parameter Sets: CreateExpanded
342341
Aliases:
343342

src/Monitor/DataCollectionRule.Autorest/docs/New-AzDataCollectionRule.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ New-AzDataCollectionRule -Name <String> -ResourceGroupName <String> -Location <S
3030
[-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
3131
[-DestinationStorageAccount <IStorageBlobDestination[]>]
3232
[-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
33-
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-IdentityType <String>] [-Kind <String>]
34-
[-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>]
33+
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-EnableSystemAssignedIdentity]
34+
[-Kind <String>] [-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
3535
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
3636
```
3737

@@ -728,11 +728,11 @@ Accept pipeline input: False
728728
Accept wildcard characters: False
729729
```
730730
731-
### -IdentityType
732-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
731+
### -EnableSystemAssignedIdentity
732+
Determines whether to enable a system-assigned identity for the resource.
733733
734734
```yaml
735-
Type: System.String
735+
Type: System.Management.Automation.SwitchParameter
736736
Parameter Sets: CreateExpanded
737737
Aliases:
738738

@@ -881,12 +881,11 @@ Accept wildcard characters: False
881881
```
882882
883883
### -UserAssignedIdentity
884-
The set of user assigned identities associated with the resource.
885-
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
886-
The dictionary values can be empty objects ({}) in requests.
884+
The array of user assigned identities associated with the resource.
885+
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
887886
888887
```yaml
889-
Type: System.Collections.Hashtable
888+
Type: System.String[]
890889
Parameter Sets: CreateExpanded
891890
Aliases:
892891

src/Monitor/DataCollectionRule.Autorest/docs/Update-AzDataCollectionEndpoint.md

Lines changed: 73 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@ Update part of a data collection endpoint.
1515
### UpdateExpanded (Default)
1616
```
1717
Update-AzDataCollectionEndpoint -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>]
18-
[-IdentityType <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>]
19-
[-Confirm] [-WhatIf] [<CommonParameters>]
18+
[-Description <String>] [-EnableSystemAssignedIdentity <Boolean?>] [-ImmutableId <String>] [-Kind <String>]
19+
[-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
20+
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
2021
```
2122

2223
### UpdateViaIdentityExpanded
2324
```
24-
Update-AzDataCollectionEndpoint -InputObject <IDataCollectionRuleIdentity> [-IdentityType <String>]
25-
[-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf]
26-
[<CommonParameters>]
25+
Update-AzDataCollectionEndpoint -InputObject <IDataCollectionRuleIdentity> [-Description <String>]
26+
[-EnableSystemAssignedIdentity <Boolean?>] [-ImmutableId <String>] [-Kind <String>]
27+
[-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
28+
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
2729
```
2830

2931
## DESCRIPTION
@@ -92,8 +94,39 @@ Accept pipeline input: False
9294
Accept wildcard characters: False
9395
```
9496
95-
### -IdentityType
96-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
97+
### -Description
98+
Description of the data collection endpoint.
99+
100+
```yaml
101+
Type: System.String
102+
Parameter Sets: (All)
103+
Aliases:
104+
105+
Required: False
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -EnableSystemAssignedIdentity
113+
Determines whether to enable a system-assigned identity for the resource.
114+
115+
```yaml
116+
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
117+
Parameter Sets: (All)
118+
Aliases:
119+
120+
Required: False
121+
Position: Named
122+
Default value: None
123+
Accept pipeline input: False
124+
Accept wildcard characters: False
125+
```
126+
127+
### -ImmutableId
128+
The immutable ID of this data collection endpoint resource.
129+
This property is READ-ONLY.
97130
98131
```yaml
99132
Type: System.String
@@ -122,6 +155,21 @@ Accept pipeline input: True (ByValue)
122155
Accept wildcard characters: False
123156
```
124157
158+
### -Kind
159+
The kind of the resource.
160+
161+
```yaml
162+
Type: System.String
163+
Parameter Sets: (All)
164+
Aliases:
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
125173
### -Name
126174
The name of the data collection endpoint.
127175
The name is case insensitive.
@@ -138,6 +186,21 @@ Accept pipeline input: False
138186
Accept wildcard characters: False
139187
```
140188
189+
### -NetworkAclsPublicNetworkAccess
190+
The configuration to set whether network access from public internet to the endpoints are allowed.
191+
192+
```yaml
193+
Type: System.String
194+
Parameter Sets: (All)
195+
Aliases:
196+
197+
Required: False
198+
Position: Named
199+
Default value: None
200+
Accept pipeline input: False
201+
Accept wildcard characters: False
202+
```
203+
141204
### -ResourceGroupName
142205
The name of the resource group.
143206
The name is case insensitive.
@@ -185,12 +248,11 @@ Accept wildcard characters: False
185248
```
186249
187250
### -UserAssignedIdentity
188-
The set of user assigned identities associated with the resource.
189-
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
190-
The dictionary values can be empty objects ({}) in requests.
251+
The array of user assigned identities associated with the resource.
252+
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
191253
192254
```yaml
193-
Type: System.Collections.Hashtable
255+
Type: System.String[]
194256
Parameter Sets: (All)
195257
Aliases:
196258

src/Monitor/DataCollectionRule.Autorest/docs/Update-AzDataCollectionRule.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Update-AzDataCollectionRule -Name <String> -ResourceGroupName <String> [-Subscri
3030
[-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
3131
[-DestinationStorageAccount <IStorageBlobDestination[]>]
3232
[-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
33-
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-IdentityType <String>] [-Kind <String>]
34-
[-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>]
33+
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-EnableSystemAssignedIdentity <Boolean?>]
34+
[-Kind <String>] [-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
3535
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
3636
```
3737

@@ -52,8 +52,8 @@ Update-AzDataCollectionRule -InputObject <IDataCollectionRuleIdentity> [-DataCol
5252
[-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
5353
[-DestinationStorageAccount <IStorageBlobDestination[]>]
5454
[-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
55-
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-IdentityType <String>] [-Kind <String>]
56-
[-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>]
55+
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-EnableSystemAssignedIdentity <Boolean?>]
56+
[-Kind <String>] [-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
5757
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
5858
```
5959

@@ -513,11 +513,11 @@ Accept pipeline input: False
513513
Accept wildcard characters: False
514514
```
515515
516-
### -IdentityType
517-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
516+
### -EnableSystemAssignedIdentity
517+
Determines whether to enable a system-assigned identity for the resource.
518518
519519
```yaml
520-
Type: System.String
520+
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
521521
Parameter Sets: (All)
522522
Aliases:
523523

@@ -636,12 +636,11 @@ Accept wildcard characters: False
636636
```
637637
638638
### -UserAssignedIdentity
639-
The set of user assigned identities associated with the resource.
640-
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
641-
The dictionary values can be empty objects ({}) in requests.
639+
The array of user assigned identities associated with the resource.
640+
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'
642641
643642
```yaml
644-
Type: System.Collections.Hashtable
643+
Type: System.String[]
645644
Parameter Sets: (All)
646645
Aliases:
647646

0 commit comments

Comments
 (0)