Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Monitor] Breaking change update Managed Identity #26376

Open
wants to merge 2 commits into
base: generation
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/Monitor/DataCollectionRule.Autorest/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ tools
custom/*.psm1
custom/autogen-model-cmdlets
test/*-TestResults.xml
license.txt
/*.ps1
/*.psd1
/*.ps1xml
/*.psm1
/*.snk
Expand Down
26 changes: 26 additions & 0 deletions src/Monitor/DataCollectionRule.Autorest/Properties/AssemblyInfo.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code
// is regenerated.

using System;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")]
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - DataCollectionRule")]
[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0.0")]
[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0.0")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]
38 changes: 18 additions & 20 deletions src/Monitor/DataCollectionRule.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ title: DataCollectionRule
module-version: 0.1.0
namespace: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DataCollection
subject-prefix: ''
disable-transform-identity-type: true
flatten-userassignedidentity: false

directive:
# custom required body
Expand Down Expand Up @@ -193,22 +191,22 @@ directive:
- model-name: StorageTableDestination

##### announce upcoming MI-related breaking changes
- where:
parameter-name: IdentityType
set:
breaking-change:
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.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 13.0.0
change-effective-date: 2024/11/19
- where:
parameter-name: UserAssignedIdentity
set:
breaking-change:
old-parameter-type: Hashtable
new-parameter-type: string[]
change-description: UserAssignedIdentity's type will be simplified as string array.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 13.0.0
change-effective-date: 2024/11/19
# - where:
# parameter-name: IdentityType
# set:
# breaking-change:
# 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.
# deprecated-by-version: 2.0.0
# deprecated-by-azversion: 13.0.0
# change-effective-date: 2024/11/19
# - where:
# parameter-name: UserAssignedIdentity
# set:
# breaking-change:
# old-parameter-type: Hashtable
# new-parameter-type: string[]
# change-description: UserAssignedIdentity's type will be simplified as string array.
# deprecated-by-version: 2.0.0
# deprecated-by-azversion: 13.0.0
# change-effective-date: 2024/11/19
```
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Returns the specified data collection rule.
Returns the specified association.

### [New-AzDataCollectionEndpoint](New-AzDataCollectionEndpoint.md)
Create a data collection endpoint.
create a data collection endpoint.

### [New-AzDataCollectionRule](New-AzDataCollectionRule.md)
Create a data collection rule.
create a data collection rule.

### [New-AzDataCollectionRuleAssociation](New-AzDataCollectionRuleAssociation.md)
Create an association.
create an association.

### [New-AzDataFlowObject](New-AzDataFlowObject.md)
Create an in-memory object for DataFlow.
Expand Down Expand Up @@ -87,11 +87,11 @@ Deletes a data collection rule.
Deletes an association.

### [Update-AzDataCollectionEndpoint](Update-AzDataCollectionEndpoint.md)
Update part of a data collection endpoint.
update a data collection endpoint.

### [Update-AzDataCollectionRule](Update-AzDataCollectionRule.md)
Update a data collection rule.

### [Update-AzDataCollectionRuleAssociation](Update-AzDataCollectionRuleAssociation.md)
Update an association.
update an association.

Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ schema: 2.0.0
# New-AzDataCollectionEndpoint

## SYNOPSIS
Create a data collection endpoint.
create a data collection endpoint.

## SYNTAX

### CreateExpanded (Default)
```
New-AzDataCollectionEndpoint -Name <String> -ResourceGroupName <String> -Location <String>
[-SubscriptionId <String>] [-Description <String>] [-IdentityType <String>] [-ImmutableId <String>]
[-SubscriptionId <String>] [-Description <String>] [-EnableSystemAssignedIdentity] [-ImmutableId <String>]
[-Kind <String>] [-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>]
[-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
[-UserAssignedIdentity <String[]>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### CreateViaJsonFilePath
Expand All @@ -33,7 +33,7 @@ New-AzDataCollectionEndpoint -Name <String> -ResourceGroupName <String> -JsonStr
```

## DESCRIPTION
Create a data collection endpoint.
create a data collection endpoint.

## EXAMPLES

Expand Down Expand Up @@ -163,11 +163,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -IdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
### -EnableSystemAssignedIdentity
Decides if enable a system assigned identity for the resource.

```yaml
Type: System.String
Type: System.Management.Automation.SwitchParameter
Parameter Sets: CreateExpanded
Aliases:

Expand Down Expand Up @@ -332,12 +332,11 @@ Accept wildcard characters: False
```

### -UserAssignedIdentity
The set of user assigned identities associated with the resource.
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
The dictionary values can be empty objects ({}) in requests.
The array of user assigned identities associated with the resource.
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

```yaml
Type: System.Collections.Hashtable
Type: System.String[]
Parameter Sets: CreateExpanded
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzDataCollectionRule

## SYNOPSIS
Create a data collection rule.
create a data collection rule.

## SYNTAX

Expand All @@ -30,8 +30,8 @@ New-AzDataCollectionRule -Name <String> -ResourceGroupName <String> -Location <S
[-DestinationMonitoringAccount <IMonitoringAccountDestination[]>]
[-DestinationStorageAccount <IStorageBlobDestination[]>]
[-DestinationStorageBlobsDirect <IStorageBlobDestination[]>]
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-IdentityType <String>] [-Kind <String>]
[-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>]
[-DestinationStorageTablesDirect <IStorageTableDestination[]>] [-EnableSystemAssignedIdentity]
[-Kind <String>] [-StreamDeclaration <Hashtable>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

Expand All @@ -48,7 +48,7 @@ New-AzDataCollectionRule -Name <String> -ResourceGroupName <String> -JsonString
```

## DESCRIPTION
Create a data collection rule.
create a data collection rule.

## EXAMPLES

Expand Down Expand Up @@ -728,11 +728,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -IdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
### -EnableSystemAssignedIdentity
Decides if enable a system assigned identity for the resource.

```yaml
Type: System.String
Type: System.Management.Automation.SwitchParameter
Parameter Sets: CreateExpanded
Aliases:

Expand Down Expand Up @@ -881,12 +881,11 @@ Accept wildcard characters: False
```

### -UserAssignedIdentity
The set of user assigned identities associated with the resource.
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
The dictionary values can be empty objects ({}) in requests.
The array of user assigned identities associated with the resource.
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

```yaml
Type: System.Collections.Hashtable
Type: System.String[]
Parameter Sets: CreateExpanded
Aliases:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ schema: 2.0.0
# New-AzDataCollectionRuleAssociation

## SYNOPSIS
Create an association.
create an association.

## SYNTAX

Expand All @@ -32,7 +32,7 @@ New-AzDataCollectionRuleAssociation -AssociationName <String> -ResourceUri <Stri
```

## DESCRIPTION
Create an association.
create an association.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,28 @@ schema: 2.0.0
# Update-AzDataCollectionEndpoint

## SYNOPSIS
Update part of a data collection endpoint.
update a data collection endpoint.

## SYNTAX

### UpdateExpanded (Default)
```
Update-AzDataCollectionEndpoint -Name <String> -ResourceGroupName <String> [-SubscriptionId <String>]
[-IdentityType <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>]
[-Confirm] [-WhatIf] [<CommonParameters>]
[-Description <String>] [-EnableSystemAssignedIdentity <Boolean?>] [-ImmutableId <String>] [-Kind <String>]
[-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityExpanded
```
Update-AzDataCollectionEndpoint -InputObject <IDataCollectionRuleIdentity> [-IdentityType <String>]
[-Tag <Hashtable>] [-UserAssignedIdentity <Hashtable>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Update-AzDataCollectionEndpoint -InputObject <IDataCollectionRuleIdentity> [-Description <String>]
[-EnableSystemAssignedIdentity <Boolean?>] [-ImmutableId <String>] [-Kind <String>]
[-NetworkAclsPublicNetworkAccess <String>] [-Tag <Hashtable>] [-UserAssignedIdentity <String[]>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

## DESCRIPTION
Update part of a data collection endpoint.
update a data collection endpoint.

## EXAMPLES

Expand Down Expand Up @@ -92,8 +94,39 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -IdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
### -Description
Description of the data collection endpoint.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EnableSystemAssignedIdentity
Decides if enable a system assigned identity for the resource.

```yaml
Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ImmutableId
The immutable ID of this data collection endpoint resource.
This property is READ-ONLY.

```yaml
Type: System.String
Expand Down Expand Up @@ -122,6 +155,21 @@ Accept pipeline input: True (ByValue)
Accept wildcard characters: False
```

### -Kind
The kind of the resource.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
The name of the data collection endpoint.
The name is case insensitive.
Expand All @@ -138,6 +186,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -NetworkAclsPublicNetworkAccess
The configuration to set whether network access from public internet to the endpoints are allowed.

```yaml
Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ResourceGroupName
The name of the resource group.
The name is case insensitive.
Expand Down Expand Up @@ -185,12 +248,11 @@ Accept wildcard characters: False
```

### -UserAssignedIdentity
The set of user assigned identities associated with the resource.
The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.
The dictionary values can be empty objects ({}) in requests.
The array of user assigned identities associated with the resource.
The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.'

```yaml
Type: System.Collections.Hashtable
Type: System.String[]
Parameter Sets: (All)
Aliases:

Expand Down
Loading
Loading