Merge pull request #3935 from Azure/prbreaking

Add breaking changes for Profile module

Author: cormacpayne

documentation/release-notes/migration-guide.4.0.0.md

@@ -10,7 +10,7 @@ This document serves as both a breaking change notification and migration guide
 - [Breaking changes to ServiceBus cmdlets](#breaking-changes-to-servicebus-cmdlets)
 - [Breaking changes to Sql cmdlets](#breaking-changes-to-sql-cmdlets)
 - [Breaking changes to Storage cmdlets](#breaking-changes-to-storage-cmdlets)
-
+- [Breaking Changes to Profile Cmdlets](#breaking-changes-to-profile-cmdlets)
 ## Breaking changes to Compute cmdlets
 
 The following output types were affected this release:
@@ -314,4 +314,136 @@ $LocationMode = (Get-AzureStorageBlob -Container $containername)[0].ICloudBlob.S
 $ParallelOperationThreadCount = (Get-AzureStorageContainer -Container $containername).CloudBlobContainer.ServiceClient.DefaultRequestOptions.ParallelOperationThreadCount
 $PayloadFormat = (Get-AzureStorageTable -Name $tablename).CloudTable.ServiceClient.DefaultRequestOptions.PayloadFormat
 $RetryPolicy = (Get-AzureStorageQueue -Name $queuename).CloudQueue.ServiceClient.DefaultRequestOptions.RetryPolicy
-```
+```
+
+## 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 AzureChinaCloud
+
+# New
+Add-AzureRmAccount -Environment AzureChinaCloud
+```
+
+### 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
+```