Add migration guide for Stack AzureRm 1.2.11

documentation/release-notes/Stack/migration-guide.1.2.11.md

@@ -0,0 +1,251 @@
+# Table of Contents
+1. [Removal of Force parameters](#removal-of-force-parameters)
+2. [Change of Tag parameters](#change-of-tag-parameters)
+3. [Breaking Changes to Profile Cmdlets](#breaking-changes-to-profile-cmdlets)
+
+## Removal of Force parameters
+
+This release, we removed all Obsolete `Force` parameters from cmdlets and the corresponding warnings that the parameter would be removed in a future release.
+
+The following cmdlets are affected by this change:
+
+**Profile**
+- Remove-AzureRmEnvironment
+
+**Resources**
+- Register-AzureRmProviderFeature
+- Register-AzureRmResourceProvider
+- Remove-AzureRmADServicePrincipal
+- Remove-AzureRmPolicyAssignment
+- Remove-AzureRmResourceGroupDeployment
+- Remove-AzureRmRoleAssignment
+- Stop-AzureRmResourceGroupDeployment
+- Unregister-AzureRmResourceProvider
+
+**Tag**
+- Remove-AzureRmTag
+
+<br>
+
+If you have a script that uses any of the above cmdlets, the breaking change can be fixed by simply removing the `Force` parameter.
+
+```powershell
+# Old
+New-AzureRmResourceGroup -Name $resourceGroupName -Location $location -Force
+
+# New
+New-AzureRmResourceGroup -Name $resourceGroupName -Location $location
+```
+
+<br>
+
+## Change of Tag parameters
+
+This release, the `Tags` parameter name was changed to `Tag`, and the type was changed from `Hashtable[]` to `Hashtable`, changing the format of the key-value pairings.
+
+Previously, each entry in the `Hashtable[]` represented a single key-value pairing:
+
+```powershell
+$tags = @{ Name = "test1"; Value = "testval1" }, @{ Name = "test2", Value = "testval2" }
+$tags[0].Name  # Key for the first entry, "test1"
+$tags[0].Value # Value for the first entry, "testval1"
+$tags[1].Name  # Key for the second entry, "test2"
+$tags[1].Value # Value for the second entry, "testval2"
+```
+
+Now, `Name` and `Value` are no longer necessary, allowing for key-value pairings to be created by assigning `Key = "Value"` in the `Hashtable`:
+
+```powershell
+$tag = @{ test1 = "testval1"; test2 = "testval2" }
+$tag["test1"] # Gets the value associated with the key "test1"
+$tag["test2"] # Gets the value associated with the key "test2"
+```
+
+The following cmdlets are affected by this change:
+
+
+**Compute**
+- New-AzureRmVM
+- Update-AzureRmVM
+
+**Dns**
+- New-AzureRmDnsZone
+- Set-AzureRmDnsZone
+
+**KeyVault**
+- Get-AzureRmKeyVault
+- New-AzureRmKeyVault
+
+**Network**
+- New-AzureRmApplicationGateway
+- New-AzureRmExpressRouteCircuit
+- New-AzureRmLoadBalancer
+- New-AzureRmLocalNetworkGateway
+- New-AzureRmNetworkInterface
+- New-AzureRmNetworkSecurityGroup
+- New-AzureRmPublicIpAddress
+- New-AzureRmRouteTable
+- New-AzureRmVirtualNetwork
+- New-AzureRmVirtualNetworkGateway
+- New-AzureRmVirtualNetworkGatewayConnection
+- New-AzureRmVirtualNetworkPeering
+
+**Resources**
+- Find-AzureRmResource
+- Find-AzureRmResourceGroup
+- New-AzureRmResource
+- New-AzureRmResourceGroup
+- Set-AzureRmResource
+- Set-AzureRmResourceGroup
+
+**Storage**
+- New-AzureRmStorageAccount
+- Set-AzureRmStorageAccount
+
+
+<br>
+
+If you have a script that uses any of the above cmdlets, the breaking change can be fixed by changing the `Tags` parameter to `Tag`, as well as changing the `Tag` to the new format.
+
+```powershell
+# Old
+New-AzureRmResourceGroup -Name $resourceGroupName -Location -location -Tags @{ Name = "testtag"; Value = "testval" }
+
+# New
+New-AzureRmResourceGroup -Name $resourceGroupName -Location -location -Tag @{ testtag = "testval" }
+```
+
+<br>
+
+## Breaking Changes to Profile Cmdlets
+
+The following cmdlets and cmdlet output types were changed in this release.
+
+### Add-AzureRmAccount breaking changes
+
+- ```EnvironmentName``` parameter has been removed and replaced with ```Environment```, the ```Environment``` now takes a string and not an ```AzureEnvironment``` object
+
+```powershell
+# Old
+Add-AzureRmAccount -EnvironmentName AzureStack
+
+# New
+Add-AzureRmAccount -Environment AzureStack
+```
+
+### Select-AzureRmProfile was renamed to Import-AzureRmContext
+
+```Select-AzureRmProfile``` was renamed to ```Import-AzureRmContext```
+
+```powershell
+# Old
+Select-AzureRmProfile -Path c:\mydir\myprofile.json
+
+# New
+Import-AzureRmContext -Path c:\mydir\myprofile.json
+```
+
+### Save-AzureRmProfile was renamed to Save-AzureRmContext
+
+```Save-AzureRmProfile``` was renamed to ```Save-AzureRmContext```
+
+```powershell
+# Old
+Save-AzureRmProfile -Path c:\mydir\myprofile.json
+
+# New
+Save-AzureRmContext -Path c:\mydir\myprofile.json
+```
+### Breaking Changes to output PSAzureContext Type
+
+- The ```TokenCache``` property changed to a type that implements ```IAzureTokenCache``` instead of a ```byte[]```
+
+```powershell
+# Old
+$bytes = (Get-AzureRmContext).TokenCache
+$bytes = (Set-AzureRmContext -SubscriptionId xxx-xxx-xxx-xxx).TokenCache
+$bytes = (Add-AzureRmAccount).Context.TokenCache
+
+# New
+$bytes = (Get-AzureRmContext).TokenCache.CacheData
+$bytes = (Set-AzureRmContext -SubscriptionId xxx-xxx-xxx-xxx).TokenCache.CacheData
+$bytes = (Add-AzureRmAccount).Context.TokenCache.CacheData
+```
+
+### Breaking Changes to the output PSAzureAccount Type
+
+- The ```AccountType``` property was changed to ```Type```
+
+```powershell
+# Old
+$type = (Get-AzureRmContext).Account.AccountType
+$type = (Set-AzureRmContext -SubscriptionId xxx-xxx-xxx-xxx).Account.AccountType
+$type = (Add-AzureRmAccount).Context.Account.AccountType
+
+# New 
+$type = (Get-AzureRmContext).Account.Type
+$type = (Set-AzureRmContext -SubscriptionId xxx-xxx-xxx-xxx).Account.Type
+$type = (Add-AzureRmAccount).Context.Account.Type
+```
+
+### Breaking Changes to the output PSAzureSubscription Type
+- The ```SubscriptionId``` property was changed to ```Id```
+
+```powershell
+# Old
+$id =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).SubscriptionId
+$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Subscription.SubscriptionId
+$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionId
+$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionId
+
+# New
+$id =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).Id
+$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Subscription.Id
+$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Id
+$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Id
+```
+
+- The ```SubscriptionName``` property was changed to ```Name```
+
+```powershell
+# Old
+$name =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).SubscriptionName
+$name =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Subscription.SubscriptionName
+$name =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionName
+$name =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionName
+
+# New
+$name =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).Name
+$name =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Subscription.Name
+$name =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Name
+$name =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Name
+```
+
+### Breaking Changes to the output PSAzureTenant Type
+
+- The ```TenantId``` property was changed to ```Id```
+
+```powershell
+# Old
+$id =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).TenantId
+$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Tenant.TenantId
+$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.TenantId
+$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.TenantId
+
+# New
+$id =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Id
+$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).Context.Tenant.Id
+$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.Id
+$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.Id
+```
+
+- The ```Domain``` property was changed to ```Directory```
+
+```powershell
+# Old
+$tenantName =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Domain
+
+# New
+$tenantName =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Directory
+```
+