Skip to content

Commit 31968e3

Browse files
authored
Add breaking changes for Profile module
1 parent b8b8459 commit 31968e3

File tree

1 file changed

+103
-2
lines changed

1 file changed

+103
-2
lines changed

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

Lines changed: 103 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document serves as both a breaking change notification and migration guide
1010
- [Breaking changes to ServiceBus cmdlets](#breaking-changes-to-servicebus-cmdlets)
1111
- [Breaking changes to Sql cmdlets](#breaking-changes-to-sql-cmdlets)
1212
- [Breaking changes to Storage cmdlets](#breaking-changes-to-storage-cmdlets)
13-
13+
- [Breaking Changes to Profile Cmdlets](#breaking-changes-to-profile-cmdlets)
1414
## Breaking changes to Compute cmdlets
1515

1616
The following output types were affected this release:
@@ -314,4 +314,105 @@ $LocationMode = (Get-AzureStorageBlob -Container $containername)[0].ICloudBlob.S
314314
$ParallelOperationThreadCount = (Get-AzureStorageContainer -Container $containername).CloudBlobContainer.ServiceClient.DefaultRequestOptions.ParallelOperationThreadCount
315315
$PayloadFormat = (Get-AzureStorageTable -Name $tablename).CloudTable.ServiceClient.DefaultRequestOptions.PayloadFormat
316316
$RetryPolicy = (Get-AzureStorageQueue -Name $queuename).CloudQueue.ServiceClient.DefaultRequestOptions.RetryPolicy
317-
```
317+
```
318+
319+
## Breaking Changes to Profile Cmdlets
320+
321+
The following cmdlets were changed in this release.
322+
323+
### Add-AzureRmAccount breaking changes
324+
325+
- ```EnvironmentName``` parameter has been removed and replaced with ```Environment```, the ```Environment``` now takes a string and not an ```AzureEnvironment``` object
326+
327+
```powershell
328+
#Old
329+
Add-AzureRmAccount -EnvironmentName AzureChinaCloud
330+
331+
#New
332+
Add-AzureRmAccount -Environment AzureChinaCloud
333+
```
334+
335+
### Select-AzureRmProfile was renamed to Import-AzureRmContext
336+
337+
```Select-AzureRmProfile``` was renamed to ```Import-AzureRmContext```
338+
339+
```powershell
340+
#Old
341+
Select-AzureRmProfile -Path c:\mydir\myprofile.json
342+
343+
#New
344+
Import-AzureRmContext -Path c:\mydir\mypforile.json
345+
```
346+
347+
### Save-AzureRmProfile was renamed to Save-AzureRmContext
348+
349+
```Save-AzureRmProfile``` was renamed to ```Save-AzureRmContext```
350+
351+
```powershell
352+
#Old
353+
Save-AzureRmProfile -Path c:\mydir\myprofile.json
354+
355+
#New
356+
Save-AzureRmContext -Path c:\mydir\mypforile.json
357+
```
358+
359+
### Breaking Changes to the output Subscription type
360+
- The ```SubscriptionId``` property was changed to ```Id```
361+
362+
```powershell
363+
#old
364+
$id =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).SubscriptionId
365+
$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Subscription.SubscriptionId
366+
$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionId
367+
$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionId
368+
369+
#new
370+
$id =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).Id
371+
$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Subscription.Id
372+
$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Id
373+
$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Id
374+
```
375+
376+
- The ```SubscriptionName``` property was changed to ```Name```
377+
378+
```powershell
379+
#old
380+
$name =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).SubscriptionName
381+
$name =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Subscription.SubscriptionName
382+
$name =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionName
383+
$name =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.SubscriptionName
384+
385+
#new
386+
$name =(Get-AzureRmSubscription -SubscriptionId xxxx-xxxx-xxxx-xxxx).Name
387+
$name =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Subscription.Name
388+
$name =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Name
389+
$name =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Subscription.Name
390+
```
391+
392+
### Breaking Changes to the output Tenant type
393+
394+
- The ```TenantId``` property was changed to ```Id```
395+
396+
```powershell
397+
#old
398+
$id =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).TenantId
399+
$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Tenant.TenantId
400+
$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.TenantId
401+
$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.TenantId
402+
403+
#new
404+
$id =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Id
405+
$id =(Add-AzureRmAccount -SubscriptionId xxxx-xxxx-xxxx-xxxx).DefaultContext.Tenant.Id
406+
$id =(Get-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.Id
407+
$id =(Set-AzureRmContext -SubscriptionId xxxx-xxxx-xxxx-xxxx).Tenant.Id
408+
```
409+
410+
- The ```Domain`` property was changed to ```Directory```
411+
412+
```powershell
413+
#old
414+
$tenantName =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Domain
415+
416+
#new
417+
$tenantName =(Get-AzureRmTenant -TenantId xxxx-xxxx-xxxx-xxxx).Directory
418+
```

0 commit comments

Comments
 (0)