[Az.Migrate] Adding Tagging, CRN feature for Migrate and few fixes (#15520)

* move to 2021 swagger

* Changing default recovery for CBT

* Azure Migrate Initialize Replication Infrastructure UserObject cmdlet fix

* Included SQL License Type and Resource Tagging Feature

* Simplified Set-AzMigrateServerReplication.ps1 to avoid repetition of code

* Few fixes in Set-AzMigrateServerReplication.ps1

* Changes in New-AzMigrateServerReplication.ps1

* Changed Variable Name

* Removed SeedDiskTag

* Updated SQL Server License Type Summary and fixed tag Count issue.

* Adding CRN feature.

* Error msg change

* Recorded tests

* Tagging change as per design review

* Adding error msg when tag key is passed as empty string

* Fix in Nickname spelling

* add breaking change and signature suppression

* Test fixed

Co-authored-by: Prachetos Sadhukhan <[email protected]>
Co-authored-by: Yeming Liu <[email protected]>

Author: 3 people

src/Migrate/custom/Get-AzMigrateJob.ps1

@@ -22,7 +22,7 @@ The Get-AzMigrateJob cmdlet retrives the status of an Azure Migrate job.
 https://docs.microsoft.com/powershell/module/az.migrate/get-azmigratejob
 #>
 function Get-AzMigrateJob {
-    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IJob])]
+    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IJob])]
     [CmdletBinding(DefaultParameterSetName = 'ListByName', PositionalBinding = $false)]
     param(
         [Parameter(ParameterSetName = 'GetById', Mandatory)]
@@ -53,7 +53,7 @@ function Get-AzMigrateJob {
 
         [Parameter(ParameterSetName = 'GetByInputObject', Mandatory)]
         [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')]
-        [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IJob]
+        [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IJob]
         # Specifies the job object of the replicating server.
         ${InputObject},
 

src/Migrate/custom/Get-AzMigrateServerReplication.ps1

@@ -22,7 +22,7 @@ The Get-AzMigrateServerReplication cmdlet retrieves the object for the replicati
 https://docs.microsoft.com/powershell/module/az.migrate/get-azmigrateserverreplication
 #>
 function Get-AzMigrateServerReplication {
-    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IMigrationItem])]
+    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IMigrationItem])]
     [CmdletBinding(DefaultParameterSetName = 'ListByName', PositionalBinding = $false)]
     param(
         [Parameter(ParameterSetName = 'GetBySRSID', Mandatory)]
@@ -53,7 +53,7 @@ function Get-AzMigrateServerReplication {
 
         [Parameter(ParameterSetName = 'GetByInputObject', Mandatory)]
         [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')]
-        [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IMigrationItem]
+        [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IMigrationItem]
         # Specifies the machine object of the replicating server.
         ${InputObject},
 

src/Migrate/custom/Initialize-AzMigrateReplicationInfrastructure.ps1

@@ -159,6 +159,28 @@ function Initialize-AzMigrateReplicationInfrastructure {
         $LogStringCreated = "Created : "
         $LogStringSkipping = " already exists."
 
+        $userObject = Get-AzADUser -UserPrincipalName $context.Subscription.ExtendedProperties.Account
+
+        if (-not $userObject) {
+            $userObject = Get-AzADUser -Mail $context.Subscription.ExtendedProperties.Account
+        }
+
+        if (-not $userObject) {
+            $mailNickname = "{0}#EXT#" -f $($context.Account.Id -replace '@', '_')
+
+            $userObject = Get-AzADUser | 
+                Where-Object {$_.MailNickname -eq $mailNickname}
+        }
+
+        if (-not $userObject) {
+            $userObject = Get-AzADServicePrincipal -ApplicationID $context.Account.Id
+        }
+
+        if (-not $userObject)
+        {
+            throw 'User Object Id Not Found!'
+        }
+
         # Hash code source code
         $Source = @"
 using System;
@@ -181,10 +203,13 @@ public static int hashForArtifact(String artifact)
 
         #Get vault name from SMS solution.
         $smsSolution = Get-AzMigrateSolution -MigrateProjectName $ProjectName -ResourceGroupName $ResourceGroupName -Name "Servers-Migration-ServerMigration"
+        if (-not $smsSolution.DetailExtendedDetail.AdditionalProperties.vaultId) {
+            throw 'Azure Migrate appliance not configured. Setup Azure Migrate appliance before proceeding.'
+        }
         $VaultName = $smsSolution.DetailExtendedDetail.AdditionalProperties.vaultId.Split("/")[8]
 
         # Get all appliances and sites in the project from SDS solution.
-		$sdsSolution = Get-AzMigrateSolution -MigrateProjectName $ProjectName -ResourceGroupName $ResourceGroupName -Name "Servers-Discovery-ServerDiscovery"
+        $sdsSolution = Get-AzMigrateSolution -MigrateProjectName $ProjectName -ResourceGroupName $ResourceGroupName -Name "Servers-Discovery-ServerDiscovery"
         $appMap = @{}
 
         if ($null -ne $sdsSolution.DetailExtendedDetail["applianceNameToSiteIdMapV2"]) {
@@ -194,13 +219,13 @@ public static int hashForArtifact(String artifact)
                 $appMap[$item.ApplianceName] = $item.SiteId
             }
         }
-        
+
         if ($null -ne $sdsSolution.DetailExtendedDetail["applianceNameToSiteIdMapV3"]) {
             $appMapV3 = $sdsSolution.DetailExtendedDetail["applianceNameToSiteIdMapV3"] | ConvertFrom-Json
             foreach ($item in $appMapV3) {
                 $t = $item.psobject.properties
                 $appMap[$t.Name] = $t.Value.SiteId
-            }    
+            }
         }
 
         if ($null -eq $sdsSolution.DetailExtendedDetail["applianceNameToSiteIdMapV2"] -And
@@ -225,7 +250,7 @@ public static int hashForArtifact(String artifact)
                     if (($existingMapping) -and ($existingMapping.ProviderSpecificDetail.TargetLocation -ne $TargetRegion)) {
                         $targetRegionMismatchExceptionMsg = $ProjectName + " is already configured for migrating servers to " + $TargetRegion + ". Target Region cannot be modified once configured."
                         throw $targetRegionMismatchExceptionMsg
-                    }   
+                    }
                 }
             }
 
