From 97cd9481ce9f8b216a168bcd257f2342e2497f60 Mon Sep 17 00:00:00 2001 From: lijinpei2008 <31384087+lijinpei2008@users.noreply.github.com> Date: Mon, 18 Nov 2024 21:12:08 +0800 Subject: [PATCH] Update migration guide. (#26723) * update file * update * update --- .../Az.13.0.0-migration-guide.md | 148 ++++++------------ 1 file changed, 51 insertions(+), 97 deletions(-) diff --git a/documentation/migration-guides/Az.13.0.0-migration-guide.md b/documentation/migration-guides/Az.13.0.0-migration-guide.md index 056ddc2c903c..d1cb34285913 100644 --- a/documentation/migration-guides/Az.13.0.0-migration-guide.md +++ b/documentation/migration-guides/Az.13.0.0-migration-guide.md @@ -154,11 +154,10 @@ Default value of `-PublicIpSku` will be Standard if it is not specified #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -167,12 +166,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; ``` - ProvisioningState is type System.String - HardwareProfileSKuName is type System.String -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -183,7 +180,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the - ProvisioningState is type DevBoxProvisioningState. Possible values will be Creating, Deleting, Failed, InGracePeriod, NotProvisioned, ProvisionedWithWarning, Provisioning, Starting, Stopping, Succeeded, Updating. - HardwareProfileSKuName is type SkuName. Possible values will be general_a_16c64gb1024ssd_v2, general_a_16c64gb2048ssd_v2, general_a_16c64gb256ssd_v2, general_a_16c64gb512ssd_v2, general_a_32c128gb1024ssd_v2, general_a_32c128gb2048ssd_v2, general_a_32c128gb512ssd_v2, general_a_8c32gb1024ssd_v2, general_a_8c32gb2048ssd_v2, general_a_8c32gb256ssd_v2, general_a_8c32gb512ssd_v2, general_i_16c64gb1024ssd_v2, general_i_16c64gb2048ssd_v2, general_i_16c64gb256ssd_v2, general_i_16c64gb512ssd_v2, general_i_32c128gb1024ssd_v2, general_i_32c128gb2048ssd_v2, general_i_32c128gb512ssd_v2, general_i_8c32gb1024ssd_v2, general_i_8c32gb2048ssd_v2, general_i_8c32gb256ssd_v2, general_i_8c32gb512ssd_v2 -``` ### `Get-AzDevCenterUserDevBoxOperation` @@ -197,10 +193,9 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -209,12 +204,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; ``` - Status is type DevBoxOperationStatus -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -224,7 +217,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the ``` - Status is type OperationState. The possible values are the same (Canceled, Failed, NotStarted, Running, Succeeded). The change is a rename from DevBoxOperationStatus to OperationState. -``` ### `Get-AzDevCenterUserEnvironment` @@ -238,10 +230,9 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -250,12 +241,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; ``` - ProvisioningState is type System.String -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -265,7 +254,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the ``` - ProvisioningState is type EnvironmentProvisioningState. Possible values will be Accepted, Canceled, Creating, Deleting, Failed, MovingResources, Preparing, Running, StorageProvisioningFailed, Succeeded, Syncing, TransientFailure, Updating. -``` ### `Get-AzDevCenterUserEnvironmentAction` @@ -280,11 +268,11 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before ```powershell -- NextScheduledTime is type System.DateTime +NextScheduledTime is type System.DateTime ``` #### After ```powershell -- NextScheduledTime is type nullable System.DateTime +NextScheduledTime is type nullable System.DateTime ``` @@ -308,13 +296,13 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After ```powershell --Output type is string representation of logs --Outfile parameter is removed --Passthru parameter is removed +Output type is string representation of logs +Outfile parameter is removed +Passthru parameter is removed ``` @@ -329,10 +317,9 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -342,12 +329,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; -Status is type EnvironmentOperationStatus -EnvironmentParameter is type IAny -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -360,7 +345,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the -EnvironmentParameter is type EnvironmentOperationEnvironmentParameters. This is serializable to JSON and to function as an associative array (dictionary) of objects -``` ### `Get-AzDevCenterUserPool` @@ -375,11 +359,11 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before ```powershell -- HardwareProfileSKuName is type System.String +HardwareProfileSKuName is type System.String ``` #### After ```powershell -- HardwareProfileSKuName is type SkuName. Possible values will be general_a_16c64gb1024ssd_v2, general_a_16c64gb2048ssd_v2, general_a_16c64gb256ssd_v2, general_a_16c64gb512ssd_v2, general_a_32c128gb1024ssd_v2, general_a_32c128gb2048ssd_v2, general_a_32c128gb512ssd_v2, general_a_8c32gb1024ssd_v2, general_a_8c32gb2048ssd_v2, general_a_8c32gb256ssd_v2, general_a_8c32gb512ssd_v2, general_i_16c64gb1024ssd_v2, general_i_16c64gb2048ssd_v2, general_i_16c64gb256ssd_v2, general_i_16c64gb512ssd_v2, general_i_32c128gb1024ssd_v2, general_i_32c128gb2048ssd_v2, general_i_32c128gb512ssd_v2, general_i_8c32gb1024ssd_v2, general_i_8c32gb2048ssd_v2, general_i_8c32gb256ssd_v2, general_i_8c32gb512ssd_v2 +HardwareProfileSKuName is type SkuName. Possible values will be general_a_16c64gb1024ssd_v2, general_a_16c64gb2048ssd_v2, general_a_16c64gb256ssd_v2, general_a_16c64gb512ssd_v2, general_a_32c128gb1024ssd_v2, general_a_32c128gb2048ssd_v2, general_a_32c128gb512ssd_v2, general_a_8c32gb1024ssd_v2, general_a_8c32gb2048ssd_v2, general_a_8c32gb256ssd_v2, general_a_8c32gb512ssd_v2, general_i_16c64gb1024ssd_v2, general_i_16c64gb2048ssd_v2, general_i_16c64gb256ssd_v2, general_i_16c64gb512ssd_v2, general_i_32c128gb1024ssd_v2, general_i_32c128gb2048ssd_v2, general_i_32c128gb512ssd_v2, general_i_8c32gb1024ssd_v2, general_i_8c32gb2048ssd_v2, general_i_8c32gb256ssd_v2, general_i_8c32gb512ssd_v2 ``` @@ -394,22 +378,19 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. Target : resourceName Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}, @{Code=ResourceGroupNotFound; Message=The specified resource group does not exist.; Target=resourceGroupName}} ``` -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -418,7 +399,6 @@ Detail : {@{Code=MissingParameter; Message=A required parameter is missing.; Innererror : @{Code=InnerErrorCode; Message=More specific information about the error.} ``` -``` ### `Invoke-AzDevCenterUserDelayEnvironmentAction` @@ -433,11 +413,11 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before ```powershell -- NextScheduledTime is type System.DateTime +NextScheduledTime is type System.DateTime ``` #### After ```powershell -- NextScheduledTime is type nullable System.DateTime +NextScheduledTime is type nullable System.DateTime ``` @@ -452,11 +432,10 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -466,12 +445,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; - ProvisioningState is type System.String - HardwareProfileSKuName is type System.String -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -482,7 +459,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the - ProvisioningState is type DevBoxProvisioningState. Possible values will be Creating, Deleting, Failed, InGracePeriod, NotProvisioned, ProvisionedWithWarning, Provisioning, Starting, Stopping, Succeeded, Updating. - HardwareProfileSKuName is type SkuName. Possible values will be general_a_16c64gb1024ssd_v2, general_a_16c64gb2048ssd_v2, general_a_16c64gb256ssd_v2, general_a_16c64gb512ssd_v2, general_a_32c128gb1024ssd_v2, general_a_32c128gb2048ssd_v2, general_a_32c128gb512ssd_v2, general_a_8c32gb1024ssd_v2, general_a_8c32gb2048ssd_v2, general_a_8c32gb256ssd_v2, general_a_8c32gb512ssd_v2, general_i_16c64gb1024ssd_v2, general_i_16c64gb2048ssd_v2, general_i_16c64gb256ssd_v2, general_i_16c64gb512ssd_v2, general_i_32c128gb1024ssd_v2, general_i_32c128gb2048ssd_v2, general_i_32c128gb512ssd_v2, general_i_8c32gb1024ssd_v2, general_i_8c32gb2048ssd_v2, general_i_8c32gb256ssd_v2, general_i_8c32gb512ssd_v2 -``` ### `Update-AzDevCenterUserEnvironment` @@ -494,10 +470,9 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the - The change is expected to take effect from version : '2.0.0' #### Before -```powershell - Detail is type CloudErrorBody. CloudErrorBody uses a List for the Detail property. -Example output for Details: +- Example output for Details: ```powershell Code : ResourceNotFound Message : The specified resource does not exist. @@ -506,12 +481,10 @@ Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; ``` - ProvisioningState is type System.String -``` #### After -```powershell - Detail is type AzureCoreFoundationsError. Innererror property is added for additional error information. AzureCoreFoundationsError uses an array of IAzureCoreFoundationsError for the Detail property. -Example output for Detail: +- Example output for Detail: ```powershell Code : InvalidRequest Message : The request is invalid. @@ -521,7 +494,6 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the ``` - ProvisioningState is type EnvironmentProvisioningState. Possible values will be Accepted, Canceled, Creating, Deleting, Failed, MovingResources, Preparing, Running, StorageProvisioningFailed, Succeeded, Syncing, TransientFailure, Updating. -``` ### `Deploy-AzDevCenterUserEnvironment` @@ -532,13 +504,12 @@ Innererror : @{Code=InnerErrorCode; Message=More specific information about the #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is Environment +- Output type is Environment -Example output: +- Example output: ```powershell Name : myEnvironment EnvironmentType : dev @@ -547,7 +518,6 @@ ProvisioningState : Succeeded CatalogName : devCatalog EnvironmentDefinitionName: FunctionApp ``` -``` ### `Get-AzDevCenterUserCatalog` @@ -558,17 +528,15 @@ EnvironmentDefinitionName: FunctionApp #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is Catalog +- Output type is Catalog -Example output: +- Example output: ```powershell Name: myCatalogName ``` -``` ### `New-AzDevCenterUserEnvironment` @@ -579,13 +547,12 @@ Name: myCatalogName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is Environment +- Output type is Environment -Example output: +- Example output: ```powershell Name : myEnvironment EnvironmentType : dev @@ -594,7 +561,6 @@ ProvisioningState : Succeeded CatalogName : devCatalog EnvironmentDefinitionName: FunctionApp ``` -``` ### `Remove-AzDevCenterUserDevBox` @@ -605,12 +571,11 @@ EnvironmentDefinitionName: FunctionApp #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -628,7 +593,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ### `Remove-AzDevCenterUserEnvironment` @@ -639,12 +603,11 @@ Target : resourceName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -662,7 +625,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ### `Repair-AzDevCenterUserDevBox` @@ -673,12 +635,11 @@ Target : resourceName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -696,7 +657,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ### `Restart-AzDevCenterUserDevBox` @@ -707,12 +667,11 @@ Target : resourceName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -730,7 +689,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ### `Start-AzDevCenterUserDevBox` @@ -741,12 +699,11 @@ Target : resourceName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -764,7 +721,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ### `Stop-AzDevCenterUserDevBox` @@ -775,12 +731,11 @@ Target : resourceName #### Before ```powershell --Output type is Boolean +Output type is Boolean ``` #### After -```powershell --Output type is OperationStatus -Example output: +- Output type is OperationStatus +- Example output: ```powershell Code : ResourceNotFound Detail : {@{Code=InvalidResourceName; Message=The resource name is invalid.; Target=resourceName}} @@ -798,7 +753,6 @@ StartTime : 10/1/2023 12:00:00 PM Status : Succeeded Target : resourceName ``` -``` ## Az.ElasticSan