Skip to content

[PS] migrate DiagnosticSetting in Monitor module to autorest v4 #28162

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Nov 10, 2025
Merged

[PS] migrate DiagnosticSetting in Monitor module to autorest v4 #28162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4369a7
migrate DiagnosticSetting module to autorest v4
JoyerJin Jul 10, 2025
d9b030e
Create BreakingChangeIssues.csv
JoyerJin Jul 10, 2025
715928e
update readme
JoyerJin Jul 16, 2025
6f1cc79
Merge branch 'main' into joyer-diagnosticsetting-migrate-v4
VeryEarly Nov 7, 2025
614e399
Merge branch 'yabo/monitor' into joyer-diagnosticsetting-migrate-v4
VeryEarly Nov 10, 2025
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
3 changes: 1 addition & 2 deletions src/Monitor/DiagnosticSetting.Autorest/Properties/AssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@
[assembly: System.Reflection.AssemblyFileVersionAttribute("6.0.2")]
[assembly: System.Reflection.AssemblyVersionAttribute("6.0.2")]
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
[assembly: System.CLSCompliantAttribute(false)]

[assembly: System.CLSCompliantAttribute(false)]
17 changes: 4 additions & 13 deletions src/Monitor/DiagnosticSetting.Autorest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,6 @@ title: DiagnosticSetting
module-version: 0.1.0
subject-prefix: DiagnosticSetting
namespace: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting
nested-object-to-string: true

# If there are post APIs for some kinds of actions in the RP, you may need to
# uncomment following line to support viaIdentity for these post APIs
# identity-correction-for-post: true

# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option
use-extension:
"@autorest/powershell": "3.x"

directive:
- where:
Expand Down Expand Up @@ -107,7 +98,7 @@ directive:
# 1. Remove the unexpanded parameter set
# 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
Copy link

Copilot AI Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This complex regex directive lacks a comment explaining its purpose. Based on CodingGuidelineID 1000002, all directives should have comments explaining the 'why'. Add a comment such as: '# Keep only Expanded, JsonFilePath, and JsonString parameter sets for Create and Update operations, removing unexpanded variants and CreateViaIdentityExpanded'.

Suggested change
# 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
# 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
# Keep only Expanded, JsonFilePath, and JsonString parameter sets for Create and Update operations,
# removing unexpanded variants and CreateViaIdentityExpanded to simplify the cmdlet surface and avoid unsupported scenarios.

Copilot uses AI. Check for mistakes.
- where:
variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString))|^CreateViaIdentityExpanded$
remove: true
# Remove Set cmdlet
- where:
Expand All @@ -129,7 +120,7 @@ directive:
subject-prefix: ""