@@ -241,7 +266,7 @@ public static int hashForArtifact(String artifact)
 
             # Phase 1
             # Storage account
-            $MigratePrefix = "migrate"            
+            $MigratePrefix = "migrate"
             $LogStorageAcName = $MigratePrefix + "lsa" + $hash
             $GateWayStorageAcName = $MigratePrefix + "gwsa" + $hash
             $StorageType = "Microsoft.Storage/storageAccounts"
@@ -299,13 +324,13 @@ public static int hashForArtifact(String artifact)
             else {
                 Write-Host $ServiceBusNamespace, $LogStringSkipping
             }
-           
+
             # Key vault
             $KeyVaultName = $MigratePrefix + "kv" + $hash
             $KeyVaultType = "Microsoft.KeyVault/vaults"
             $KeyVaultApiVersion = "2016-10-01"
             $KeyVaultKind = "KeyVault"
-            
+
             $existingKeyVaultAccount = Get-AzResource -ResourceGroupName $ResourceGroupName -Name $KeyVaultName -ErrorVariable notPresent -ErrorAction SilentlyContinue
             if ($existingKeyVaultAccount) {
                 Write-Host $KeyVaultName, $LogStringSkipping
@@ -326,8 +351,7 @@ public static int hashForArtifact(String artifact)
                 if ($CloudEnvironMent -eq "AzureUSGovernment") {
                     $HyperVManagerAppId = "AFAE2AF7-62E0-4AA4-8F66-B11F74F56326"
                 }
-                $hyperVManagerObject = Get-AzADServicePrincipal -ApplicationID $HyperVManagerAppId
-                $userObject = Get-AzADUser -UserPrincipalName $context.Subscription.ExtendedProperties.Account
+                $hyperVManagerObject = Get-AzADServicePrincipal -ApplicationID $HyperVManagerAppId				
                 $accessPolicies = @()
                 $userAccessPolicy = @{
                     "tenantId"    = $tenantID;
@@ -427,13 +451,27 @@ public static int hashForArtifact(String artifact)
             $lsaStorageAccount = Get-AzResource -ResourceName $LogStorageAcName -ResourceGroupName $ResourceGroupName
             $gwyRoleAssignments = Get-AzRoleAssignment -ObjectId $kvspnid -Scope $gwyStorageAccount.Id -ErrorVariable notPresent -ErrorAction SilentlyContinue
             $lsaRoleAssignments = Get-AzRoleAssignment -ObjectId $kvspnid -Scope $lsaStorageAccount.Id -ErrorVariable notPresent -ErrorAction SilentlyContinue
-            if (!$lsaRoleAssignments) {
+            if (-not $lsaRoleAssignments) {
                 $output = New-AzRoleAssignment -ObjectId $kvspnid -Scope $lsaStorageAccount.Id -RoleDefinitionId $roleDefinitionId
             }
-            if (!$gwyRoleAssignments) {
+            if (-not $gwyRoleAssignments) {
                 $output = New-AzRoleAssignment -ObjectId $kvspnid -Scope $gwyStorageAccount.Id -RoleDefinitionId $roleDefinitionId
             }
 
+            if (-not $lsaRoleAssignments -or -not $gwyRoleAssignments) {
+                for ($i = 1; $i -le 18; $i++) {
+                    Write-Information "Waiting for Role Assignments to be available... $( $i * 10 ) seconds" -InformationAction Continue
+                    Start-Sleep -Seconds 10
+
+                    $gwyRoleAssignments = Get-AzRoleAssignment -ObjectId $kvspnid -Scope $gwyStorageAccount.Id -ErrorVariable notPresent -ErrorAction SilentlyContinue
+                    $lsaRoleAssignments = Get-AzRoleAssignment -ObjectId $kvspnid -Scope $lsaStorageAccount.Id -ErrorVariable notPresent -ErrorAction SilentlyContinue
+
+                    if ($gwyRoleAssignments -and $lsaRoleAssignments) {
+                        break
+                    }
+                }
+            }
+
             # SA. SAS definition
 
             $gatewayStorageAccountSasSecretName = "gwySas"
@@ -453,7 +491,7 @@ public static int hashForArtifact(String artifact)
             Set-AzKeyVaultManagedStorageSasDefinition -AccountName $GateWayStorageAcName -VaultName $KeyVaultName -Name $gatewayStorageAccountSasSecretName -TemplateUri $gwyat -SasType 'account' -ValidityPeriod ([System.Timespan]::FromDays(30))
 
             # Phase 2
-           
+
             # ServiceBusConnectionString
             $serviceBusConnString = "ServiceBusConnectionString"
             $serviceBusSecretObject = Get-AzKeyVaultSecret -VaultName $KeyVaultName -Name $serviceBusConnString -ErrorVariable notPresent -ErrorAction SilentlyContinue
@@ -465,16 +503,16 @@ public static int hashForArtifact(String artifact)
                 $secret = ConvertTo-SecureString -String $serviceBusRootKey.PrimaryConnectionString -AsPlainText -Force
                 $output = Set-AzKeyVaultSecret -VaultName $KeyVaultName -Name $serviceBusConnString -SecretValue $secret
                 Write-Host $LogStringCreated, $serviceBusConnString, " for ", $applianceName
-            }  
+            }
 
             # Policy
             $policyName = $MigratePrefix + $SiteName + "policy"
             $existingPolicyObject = Get-AzMigrateReplicationPolicy -PolicyName $policyName -ResourceGroupName $ResourceGroupName -ResourceName $VaultName -ErrorVariable notPresent -ErrorAction SilentlyContinue
             if (!$existingPolicyObject) {
-                $providerSpecificPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtPolicyCreationInput]::new()
+                $providerSpecificPolicy = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.VMwareCbtPolicyCreationInput]::new()
                 $providerSpecificPolicy.AppConsistentFrequencyInMinute = 240
                 $providerSpecificPolicy.InstanceType = "VMwareCbt"
-                $providerSpecificPolicy.RecoveryPointHistoryInMinute = 4320
+                $providerSpecificPolicy.RecoveryPointHistoryInMinute = 360
                 $providerSpecificPolicy.CrashConsistentFrequencyInMinute = 60
                 $existingPolicyObject = New-AzMigrateReplicationPolicy -PolicyName $policyName -ResourceGroupName $ResourceGroupName -ResourceName $VaultName -ProviderSpecificInput $providerSpecificPolicy
                 Write-Host $LogStringCreated, $policyName
@@ -497,7 +535,7 @@ public static int hashForArtifact(String artifact)
                     else {
                         $keyVaultAccountDetails = Get-AzKeyVault -ResourceGroupName $ResourceGroupName -Name $KeyVaultName
                         $gwyStorageAccount = Get-AzResource -ResourceGroupName $ResourceGroupName -ResourceName $GateWayStorageAcName
-                        $providerSpecificInput = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtContainerMappingInput]::new()
+                        $providerSpecificInput = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.VMwareCbtContainerMappingInput]::new()
                         $providerSpecificInput.InstanceType = "VMwareCbt"
                         $providerSpecificInput.KeyVaultId = $keyVaultAccountDetails.ResourceId
                         $providerSpecificInput.KeyVaultUri = $keyVaultAccountDetails.VaultUri
