SpotPlacementRecommender resource split (#25361)

* Initial commit - target latest swagger commit 6f498e0646e1bb978b8b6f8b4e701938dd79df2b and new swagger file specification/compute/resource-manager/Microsoft.Compute/DiagnosticRP/preview/2024-06-01-preview/diagnostic.json

* Generate test files, remove Invoke-SpotPlacementRecommender files, flesh out example files and add all auto generated changes

* Adding Example 4: Zonally scoped Spot Placement scores using SpotPlacementScoresInput parameter as argument

* Adding Invoke-AzSpotPlacementRecommender back in

* Adding fixed test files for AzSpotPlacementRecommender

* test alias

* test alias

* test alias

* test alias

* test alias

* param alias

* supress false positive

* Update BreakingChangeIssues.csv

* Revert all auto-generated changes to files outside of Spot API cmdlets

* Adding link to Spot API public doc in description

* Added same message in Synopsis section

---------

Co-authored-by: Nori Zhang <norizhang@microsoft.com>
Co-authored-by: NoriZC <110961157+NoriZC@users.noreply.github.com>

Author: Elina-L

src/Compute/Compute.Autorest/Az.Compute.psd1

@@ -11,8 +11,8 @@
   DotNetFrameworkVersion = '4.7.2'
   RequiredAssemblies = './bin/Az.Compute.private.dll'
   FormatsToProcess = './Az.Compute.format.ps1xml'
-  FunctionsToExport = 'Get-AzGalleryApplication', 'Get-AzGalleryApplicationVersion', 'Invoke-AzSpotPlacementRecommender', 'New-AzGalleryApplication', 'New-AzGalleryApplicationVersion', 'Remove-AzGalleryApplication', 'Remove-AzGalleryApplicationVersion', 'Remove-AzVMRunCommand', 'Remove-AzVmssVMRunCommand', 'Set-AzVMRunCommand', 'Set-AzVmssVMRunCommand', 'Update-AzGalleryApplication', 'Update-AzGalleryApplicationVersion', '*'
-  AliasesToExport = '*'
+  FunctionsToExport = 'Get-AzGalleryApplication', 'Get-AzGalleryApplicationVersion', 'Invoke-AzSpotPlacementScore', 'New-AzGalleryApplication', 'New-AzGalleryApplicationVersion', 'Remove-AzGalleryApplication', 'Remove-AzGalleryApplicationVersion', 'Remove-AzVMRunCommand', 'Remove-AzVmssVMRunCommand', 'Set-AzVMRunCommand', 'Set-AzVmssVMRunCommand', 'Update-AzGalleryApplication', 'Update-AzGalleryApplicationVersion', '*'
+  AliasesToExport = 'Invoke-AzSpotPlacementRecommender', '*'
   PrivateData = @{
     PSData = @{
       Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'Compute'

src/Compute/Compute.Autorest/README.md

@@ -26,7 +26,7 @@ For information on how to develop for `Az.Compute`, see [how-to.md](how-to.md).
 ### AutoRest Configuration
 > see https://aka.ms/autorest
 ``` yaml
-commit: 77c47a7fba8d8b900595966b81d6bb92a0308370
+commit: 6f498e0646e1bb978b8b6f8b4e701938dd79df2b
 require:
 # readme.azure.noprofile.md is the common configuration file
   - $(this-folder)/../../readme.azure.noprofile.md
@@ -35,7 +35,7 @@ input-file:
   - $(repo)/specification/compute/resource-manager/Microsoft.Compute/GalleryRP/stable/2022-01-03/gallery.json
   - $(repo)/specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-07-01/runCommand.json
   - $(repo)/specification/compute/resource-manager/Microsoft.Compute/common-types/v1/common.json
-  - $(repo)/specification/compute/resource-manager/Microsoft.Compute/DiagnosticRP/preview/2024-03-01-preview/diagnostic.json
+  - $(repo)/specification/compute/resource-manager/Microsoft.Compute/DiagnosticRP/preview/2024-06-01-preview/diagnostic.json
 # If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally
 module-version: 0.3.0
 # Normally, title is the service name
@@ -233,7 +233,7 @@ directive:
       subject: VMRunCommand|VmssVMRunCommand
       verb: Get
     remove: true
-  ### Remove All Diagnostic cmdlets aside from Invoke Spot Placement Recommender - generate ONLY SpotPlacementRecommender cmdlets
+  ### Remove All Diagnostic cmdlets aside from Invoke Spot Placement Recommender - generate ONLY SpotPlacementScore cmdlets
   - where:
       verb: Get
       subject: Diagnostic
@@ -262,4 +262,23 @@ directive:
       verb: Get
       subject: SpotPlacementRecommender
     remove: true
+  - where:
+      verb: Get
+      subject: SpotPlacementScore
+    remove: true
+
+  ## Add Alias for Invoke-AzSpotPlacementScore
+  - where:
+      verb: Invoke
+      subject: SpotPlacementRecommender
+    remove: true
+  - where:
+      verb: Invoke
+      subject: SpotPlacementScore
+    set:
+      alias: Invoke-AzSpotPlacementRecommender
+  - where:
+      parameter-name: SpotPlacementScoresInput
+    set:
+      alias: SpotPlacementRecommenderInput
 ```

src/Compute/Compute.Autorest/UX/Microsoft.Compute/locations.json

@@ -1,17 +1,17 @@
 {
   "resourceType": "locations",
-  "apiVersion": "2021-06-01-preview",
+  "apiVersion": "2024-06-01-preview",
   "learnMore": {
     "url": "https://learn.microsoft.com/powershell/module/az.compute"
   },
   "commands": [
     {
-      "name": "Invoke-AzSpotPlacementRecommender",
+      "name": "Invoke-AzSpotPlacementScore",
       "description": "Generates placement scores for Spot VM skus.",
-      "path": "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/diagnostics/spotPlacementRecommender/generate",
+      "path": "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/placementScores/spot/generate",
       "help": {
         "learnMore": {
-          "url": "https://learn.microsoft.com/powershell/module/az.compute/invoke-azspotplacementrecommender"
+          "url": "https://learn.microsoft.com/powershell/module/az.compute/invoke-azspotplacementscore"
         },
         "parameterSets": [
           {

src/Compute/Compute.Autorest/docs/Az.Compute.md

@@ -11,15 +11,15 @@ Locale: en-US
 Microsoft Azure PowerShell: Compute cmdlets
 
 ## Az.Compute Cmdlets
-### [Invoke-AzSpotPlacementRecommender](Invoke-AzSpotPlacementRecommender.md)
-Generates placement scores for Spot VM skus.
-
 ### [Get-AzGalleryApplication](Get-AzGalleryApplication.md)
 Retrieves information about a gallery Application Definition.
 
 ### [Get-AzGalleryApplicationVersion](Get-AzGalleryApplicationVersion.md)
 Retrieves information about a gallery Application Version.
 
+### [Invoke-AzSpotPlacementScore](Invoke-AzSpotPlacementScore.md)
+Generates placement scores for Spot VM skus.
+
 ### [New-AzGalleryApplication](New-AzGalleryApplication.md)
 Create or update a gallery Application Definition.
 

src/Compute/Compute.Autorest/docs/Invoke-AzSpotPlacementRecommender.md renamed to src/Compute/Compute.Autorest/docs/Invoke-AzSpotPlacementScore.md

@@ -1,45 +1,59 @@
 ---
 external help file:
 Module Name: Az.Compute
-online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azspotplacementrecommender
+online version: https://learn.microsoft.com/powershell/module/az.compute/invoke-azspotplacementscore
 schema: 2.0.0
 ---
 
-# Invoke-AzSpotPlacementRecommender
+# Invoke-AzSpotPlacementScore
 
 ## SYNOPSIS
-Generates placement scores for Spot VM skus.
+Generates placement scores for Spot VM skus. This cmdlet calls the Spot Placement Scores API which is in preview. More information about this API can be found [here](https://learn.microsoft.com/rest/api/compute/spot-placement-scores/post).
+
 
 ## SYNTAX
 
 ### PostExpanded (Default)
 ```
-Invoke-AzSpotPlacementRecommender -Location <String> [-SubscriptionId <String>] [-AvailabilityZone]
+Invoke-AzSpotPlacementScore -Location <String> [-SubscriptionId <String>] [-AvailabilityZone]
  [-DesiredCount <Int32>] [-DesiredLocation <String[]>] [-DesiredSize <IResourceSize[]>]
  [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
 ```
 
 ### Post
 ```
-Invoke-AzSpotPlacementRecommender -Location <String>
- -SpotPlacementRecommenderInput <ISpotPlacementRecommenderInput> [-SubscriptionId <String>]
- [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
+Invoke-AzSpotPlacementScore -Location <String> -SpotPlacementScoresInput <ISpotPlacementScoresInput>
+ [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
+```
+
+### PostViaIdentity
+```
+Invoke-AzSpotPlacementScore -InputObject <IComputeIdentity>
+ -SpotPlacementScoresInput <ISpotPlacementScoresInput> [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf]
+ [<CommonParameters>]
+```
+
+### PostViaIdentityExpanded
+```
+Invoke-AzSpotPlacementScore -InputObject <IComputeIdentity> [-AvailabilityZone] [-DesiredCount <Int32>]
+ [-DesiredLocation <String[]>] [-DesiredSize <IResourceSize[]>] [-DefaultProfile <PSObject>] [-Confirm]
+ [-WhatIf] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-Generates placement scores for Spot VM skus.
+Generates placement scores for Spot VM skus. This cmdlet calls the Spot Placement Scores API which is in preview. More information about this API can be found [here](https://learn.microsoft.com/rest/api/compute/spot-placement-scores/post).
 
 ## EXAMPLES
 
-### Example 1: Regionally scoped Spot Placement Recommender scores
+### Example 1: Regionally scoped Spot Placement scores
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
+$response = Invoke-AzSpotPlacementScore -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
 $response.PlacementScore
 ```
 
@@ -57,17 +71,17 @@ AvailabilityZone IsQuotaAvailable Region         Score                     Sku
                  True             centralus      RestrictedSkuNotAvailable Standard_D4_v3
 ```
 
-Returns regionally scoped spot placement recommender scores for the input.
+Returns regionally scoped spot placement scores for the input.
 
-### Example 2: Zonally scoped Spot Placement Recommender scores
+### Example 2: Zonally scoped Spot Placement Scores
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -AvailabilityZone
+$response = Invoke-AzSpotPlacementScore -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -AvailabilityZone
 $response.PlacementScore
 ```
 
@@ -103,9 +117,9 @@ AvailabilityZone IsQuotaAvailable Region         Score               Sku
 3                True             centralus      High                Standard_D4_v3
 ```
 
-Returns zonally scoped spot placement recommender scores for the input.
+Returns zonally scoped spot placement scores for the input.
 
-### Example 3: Regionally scoped Spot Placement Recommender scores using SpotPlacementRecommenderInput parameter as argument
+### Example 3: Regionally scoped Spot Placement Scores using SpotPlacementScoresInput parameter as argument
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
@@ -114,9 +128,9 @@ $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 $desiredCount = 1
 
-$spotPlacementRecommenderInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $false}
+$spotPlacementScoresInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $false}
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -SpotPlacementRecommenderInput $spotPlacementRecommenderInput
+$response = Invoke-AzSpotPlacementScore -Location eastus -SpotPlacementScoresInput $spotPlacementScoresInput
 $response.PlacementScore
 ```
 
@@ -134,20 +148,18 @@ AvailabilityZone IsQuotaAvailable Region         Score                     Sku
                  True             centralus      RestrictedSkuNotAvailable Standard_D4_v3
 ```
 
-Returns regionally scoped spot placement recommender scores for the input.
+Returns regionally scoped spot placement scores for the input.
 
-### Example 2: Zonally scoped Spot Placement Recommender scores using SpotPlacementRecommenderInput parameter as argument
+### Example 4: Zonally scoped Spot Placement scores using SpotPlacementScoresInput parameter as argument
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 $desiredCount = 1
-
-$spotPlacementRecommenderInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $true}
-
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -SpotPlacementRecommenderInput $spotPlacementRecommenderInput
+$spotPlacementScoresInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $true}
+$response = Invoke-AzSpotPlacementScore -Location eastus -SpotPlacementScoresInput $spotPlacementScoresInput
 $response.PlacementScore
 ```
 
@@ -183,7 +195,7 @@ AvailabilityZone IsQuotaAvailable Region         Score Sku
 3                True             centralus      High  Standard_D4_v3
 ```
 
-Returns zonally scoped spot placement recommender scores for the input.
+Returns zonally scoped spot placement scores for the input.
 
 ## PARAMETERS
 
@@ -253,7 +265,7 @@ The desired resource SKUs.
 To construct, see NOTES section for DESIREDSIZE properties and create a hash table.
 
 ```yaml
-Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210601Preview.IResourceSize[]
+Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20240601Preview.IResourceSize[]
 Parameter Sets: PostExpanded, PostViaIdentityExpanded
 Aliases:
 
@@ -295,6 +307,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -SpotPlacementScoresInput
+SpotPlacementScores API Input.
+To construct, see NOTES section for SPOTPLACEMENTSCORESINPUT properties and create a hash table.
+
+```yaml
+Type: Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20240601Preview.ISpotPlacementScoresInput
+Parameter Sets: Post, PostViaIdentity
+Aliases: SpotPlacementRecommenderInput
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
 ### -SubscriptionId
 Subscription credentials which uniquely identify Microsoft Azure subscription.
 The subscription ID forms part of the URI for every service call.
@@ -347,13 +375,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
+### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20240601Preview.ISpotPlacementScoresInput
+
 ### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.IComputeIdentity
 
 ## OUTPUTS
 
-### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20210601Preview.ISpotPlacementRecommenderResponse
+### Microsoft.Azure.PowerShell.Cmdlets.Compute.Models.Api20240601Preview.ISpotPlacementScoresResponse
 
 ## NOTES
 
+ALIASES
+
+Invoke-AzSpotPlacementRecommender
+
 ## RELATED LINKS
 

src/Compute/Compute.Autorest/examples/Invoke-AzSpotPlacementRecommender.md renamed to src/Compute/Compute.Autorest/examples/Invoke-AzSpotPlacementScore.md

@@ -1,12 +1,12 @@
-### Example 1: Regionally scoped Spot Placement Recommender scores
+### Example 1: Regionally scoped Spot Placement scores
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
+$response = Invoke-AzSpotPlacementScore -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes
 $response.PlacementScore
 ```
 
@@ -24,17 +24,17 @@ AvailabilityZone IsQuotaAvailable Region         Score                     Sku
                  True             centralus      RestrictedSkuNotAvailable Standard_D4_v3
 ```
 
-Returns regionally scoped spot placement recommender scores for the input.
+Returns regionally scoped spot placement scores for the input.
 
-### Example 2: Zonally scoped Spot Placement Recommender scores
+### Example 2: Zonally scoped Spot Placement Scores
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -AvailabilityZone
+$response = Invoke-AzSpotPlacementScore -Location eastus -DesiredCount 1 -DesiredLocation $desiredLocations -DesiredSize $desiredSizes -AvailabilityZone
 $response.PlacementScore
 ```
 
@@ -70,9 +70,9 @@ AvailabilityZone IsQuotaAvailable Region         Score               Sku
 3                True             centralus      High                Standard_D4_v3
 ```
 
-Returns zonally scoped spot placement recommender scores for the input.
+Returns zonally scoped spot placement scores for the input.
 
-### Example 3: Regionally scoped Spot Placement Recommender scores using SpotPlacementRecommenderInput parameter as argument
+### Example 3: Regionally scoped Spot Placement Scores using SpotPlacementScoresInput parameter as argument
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
@@ -81,9 +81,9 @@ $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 $desiredCount = 1
 
-$spotPlacementRecommenderInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $false}
+$spotPlacementScoresInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $false}
 
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -SpotPlacementRecommenderInput $spotPlacementRecommenderInput
+$response = Invoke-AzSpotPlacementScore -Location eastus -SpotPlacementScoresInput $spotPlacementScoresInput
 $response.PlacementScore
 ```
 
@@ -101,20 +101,18 @@ AvailabilityZone IsQuotaAvailable Region         Score                     Sku
                  True             centralus      RestrictedSkuNotAvailable Standard_D4_v3
 ```
 
-Returns regionally scoped spot placement recommender scores for the input.
+Returns regionally scoped spot placement scores for the input.
 
-### Example 2: Zonally scoped Spot Placement Recommender scores using SpotPlacementRecommenderInput parameter as argument
+### Example 4: Zonally scoped Spot Placement scores using SpotPlacementScoresInput parameter as argument
 ```powershell
 $resourceSku1 = @{sku = "Standard_D2_v3"}
 $resourceSku2 = @{sku = "Standard_D2_v2"}
 $resourceSku3 = @{sku = "Standard_D4_v3"}
 $desiredSizes = $resourceSku1,$resourceSku2,$resourceSku3
 $desiredLocations = 'japaneast','southcentralus','centralus'
 $desiredCount = 1
-
-$spotPlacementRecommenderInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $true}
-
-$response = Invoke-AzSpotPlacementRecommender -Location eastus -SpotPlacementRecommenderInput $spotPlacementRecommenderInput
+$spotPlacementScoresInput = @{desiredLocation = $desiredLocations; desiredSize = $desiredSizes; desiredCount = $desiredCount; availabilityZone = $true}
+$response = Invoke-AzSpotPlacementScore -Location eastus -SpotPlacementScoresInput $spotPlacementScoresInput
 $response.PlacementScore
 ```
 
@@ -150,4 +148,4 @@ AvailabilityZone IsQuotaAvailable Region         Score Sku
 3                True             centralus      High  Standard_D4_v3
 ```
 
-Returns zonally scoped spot placement recommender scores for the input.
+Returns zonally scoped spot placement scores for the input.