Migrate Storage from generation to main (#24489)

* Move Storage to main

* Create UXMetadataIssues.csv

* Update ChangeLog.md

---------

Co-authored-by: Vincent Dai <[email protected]>

Author: azure-powershell-bot

src/Storage/Storage.Autorest/Az.Storage.psm1

@@ -47,37 +47,41 @@
 
   # Ask for the shared functionality table
   $VTable = Register-AzModule
-  
+
   # Tweaks the pipeline on module load
   $instance.OnModuleLoad = $VTable.OnModuleLoad
 
   # Following two delegates are added for telemetry
   $instance.GetTelemetryId = $VTable.GetTelemetryId
   $instance.Telemetry = $VTable.Telemetry
-  
+
+  # Delegate to sanitize the output object
+  $instance.SanitizeOutput = $VTable.SanitizerHandler
+
+  # Delegate to get the telemetry info
+  $instance.GetTelemetryInfo = $VTable.GetTelemetryInfo
 
   # Tweaks the pipeline per call
   $instance.OnNewRequest = $VTable.OnNewRequest
-  
+
   # Gets shared parameter values
   $instance.GetParameterValue = $VTable.GetParameterValue
-  
+
   # Allows shared module to listen to events from this module
   $instance.EventListener = $VTable.EventListener
-  
+
   # Gets shared argument completers
   $instance.ArgumentCompleter = $VTable.ArgumentCompleter
-  
+
   # The name of the currently selected Azure profile
   $instance.ProfileName = $VTable.ProfileName
 
- 
   # Load the custom module
   $customModulePath = Join-Path $PSScriptRoot './custom/Az.Storage.custom.psm1'
   if(Test-Path $customModulePath) {
     $null = Import-Module -Name $customModulePath
   }
-  
+
   # Export nothing to clear implicit exports
   Export-ModuleMember
 
@@ -97,12 +101,12 @@
     # Load the last folder if no profile is selected
     $profileDirectory = $directories | Select-Object -Last 1
   }
-  
+
   if($profileDirectory) {
     Write-Information "Loaded Azure profile '$($profileDirectory.Name)' for module '$($instance.Name)'"
     $exportsPath = $profileDirectory.FullName
   }
