Add breaking change warnings for MI changes (#25889)

Azure · Aug 21, 2024 · f0cc3c1 · f0cc3c1
1 parent 94ffdec
commit f0cc3c1
Show file tree

Hide file tree

Showing 22 changed files with 118 additions and 36 deletions.
diff --git a/src/ElasticSan/ElasticSan.Autorest/README.md b/src/ElasticSan/ElasticSan.Autorest/README.md
@@ -3,9 +3,6 @@
 This directory contains the PowerShell module for the ElasticSan service.
 
 ---
-## Status
-[![Az.ElasticSan](https://img.shields.io/powershellgallery/v/Az.ElasticSan.svg?style=flat-square&label=Az.ElasticSan "Az.ElasticSan")](https://www.powershellgallery.com/packages/Az.ElasticSan/)
-
 ## Info
 - Modifiable: yes
 - Generated: all

diff --git a/...icSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json b/...icSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json
@@ -0,0 +1,105 @@
+{
+  "resourceType": "elasticSans/volumegroups/snapshots",
+  "apiVersion": "2023-01-01",
+  "learnMore": {
+    "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
+  },
+  "commands": [
+    {
+      "name": "Get-AzElasticSanVolumeSnapshot",
+      "description": "Get a Volume Snapshot.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.elasticsan/get-azelasticsanvolumesnapshot"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-ElasticSanName <String>",
+              "-Name <String>",
+              "-ResourceGroupName <String>",
+              "[-SubscriptionId <String[]>]",
+              "-VolumeGroupName <String>"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Get a Volume Snapshot.",
+          "parameters": [
+            {
+              "name": "-ElasticSanName",
+              "value": "[Path.elasticSanName]"
+            },
+            {
+              "name": "-Name",
+              "value": "[Path.snapshotName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            },
+            {
+              "name": "-VolumeGroupName",
+              "value": "[Path.volumeGroupName]"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Remove-AzElasticSanVolumeSnapshot",
+      "description": "Delete a Volume Snapshot.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/snapshots/{snapshotName}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.elasticsan/remove-azelasticsanvolumesnapshot"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-ElasticSanName <String>",
+              "-Name <String>",
+              "-ResourceGroupName <String>",
+              "[-SubscriptionId <String>]",
+              "-VolumeGroupName <String>"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Delete a Volume Snapshot.",
+          "parameters": [
+            {
+              "name": "-ElasticSanName",
+              "value": "[Path.elasticSanName]"
+            },
+            {
+              "name": "-Name",
+              "value": "[Path.snapshotName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            },
+            {
+              "name": "-VolumeGroupName",
+              "value": "[Path.volumeGroupName]"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
diff --git a/...sticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json b/...sticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json
@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans/volumegroups/volumes",
-  "apiVersion": "2022-12-01-preview",
+  "apiVersion": "2023-01-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json
@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans/volumegroups",
-  "apiVersion": "2022-12-01-preview",
+  "apiVersion": "2023-01-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json
@@ -1,6 +1,6 @@
 {
   "resourceType": "elasticSans",
-  "apiVersion": "2022-12-01-preview",
+  "apiVersion": "2023-01-01",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.elasticsan"
   },

diff --git a/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSanVolumeGroup.ps1 b/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSanVolumeGroup.ps1
@@ -119,6 +119,7 @@ function New-AzElasticSanVolumeGroup {
         ${EncryptionUserAssignedIdentity},
 
         [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Runtime.ParameterBreakingChange("IdentityType", "13.0.0", "2.0.0", "2024/11/19", ChangeDescription="IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities.")]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.PSArgumentCompleterAttribute("None", "SystemAssigned", "UserAssigned")]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
         [System.String]

diff --git a/src/ElasticSan/ElasticSan.Autorest/custom/Update-AzElasticSanVolumeGroup.ps1 b/src/ElasticSan/ElasticSan.Autorest/custom/Update-AzElasticSanVolumeGroup.ps1
@@ -119,6 +119,7 @@ function Update-AzElasticSanVolumeGroup {
         ${EncryptionUserAssignedIdentity},
 
         [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Runtime.ParameterBreakingChange("IdentityType", "13.0.0", "2.0.0", "2024/11/19", ChangeDescription="IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities.")]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.PSArgumentCompleterAttribute("None", "SystemAssigned", "UserAssigned")]
         [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
         [System.String]

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md
@@ -206,7 +206,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolume.md
@@ -144,7 +144,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -175,7 +174,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.ElasticSan.Models.IElasticSanIdentity
@@ -237,7 +235,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolumeGroup.md b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolumeGroup.md
@@ -125,7 +125,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -156,7 +155,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolumeSnapshot.md b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSanVolumeSnapshot.md
@@ -169,7 +169,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -215,7 +214,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.ElasticSan.Models.IElasticSanIdentity
@@ -277,7 +275,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md
@@ -145,7 +145,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md
@@ -141,7 +141,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -172,7 +171,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.ElasticSan.Models.IElasticSanIdentity
@@ -264,7 +262,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolumeSnapshot.md b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolumeSnapshot.md
@@ -121,7 +121,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -152,7 +151,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.ElasticSan.Models.IElasticSanIdentity
@@ -229,7 +227,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSan.md
@@ -71,7 +71,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolume.md
@@ -104,7 +104,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -152,7 +151,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.ElasticSan.Models.IElasticSanIdentity
@@ -244,7 +242,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolumeGroup.md b/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolumeGroup.md
@@ -78,7 +78,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -109,7 +108,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolumeSnapshot.md b/src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolumeSnapshot.md
@@ -85,7 +85,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -116,7 +115,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.ElasticSan.Models.IElasticSanIdentity
@@ -208,7 +206,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md
@@ -128,7 +128,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.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md
@@ -106,7 +106,6 @@ Accept wildcard characters: False
 
 ### -ElasticSanInputObject
 Identity Parameter
-To construct, see NOTES section for ELASTICSANINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity
@@ -137,7 +136,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.ElasticSan.Models.IElasticSanIdentity
@@ -229,7 +227,6 @@ Accept wildcard characters: False
 
 ### -VolumegroupInputObject
 Identity Parameter
-To construct, see NOTES section for VOLUMEGROUPINPUTOBJECT properties and create a hash table.
 
 ```yaml
 Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity

diff --git a/src/ElasticSan/ElasticSan.Autorest/test/loadEnv.ps1 b/src/ElasticSan/ElasticSan.Autorest/test/loadEnv.ps1
@@ -25,5 +25,5 @@ if (Test-Path -Path (Join-Path $PSScriptRoot $envFile)) {
 $env = @{}
 if (Test-Path -Path $envFilePath) {
     $env = Get-Content (Join-Path $PSScriptRoot $envFile) | ConvertFrom-Json
-    $PSDefaultParameterValues=@{"*:SubscriptionId"=$env.SubscriptionId; "*:Tenant"=$env.Tenant}
+    $PSDefaultParameterValues=@{"*:Tenant"=$env.Tenant}
 }