@@ -507,9 +545,9 @@ public static int hashForArtifact(String artifact)
                         $providerSpecificInput.TargetLocation = $TargetRegion
                         $output = New-AzMigrateReplicationProtectionContainerMapping -FabricName $fabric.Name -MappingName $mappingName -ProtectionContainerName $peContainer.Name -ResourceGroupName $ResourceGroupName -ResourceName $VaultName -PolicyId $existingPolicyObject.Id -ProviderSpecificInput $providerSpecificInput -TargetProtectionContainerId  "Microsoft Azure"
                         Write-Host $LogStringCreated, $mappingName, " for ", $applianceName
-                    } 
+                    }
                 }
-            }  
+            }
         }
         Write-Host "Finished successfully."
         return $true

src/Migrate/custom/New-AzMigrateDiskMapping.ps1

@@ -22,7 +22,7 @@ The New-AzMigrateDiskMapping cmdlet creates a mapping of the source disk attache
 https://docs.microsoft.com/powershell/module/az.migrate/new-azmigratediskmapping
 #>
 function New-AzMigrateDiskMapping {
-    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IVMwareCbtDiskInput])]
+    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IVMwareCbtDiskInput])]
     [CmdletBinding(DefaultParameterSetName = 'VMwareCbt', PositionalBinding = $false)]
     param(
         [Parameter(Mandatory)]
@@ -55,7 +55,7 @@ function New-AzMigrateDiskMapping {
     )
 
     process {
-        $DiskObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtDiskInput]::new()
+        $DiskObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.VMwareCbtDiskInput]::new()
         $DiskObject.DiskId = $DiskID
 
         $validDiskTypeSpellings = @{ 

src/Migrate/custom/New-AzMigrateNicMapping.ps1

@@ -22,7 +22,7 @@ The New-AzMigrateNicMapping cmdlet creates a mapping of the source NIC attached
 https://docs.microsoft.com/powershell/module/az.migrate/new-azmigratenicmapping
 #>
 function New-AzMigrateNicMapping {
-    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.IVMwareCbtNicInput])]
+    [OutputType([Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.IVMwareCbtNicInput])]
     [CmdletBinding(DefaultParameterSetName = 'VMwareCbt', PositionalBinding = $false)]
     param(
         [Parameter(Mandatory)]
@@ -45,6 +45,12 @@ function New-AzMigrateNicMapping {
         # Specifies the Subnet name for the NIC in the destination Virtual Network to which the server needs to be migrated.
         ${TargetNicSubnet},
 
+        [Parameter()]
+        [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')]
+        [System.String]
+        # Specifies the name of the NIC to be created.
+        ${TargetNicName},
+
         [Parameter()]
         [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Category('Path')]
         [System.String]
@@ -53,7 +59,7 @@ function New-AzMigrateNicMapping {
     )
 
     process {
-        $NicObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20180110.VMwareCbtNicInput]::new()
+        $NicObject = [Microsoft.Azure.PowerShell.Cmdlets.Migrate.Models.Api20210210.VMwareCbtNicInput]::new()
         $NicObject.NicId = $NicID
         if ($PSBoundParameters.ContainsKey('TargetNicSelectionType')) {
             if ($TargetNicSelectionType -eq 'primary') {
@@ -76,6 +82,18 @@ function New-AzMigrateNicMapping {
         if ($PSBoundParameters.ContainsKey('TargetNicIP')) {
             $NicObject.TargetStaticIPAddress = $TargetNicIP
         }
+
+        if ($PSBoundParameters.ContainsKey('TargetNicName')) {
+            if ($TargetNicName.length -gt 80 -or $TargetNicName.length -eq 0) {
+                throw "The NIC name must be between 1 and 80 characters long."
+            }
+
+            if ($TargetNicName -notmatch "^[^_\W][a-zA-Z0-9_\-\.]{0,79}(?<![-.])$") {
+                throw "The NIC name must begin with a letter or number, end with a letter, number or underscore, and may contain only letters, numbers, underscores, periods, or hyphens."
+            }
+            $NicObject.TargetNicName = $TargetNicName
+        }
+
         return $NicObject
     }