-  
+
   if($exportsPath) {
     Get-ChildItem -Path $exportsPath -Recurse -Include '*.ps1' -File | ForEach-Object { . $_.FullName }
     $cmdletNames = Get-ScriptCmdlet -ScriptFolder $exportsPath

src/Storage/Storage.Autorest/README.md

@@ -3,7 +3,6 @@
 This directory contains the PowerShell module for the Storage service.
 
 ---
-
 ## Info
 - Modifiable: yes
 - Generated: all
@@ -29,7 +28,7 @@ For information on how to develop for `Az.Storage`, see [how-to.md](how-to.md).
 
 ``` yaml
 # Please specify the commit id that includes your features to make sure generated codes stable.
-branch: 3e6b4ddca225530c27273d0f816466a905c0151b
+commit: 3e6b4ddca225530c27273d0f816466a905c0151b
 require:
 # readme.azure.noprofile.md is the common configuration file
   - $(this-folder)/../../readme.azure.noprofile.md
@@ -43,8 +42,6 @@ title: Storage
 subject-prefix: $(service-name)
 nested-object-to-string: true
 identity-correction-for-post: true 
-use-extension: 
-  "@autorest/powershell": "4.x"
 
 directive:
   - where:  

src/Storage/Storage.Autorest/UX/Microsoft.Storage/storageAccounts-accountMigrations.json

@@ -0,0 +1,47 @@
+{
+  "resourceType": "storageAccounts/accountMigrations",
+  "apiVersion": "2023-01-01",
+  "learnMore": {
+    "url": "https://learn.microsoft.com/powershell/module/az.storage"
+  },
+  "commands": [
+    {
+      "name": "Get-AzStorageAccountMigration",
+      "description": "Gets the status of the ongoing migration for the specified storage account.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/accountMigrations/{migrationName}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.storage/get-azstorageaccountmigration"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-AccountName <String>",
+              "-ResourceGroupName <String>",
+              "[-SubscriptionId <String[]>]"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Gets the status of the ongoing migration for the specified storage account.",
+          "parameters": [
+            {
+              "name": "-AccountName",
+              "value": "[Path.accountName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

src/Storage/Storage.Autorest/exports/Get-AzStorageAccountMigration.ps1

@@ -77,7 +77,6 @@ param(
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Category('Path')]
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity]
     # Identity Parameter
-    # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
     ${InputObject},
 
     [Parameter()]
@@ -159,7 +158,13 @@ begin {
             GetViaIdentity = 'Az.Storage.private\Get-AzStorageAccountMigration_GetViaIdentity';
         }
         if (('Get') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId') ) {
-            $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            $testPlayback = $false
+            $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) }
+            if ($testPlayback) {
+                $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1')
+            } else {
+                $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            }
         }
         $cmdInfo = Get-Command -Name $mapping[$parameterSet]
         [Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet)

src/Storage/Storage.Autorest/exports/ProxyCmdletDefinitions.ps1

@@ -77,7 +77,6 @@ param(
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Category('Path')]
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity]
     # Identity Parameter
-    # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
     ${InputObject},
 
     [Parameter()]
@@ -159,7 +158,13 @@ begin {
             GetViaIdentity = 'Az.Storage.private\Get-AzStorageAccountMigration_GetViaIdentity';
         }
         if (('Get') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId') ) {
-            $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            $testPlayback = $false
+            $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) }
+            if ($testPlayback) {
+                $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1')
+            } else {
+                $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            }
         }
         $cmdInfo = Get-Command -Name $mapping[$parameterSet]
         [Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet)
@@ -296,7 +301,6 @@ param(
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Category('Path')]
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity]
     # Identity Parameter
-    # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
     ${InputObject},
 
     [Parameter(ParameterSetName='CustomerExpanded', Mandatory)]
@@ -432,7 +436,13 @@ begin {
             CustomerViaJsonString = 'Az.Storage.private\Start-AzStorageAccountMigration_CustomerViaJsonString';
         }
         if (('CustomerExpanded', 'CustomerViaJsonFilePath', 'CustomerViaJsonString') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId') ) {
-            $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            $testPlayback = $false
+            $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) }
+            if ($testPlayback) {
+                $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1')
+            } else {
+                $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            }
         }
         $cmdInfo = Get-Command -Name $mapping[$parameterSet]
         [Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet)

src/Storage/Storage.Autorest/exports/Start-AzStorageAccountMigration.ps1

@@ -99,7 +99,6 @@ param(
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Category('Path')]
     [Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageIdentity]
     # Identity Parameter
-    # To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
     ${InputObject},
 
     [Parameter(ParameterSetName='CustomerExpanded', Mandatory)]
@@ -235,7 +234,13 @@ begin {
             CustomerViaJsonString = 'Az.Storage.private\Start-AzStorageAccountMigration_CustomerViaJsonString';
         }
         if (('CustomerExpanded', 'CustomerViaJsonFilePath', 'CustomerViaJsonString') -contains $parameterSet -and -not $PSBoundParameters.ContainsKey('SubscriptionId') ) {
-            $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            $testPlayback = $false
+            $PSBoundParameters['HttpPipelinePrepend'] | Foreach-Object { $testPlayback = $testPlayback -or ('Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.PipelineMock' -eq $_.Target.GetType().FullName -and 'Playback' -eq $_.Target.Mode) }
+            if ($testPlayback) {
+                $PSBoundParameters['SubscriptionId'] = . (Join-Path $PSScriptRoot '..' 'utils' 'Get-SubscriptionIdTestSafe.ps1')
+            } else {
+                $PSBoundParameters['SubscriptionId'] = (Get-AzContext).Subscription.Id
+            }
         }
         $cmdInfo = Get-Command -Name $mapping[$parameterSet]
         [Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.MessageAttributeHelper]::ProcessCustomAttributesAtRuntime($cmdInfo, $MyInvocation, $parameterSet, $PSCmdlet)

src/Storage/Storage.Autorest/generate-portal-ux.ps1

@@ -42,8 +42,6 @@ $instance = [Microsoft.Azure.PowerShell.Cmdlets.Storage.Module]::Instance
 $moduleInfo = Get-Module -Name $moduleName
 $parameterSetsInfo = Get-Module -Name "$moduleName.private"
 
-$buildinFunctions = @("Export-CmdletSurface", "Export-ExampleStub", "Export-FormatPs1xml", "Export-HelpMarkdown", "Export-ModelSurface", "Export-ProxyCmdlet", "Export-Psd1", "Export-TestStub", "Get-CommonParameter", "Get-ModuleGuid", "Get-ScriptCmdlet")
-
 function Test-FunctionSupported()
 {
     [CmdletBinding()]
@@ -53,12 +51,12 @@ function Test-FunctionSupported()
         $FunctionName
     )
 
-    If ($buildinfunctions.Contains($FunctionName)) {
+    If (-not $FunctionName.Contains("_")) {
         return $false
     }
 
     $cmdletName, $parameterSetName = $FunctionName.Split("_")
-    If ($parameterSetName.Contains("List") -or $parameterSetName.Contains("ViaIdentity")) {
+    If ($parameterSetName.Contains("List") -or $parameterSetName.Contains("ViaIdentity")  -or $parameterSetName.Contains("ViaJson")) {
         return $false
     }
     If ($cmdletName.StartsWith("New") -or $cmdletName.StartsWith("Set") -or $cmdletName.StartsWith("Update")) {
@@ -311,7 +309,7 @@ function New-MetadataForCmdlet()
     return $result
 }
 
-$parameterSets = $parameterSetsInfo.ExportedCmdlets.Keys | Where-Object { Test-functionSupported($_) }
+$parameterSets = $parameterSetsInfo.ExportedCmdlets.Keys | Where-Object { Test-FunctionSupported($_) }
 $resourceTypes = @{}
 foreach ($parameterSetName in $parameterSets)
 {

src/Storage/Storage.Autorest/generated/Module.cs

@@ -17,6 +17,8 @@ namespace Microsoft.Azure.PowerShell.Cmdlets.Storage
     using SignalDelegate = global::System.Func<string, global::System.Threading.CancellationToken, global::System.Func<global::System.EventArgs>, global::System.Threading.Tasks.Task>;
     using EventListenerDelegate = global::System.Func<string, global::System.Threading.CancellationToken, global::System.Func<global::System.EventArgs>, global::System.Func<string, global::System.Threading.CancellationToken, global::System.Func<global::System.EventArgs>, global::System.Threading.Tasks.Task>, global::System.Management.Automation.InvocationInfo, string, string, string, global::System.Exception, global::System.Threading.Tasks.Task>;
     using NextDelegate = global::System.Func<global::System.Net.Http.HttpRequestMessage, global::System.Threading.CancellationToken, global::System.Action, global::System.Func<string, global::System.Threading.CancellationToken, global::System.Func<global::System.EventArgs>, global::System.Threading.Tasks.Task>, global::System.Threading.Tasks.Task<global::System.Net.Http.HttpResponseMessage>>;
+    using SanitizerDelegate = global::System.Action<object, string>;
+    using GetTelemetryInfoDelegate = global::System.Func<string, global::System.Collections.Generic.Dictionary<global::System.String,global::System.String>>;
 
     /// <summary>A class that contains the module-common code and data.</summary>
     public partial class Module
@@ -26,12 +28,20 @@ public partial class Module
 
         public global::System.Net.Http.HttpClientHandler _handler = new global::System.Net.Http.HttpClientHandler();
 
+        private static bool _init = false;
+
+        private static readonly global::System.Object _initLock = new global::System.Object();
+
+        private static Microsoft.Azure.PowerShell.Cmdlets.Storage.Module _instance;
+
         /// <summary>the ISendAsync pipeline instance</summary>
         private Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.HttpPipeline _pipeline;
 
         /// <summary>the ISendAsync pipeline instance (when proxy is enabled)</summary>
         private Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.HttpPipeline _pipelineWithProxy;
 
+        private static readonly global::System.Object _singletonLock = new global::System.Object();
+
         public bool _useProxy = false;
 
         public global::System.Net.WebProxy _webProxy = new global::System.Net.WebProxy();
@@ -51,11 +61,11 @@ public partial class Module
         /// <summary>The delegate to get the telemetry Id.</summary>
         public GetTelemetryIdDelegate GetTelemetryId { get; set; }
 
-        /// <summary>Backing field for <see cref="Instance" /> property.</summary>
-        private static Microsoft.Azure.PowerShell.Cmdlets.Storage.Module _instance;
+        /// <summary>The delegate to get the telemetry info.</summary>
+        public GetTelemetryInfoDelegate GetTelemetryInfo { get; set; }
 
         /// <summary>the singleton of this module class</summary>
-        public static Microsoft.Azure.PowerShell.Cmdlets.Storage.Module Instance => Microsoft.Azure.PowerShell.Cmdlets.Storage.Module._instance?? (Microsoft.Azure.PowerShell.Cmdlets.Storage.Module._instance = new Microsoft.Azure.PowerShell.Cmdlets.Storage.Module());
+        public static Microsoft.Azure.PowerShell.Cmdlets.Storage.Module Instance { get { if (_instance == null) { lock (_singletonLock) { if (_instance == null) { _instance = new Module(); }}} return _instance; } }
 
         /// <summary>The Name of this module</summary>
         public string Name => @"Az.Storage";
@@ -72,6 +82,9 @@ public partial class Module
         /// <summary>The ResourceID for this module (azure arm).</summary>
         public string ResourceId => @"Az.Storage";
 
+        /// <summary>The delegate to call in WriteObject to sanitize the output object.</summary>
+        public SanitizerDelegate SanitizeOutput { get; set; }
+
         /// <summary>The delegate for creating a telemetry.</summary>
         public TelemetryDelegate Telemetry { get; set; }
 
@@ -117,9 +130,17 @@ public Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.HttpPipeline CreatePip
         /// <summary>Initialization steps performed after the module is loaded.</summary>
         public void Init()
         {
-            OnModuleLoad?.Invoke( ResourceId, Name ,(step)=> { _pipeline.Prepend(step); } , (step)=> { _pipeline.Append(step); } );
-            OnModuleLoad?.Invoke( ResourceId, Name ,(step)=> { _pipelineWithProxy.Prepend(step); } , (step)=> { _pipelineWithProxy.Append(step); } );
-            CustomInit();
+            if (_init == false)
+            {
+                lock (_initLock) {
+                    if (_init == false) {
+                        OnModuleLoad?.Invoke( ResourceId, Name ,(step)=> { _pipeline.Prepend(step); } , (step)=> { _pipeline.Append(step); } );
+                        OnModuleLoad?.Invoke( ResourceId, Name ,(step)=> { _pipelineWithProxy.Prepend(step); } , (step)=> { _pipelineWithProxy.Append(step); } );
+                        CustomInit();
+                        _init = true;
+                    }
+                }
+            }
         }
 
         /// <summary>Creates the module instance.</summary>

src/Storage/Storage.Autorest/generated/api/Models/AccountImmutabilityPolicyProperties.json.cs

@@ -65,9 +65,9 @@ internal AccountImmutabilityPolicyProperties(Microsoft.Azure.PowerShell.Cmdlets.
             {
                 return;
             }
-            {_immutabilityPeriodSinceCreationInDay = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonNumber>("immutabilityPeriodSinceCreationInDays"), out var __jsonImmutabilityPeriodSinceCreationInDays) ? (int?)__jsonImmutabilityPeriodSinceCreationInDays : ImmutabilityPeriodSinceCreationInDay;}
-            {_state = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonString>("state"), out var __jsonState) ? (string)__jsonState : (string)State;}
-            {_allowProtectedAppendWrite = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonBoolean>("allowProtectedAppendWrites"), out var __jsonAllowProtectedAppendWrites) ? (bool?)__jsonAllowProtectedAppendWrites : AllowProtectedAppendWrite;}
+            {_immutabilityPeriodSinceCreationInDay = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonNumber>("immutabilityPeriodSinceCreationInDays"), out var __jsonImmutabilityPeriodSinceCreationInDays) ? (int?)__jsonImmutabilityPeriodSinceCreationInDays : _immutabilityPeriodSinceCreationInDay;}
+            {_state = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonString>("state"), out var __jsonState) ? (string)__jsonState : (string)_state;}
+            {_allowProtectedAppendWrite = If( json?.PropertyT<Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.Json.JsonBoolean>("allowProtectedAppendWrites"), out var __jsonAllowProtectedAppendWrites) ? (bool?)__jsonAllowProtectedAppendWrites : _allowProtectedAppendWrite;}
             AfterFromJson(json);
         }