- model-cmdlet:
- MetricSettings
- LogSettings
- SubscriptionLogSettings
- model-name: MetricSettings
- model-name: LogSettings
- model-name: SubscriptionLogSettings
```
9 changes: 5 additions & 4 deletions ...etting.Autorest/custom/autogen-model-cmdlets/New-AzDiagnosticSettingLogSettingsObject.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Create an in-memory object for LogSettings.
Create an in-memory object for LogSettings.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.LogSettings
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.LogSettings
.Link
https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingLogSettingsObject
https://learn.microsoft.com/powershell/module/Az.Monitor/new-azdiagnosticsettinglogsettingsobject
#>
function New-AzDiagnosticSettingLogSettingsObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.LogSettings')]
[Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.LogSettings')]
[CmdletBinding(PositionalBinding=$false)]
Param(

Expand All @@ -48,7 +49,7 @@ function New-AzDiagnosticSettingLogSettingsObject {
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.LogSettings]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.LogSettings]::New()

if ($PSBoundParameters.ContainsKey('Category')) {
$Object.Category = $Category
Expand Down
9 changes: 5 additions & 4 deletions ...ing.Autorest/custom/autogen-model-cmdlets/New-AzDiagnosticSettingMetricSettingsObject.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Create an in-memory object for MetricSettings.
Create an in-memory object for MetricSettings.

.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.MetricSettings
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.MetricSettings
.Link
https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingMetricSettingsObject
https://learn.microsoft.com/powershell/module/Az.Monitor/new-azdiagnosticsettingmetricsettingsobject
#>
function New-AzDiagnosticSettingMetricSettingsObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.MetricSettings')]
[Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.MetricSettings')]
[CmdletBinding(PositionalBinding=$false)]
Param(

Expand All @@ -48,7 +49,7 @@ function New-AzDiagnosticSettingMetricSettingsObject {
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.MetricSettings]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.MetricSettings]::New()

if ($PSBoundParameters.ContainsKey('Category')) {
$Object.Category = $Category
Expand Down
9 changes: 5 additions & 4 deletions ...est/custom/autogen-model-cmdlets/New-AzDiagnosticSettingSubscriptionLogSettingsObject.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Create an in-memory object for SubscriptionLogSettings.
Create an in-memory object for SubscriptionLogSettings.
.Outputs
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.SubscriptionLogSettings
Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.SubscriptionLogSettings
.Link
https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingSubscriptionLogSettingsObject
https://learn.microsoft.com/powershell/module/Az.Monitor/new-azdiagnosticsettingsubscriptionlogsettingsobject
#>
function New-AzDiagnosticSettingSubscriptionLogSettingsObject {
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.SubscriptionLogSettings')]
[Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.ModelCmdletAttribute()]
[OutputType('Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.SubscriptionLogSettings')]
[CmdletBinding(PositionalBinding=$false)]
Param(

Expand All @@ -42,7 +43,7 @@ function New-AzDiagnosticSettingSubscriptionLogSettingsObject {
)

process {
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.SubscriptionLogSettings]::New()
$Object = [Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.SubscriptionLogSettings]::New()

if ($PSBoundParameters.ContainsKey('Category')) {
$Object.Category = $Category
Expand Down
10 changes: 8 additions & 2 deletions src/Monitor/DiagnosticSetting.Autorest/docs/Az.DiagnosticSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The current list includes the following: Administrative, Security, ServiceHealth
Gets the active subscription diagnostic settings for the specified resource.

### [New-AzDiagnosticSetting](New-AzDiagnosticSetting.md)
Creates or updates diagnostic settings for the specified resource.
Create diagnostic settings for the specified resource.

### [New-AzDiagnosticSettingLogSettingsObject](New-AzDiagnosticSettingLogSettingsObject.md)
Create an in-memory object for LogSettings.
Expand All @@ -37,11 +37,17 @@ Create an in-memory object for MetricSettings.
Create an in-memory object for SubscriptionLogSettings.

### [New-AzSubscriptionDiagnosticSetting](New-AzSubscriptionDiagnosticSetting.md)
Creates or updates subscription diagnostic settings for the specified resource.
Create subscription diagnostic settings for the specified resource.

### [Remove-AzDiagnosticSetting](Remove-AzDiagnosticSetting.md)
Deletes existing diagnostic settings for the specified resource.

### [Remove-AzSubscriptionDiagnosticSetting](Remove-AzSubscriptionDiagnosticSetting.md)
Deletes existing subscription diagnostic settings for the specified resource.

### [Update-AzDiagnosticSetting](Update-AzDiagnosticSetting.md)
Update diagnostic settings for the specified resource.

### [Update-AzSubscriptionDiagnosticSetting](Update-AzSubscriptionDiagnosticSetting.md)
Update subscription diagnostic settings for the specified resource.

3 changes: 1 addition & 2 deletions src/Monitor/DiagnosticSetting.Autorest/docs/Get-AzDiagnosticSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity
Expand Down Expand Up @@ -122,7 +121,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsResource
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingsResource

## NOTES

Expand Down
3 changes: 1 addition & 2 deletions src/Monitor/DiagnosticSetting.Autorest/docs/Get-AzDiagnosticSettingCategory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity
Expand Down Expand Up @@ -115,7 +114,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsCategoryResource
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingsCategoryResource

## NOTES

Expand Down
2 changes: 1 addition & 1 deletion src/Monitor/DiagnosticSetting.Autorest/docs/Get-AzEventCategory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20150401.ILocalizableString
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.ILocalizableString

## NOTES

Expand Down
3 changes: 1 addition & 2 deletions src/Monitor/DiagnosticSetting.Autorest/docs/Get-AzSubscriptionDiagnosticSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingIdentity
Expand Down Expand Up @@ -122,7 +121,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ISubscriptionDiagnosticSettingsResource
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.ISubscriptionDiagnosticSettingsResource

## NOTES

Expand Down
73 changes: 57 additions & 16 deletions src/Monitor/DiagnosticSetting.Autorest/docs/New-AzDiagnosticSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ schema: 2.0.0
# New-AzDiagnosticSetting

## SYNOPSIS
Creates or updates diagnostic settings for the specified resource.
Create diagnostic settings for the specified resource.

## SYNTAX

### CreateExpanded (Default)
```
New-AzDiagnosticSetting -Name <String> -ResourceId <String> [-EventHubAuthorizationRuleId <String>]
[-EventHubName <String>] [-Log <ILogSettings[]>] [-LogAnalyticsDestinationType <String>]
Expand All @@ -20,8 +21,20 @@ New-AzDiagnosticSetting -Name <String> -ResourceId <String> [-EventHubAuthorizat
[<CommonParameters>]
```

### CreateViaJsonFilePath
```
New-AzDiagnosticSetting -Name <String> -ResourceId <String> -JsonFilePath <String>
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### CreateViaJsonString
```
New-AzDiagnosticSetting -Name <String> -ResourceId <String> -JsonString <String> [-DefaultProfile <PSObject>]
[-Confirm] [-WhatIf] [<CommonParameters>]
```

## DESCRIPTION
Creates or updates diagnostic settings for the specified resource.
Create diagnostic settings for the specified resource.

## EXAMPLES

Expand Down Expand Up @@ -72,7 +85,7 @@ The resource Id for the event hub authorization rule.

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

Required: False
Expand All @@ -88,7 +101,7 @@ If none is specified, the default event hub will be selected.

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

Required: False
Expand All @@ -98,13 +111,42 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -JsonFilePath
Path of Json file supplied to the Create operation

```yaml
Type: System.String
Parameter Sets: CreateViaJsonFilePath
Aliases:

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

### -JsonString
Json string supplied to the Create operation

```yaml
Type: System.String
Parameter Sets: CreateViaJsonString
Aliases:

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

### -Log
The list of logs settings.
To construct, see NOTES section for LOG properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.ILogSettings[]
Parameter Sets: (All)
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.ILogSettings[]
Parameter Sets: CreateExpanded
Aliases:

Required: False
Expand All @@ -121,7 +163,7 @@ Possible values are: Dedicated and null (null is default.)

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

Required: False
Expand All @@ -136,7 +178,7 @@ The full ARM resource ID of the Marketplace resource to which you would like to

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

Required: False
Expand All @@ -148,11 +190,10 @@ Accept wildcard characters: False

### -Metric
The list of metric settings.
To construct, see NOTES section for METRIC properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IMetricSettings[]
Parameter Sets: (All)
Type: Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IMetricSettings[]
Parameter Sets: CreateExpanded
Aliases:

Required: False
Expand Down Expand Up @@ -198,7 +239,7 @@ This is here to maintain backwards compatibility.

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

Required: False
Expand All @@ -213,7 +254,7 @@ The resource ID of the storage account to which you would like to send Diagnosti

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

Required: False
Expand All @@ -229,7 +270,7 @@ Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insi

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

Required: False
Expand Down Expand Up @@ -277,7 +318,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.IDiagnosticSettingsResource
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.IDiagnosticSettingsResource

## NOTES

Expand Down
4 changes: 2 additions & 2 deletions ...tor/DiagnosticSetting.Autorest/docs/New-AzDiagnosticSettingLogSettingsObject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
external help file:
Module Name: Az.Monitor
online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-AzDiagnosticSettingLogSettingsObject
online version: https://learn.microsoft.com/powershell/module/Az.Monitor/new-azdiagnosticsettinglogsettingsobject
schema: 2.0.0
---

Expand Down Expand Up @@ -116,7 +116,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## OUTPUTS

### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.Api20210501Preview.LogSettings
### Microsoft.Azure.PowerShell.Cmdlets.Monitor.DiagnosticSetting.Models.LogSettings

## NOTES

Expand Down
Loading