Skip to content

Commit f1f2ed4

Browse files
wyunchi-msdingmeng-xue
wyunchi-ms
and
dingmeng-xue
authored
Add migration guide for Az.6.0 (#15088)
* Add migration guide for Az.6.0 * Update Az.6.0.0-migration-guide.md * Hide subscription id * Fix migration guide Co-authored-by: wyunchi-ms <[email protected]> Co-authored-by: Dingmeng Xue <[email protected]>
1 parent c901599 commit f1f2ed4

File tree

1 file changed

+386
-0
lines changed

1 file changed

+386
-0
lines changed

‎documentation/migration-guides/Az.6.0.0-migration-guide.md

Lines changed: 386 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,386 @@
1+
# Migration Guide for Az 6.0.0
2+
- [Migration Guide for Az 6.0.0](#migration-guide-for-az-600)
3+
- [Supported versions of PowerShell](#supported-versions-of-powershell)
4+
- [Az.Accounts](#azaccounts)
5+
- [`Connect-AzAccount`](#connect-azaccount)
6+
- [Az.ContainerInstance](#azcontainerinstance)
7+
- [`New-AzContainerGroup`](#new-azcontainergroup)
8+
- [`Remove-AzContainerGroup`](#remove-azcontainergroup)
9+
- [`Get-AzContainerGroup`](#get-azcontainergroup)
10+
- [`Get-AzContainerInstanceLog`](#get-azcontainerinstancelog)
11+
- [Az.DesktopVirtualization](#azdesktopvirtualization)
12+
- [`New-AzWvdHostPool`](#new-azwvdhostpool)
13+
- [`Expand-AzWvdMsixImage`](#expand-azwvdmsiximage)
14+
- [`New-AzWvdMsixPackage`](#new-azwvdmsixpackage)
15+
- [`Update-AzWvdHostPool`](#update-azwvdhostpool)
16+
- [Az.StreamAnalytics](#azstreamanalytics)
17+
- [`Get-AzStreamAnalyticsDefaultFunctionDefinition`](#get-azstreamanalyticsdefaultfunctiondefinition)
18+
- [`New-AzStreamAnalyticsJob`](#new-azstreamanalyticsjob)
19+
- [`New-AzStreamAnalyticsTransformation`](#new-azstreamanalyticstransformation)
20+
- [Az.RecoveryServices](#azrecoveryservices)
21+
- [`Set-AzRecoveryServicesBackupProperty`](#set-azrecoveryservicesbackupproperty)
22+
- [`Get-AzRecoveryServicesBackupJobDetail`](#get-azrecoveryservicesbackupjobdetail)
23+
- [Az.Storage](#azstorage)
24+
- [`Remove-AzRmStorageShare`](#remove-azrmstorageshare)
25+
- [Az.ServiceFabric](#azservicefabric)
26+
- [`Add-AzServiceFabricClusterCertificate`](#add-azservicefabricclustercertificate)
27+
- [`Get-AzServiceFabricManagedClusterService`](#get-azservicefabricmanagedclusterservice)
28+
- [`New-AzServiceFabricManagedCluster`](#new-azservicefabricmanagedcluster)
29+
- [`New-AzServiceFabricManagedClusterService`](#new-azservicefabricmanagedclusterservice)
30+
- [`Remove-AzServiceFabricClusterCertificate`](#remove-azservicefabricclustercertificate)
31+
- [`Remove-AzServiceFabricManagedClusterService`](#remove-azservicefabricmanagedclusterservice)
32+
- [`Set-AzServiceFabricManagedCluster`](#set-azservicefabricmanagedcluster)
33+
- [`Set-AzServiceFabricManagedClusterService`](#set-azservicefabricmanagedclusterservice)
34+
35+
## Supported versions of PowerShell
36+
37+
Due to [CVE-2021-26701](https://msrc.microsoft.com/update-guide/en-us/vulnerability/CVE-2021-26701) Az 6 is only supported on the following platforms:
38+
- PowerShell 7.1: version 7.1.3 or above
39+
- PowerShell 7.0: version 7.0.6 or above
40+
- Windows PowerShell 5.1
41+
42+
For further details, refer to the [Azure PowerShell support lifecycle](https://aka.ms/lifecycle)
43+
44+
## Az.Accounts
45+
46+
### `Connect-AzAccount`
47+
Removed obsolete parameters ManagedServiceHostName, ManagedServicePort and ManagedServiceSecret.
48+
49+
#### Before
50+
```powershell
51+
Connect-AzAccount -Identity -ManagedServiceSecret $secret
52+
```
53+
#### After
54+
```powershell
55+
#To use customized MSI endpoint, please set environment variable MSI_ENDPOINT, e.g. "http://localhost:50342/oauth2/token"; to use customized MSI secret, please set environment variable MSI_SECRET.
56+
Connect-AzAccount -Identity
57+
```
58+
59+
60+
## Az.ContainerInstance
61+
62+
### `New-AzContainerGroup`
63+
No longer supports the parameter `Image`, `RegistryCredential`, `AzureFileVolumeShareName`, `AzureFileVolumeAccountCredential`, `AzureFileVolumeMountPath`, `IdentityId`, `AssignIdentity`, `OsType`, `Cpu`, `MemoryInGB`, `IpAddressType`, `DnsNameLabel`, `Port`, `Command`, `EnvironmentVariable`, `RegistryServerDomain` and no alias was found for the original parameter name.
64+
65+
#### Before
66+
```powershell
67+
PS C:\> New-AzContainerGroup -ResourceGroupName demo -Name mycontainer -Image nginx -OsType Linux -IpAddressType Public -Port @(8000)
68+
69+
ResourceGroupName : demo
70+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
71+
Name : mycontainer
72+
Type : Microsoft.ContainerInstance/containerGroups
73+
Location : westus
74+
Tags :
75+
ProvisioningState : Creating
76+
Containers : {mycontainer}
77+
ImageRegistryCredentials :
78+
RestartPolicy :
79+
IpAddress : 13.88.10.240
80+
Ports : {8000}
81+
OsType : Linux
82+
Volumes :
83+
State : Running
84+
Events : {}
85+
```
86+
#### After
87+
```powershell
88+
PS C:\> $port1 = New-AzContainerInstancePortObject -Port 8000 -Protocol TCP
89+
PS C:\> $port2 = New-AzContainerInstancePortObject -Port 8001 -Protocol TCP
90+
PS C:\> $container = New-AzContainerInstanceObject -Name test-container -Image nginx -RequestCpu 1 -RequestMemoryInGb 1.5 -Port @($port1, $port2)
91+
PS C:\> $containerGroup = New-AzContainerGroup -ResourceGroupName test-rg -Name test-cg -Location eastus -Container $container -OsType Linux -RestartPolicy "Never" -IpAddressType Public
92+
93+
Location Name Type
94+
-------- ---- ----
95+
eastus test-cg Microsoft.ContainerInstance/containerGroups
96+
```
97+
98+
99+
### `Remove-AzContainerGroup`
100+
The cmdlet 'Remove-AzContainerGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name.
101+
102+
#### Before
103+
```powershell
104+
PS C:\> Find-AzResource -ResourceGroupEquals MyResourceGroup -ResourceNameEquals MyContainer | Remove-AzContainerGroup
105+
```
106+
#### After
107+
```powershell
108+
PS C:\> Remove-AzContainerGroup -Name test-cg -ResourceGroupName test-rg
109+
110+
Location Name Type
111+
-------- ---- ----
112+
eastus test-cg Microsoft.ContainerInstance/containerGroups
113+
```
114+
115+
116+
### `Get-AzContainerGroup`
117+
The cmdlet 'Get-AzContainerGroup' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name.
118+
119+
#### Before
120+
```powershell
121+
PS C:\> Find-AzResource -ResourceGroupEquals demo -ResourceNameEquals mycontainer | Get-AzContainerGroup
122+
123+
ResourceGroupName : demo
124+
Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/mycontainer
125+
Name : mycontainer
126+
Type : Microsoft.ContainerInstance/containerGroups
127+
Location : westus
128+
Tags :
129+
ProvisioningState : Succeeded
130+
Containers : {mycontainer}
131+
ImageRegistryCredentials :
132+
RestartPolicy :
133+
IpAddress : 13.88.10.240
134+
Ports : {8000}
135+
OsType : Linux
136+
Volumes :
137+
State : Running
138+
Events : {}
139+
```
140+
#### After
141+
```powershell
142+
PS C:\> Get-AzContainerGroup
143+
144+
Location Name Type
145+
-------- ---- ----
146+
eastus bez-cg1 Microsoft.ContainerInstance/containerGroups
147+
eastus bez-cg2 Microsoft.ContainerInstance/containerGroups
148+
```
149+
150+
151+
### `Get-AzContainerInstanceLog`
152+
The cmdlet 'Get-AzContainerInstanceLog' no longer supports the parameter 'ResourceId' and no alias was found for the original parameter name.
153+
The cmdlet 'Get-AzContainerInstanceLog' no longer supports the parameter 'Name' and no alias was found for the original parameter name.
154+
155+
#### Before
156+
```powershell
157+
PS C:\> Get-AzContainerGroup -ResourceGroupName demo -Name mycontainer | Get-AzContainerInstanceLog
158+
159+
Log line 1.
160+
Log line 2.
161+
Log line 3.
162+
Log line 4.
163+
```
164+
#### After
165+
```powershell
166+
PS C:\> Get-AzContainerInstanceLog -ContainerGroupName test-cg -ContainerName test-container -ResourceGroupName test-rg
167+
```
168+
## Az.DesktopVirtualization
169+
170+
### `New-AzWvdHostPool`
171+
The cmdlet 'New-AzWvdHostPool' no longer supports the parameter 'SsoContext' and no alias was found for the original parameter name.
172+
173+
### `Expand-AzWvdMsixImage`
174+
The cmdlet 'Expand-AzWvdMsixImage' no longer supports the type 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixImageUri' for parameter 'MsixImageUri'.
175+
176+
#### Before
177+
```powershell
178+
$MsixImageUri = [Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixImageUri]::New()
179+
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName | Expand-AzWvdMsixImage -MsixImageUri $MsixImageUri
180+
```
181+
#### After
182+
```powershell
183+
$MsixImageUri = [Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixImageUri]::New()
184+
Get-AzWvdDesktop -ResourceGroupName ResourceGroupName -ApplicationGroupName ApplicationGroupName -Name DesktopName | Expand-AzWvdMsixImage -MsixImageUri $MsixImageUri
185+
```
186+
187+
188+
### `New-AzWvdMsixPackage`
189+
The element type for parameter 'PackageApplication' has been changed from 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageApplications' to 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageApplications'.
190+
The element type for parameter 'PackageDependency' has been changed from 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageDependencies' to 'Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageDependencies'.
191+
192+
#### Before
193+
```powershell
194+
PS C:\> $apps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageApplications]::New())
195+
PS C:\> $deps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20201102Preview.IMsixPackageDependencies]::New())
196+
PS C:\> New-AzWvdMsixPackage -FullName PackageFullName `
197+
-HostPoolName HostPoolName `
198+
-ResourceGroupName ResourceGroupName `
199+
-SubscriptionId SubscriptionId `
200+
-DisplayName displayname `
201+
-ImagePath imageURI `
202+
-IsActive:$false `
203+
-IsRegularRegistration:$false `
204+
-LastUpdated datelastupdated `
205+
-PackageApplication $apps `
206+
-PackageDependency $deps `
207+
-PackageFamilyName packagefamilyname `
208+
-PackageName packagename `
209+
-PackageRelativePath packagerelativepath `
210+
-Version packageversion `
211+
```
212+
#### After
213+
```powershell
214+
PS C:\> $apps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageApplications]::New())
215+
PS C:\> $deps = @([Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.Api20210201Preview.IMsixPackageDependencies]::New())
216+
PS C:\> New-AzWvdMsixPackage -FullName PackageFullName `
217+
-HostPoolName HostPoolName `
218+
-ResourceGroupName ResourceGroupName `
219+
-SubscriptionId SubscriptionId `
220+
-DisplayName displayname `
221+
-ImagePath imageURI `
222+
-IsActive:$false `
223+
-IsRegularRegistration:$false `
224+
-LastUpdated datelastupdated `
225+
-PackageApplication $apps `
226+
-PackageDependency $deps `
227+
-PackageFamilyName packagefamilyname `
228+
-PackageName packagename `
229+
-PackageRelativePath packagerelativepath `
230+
-Version packageversion `
231+
```
232+
233+
234+
### `Update-AzWvdHostPool`
235+
The cmdlet 'Update-AzWvdHostPool' no longer supports the parameter 'SsoContext' and no alias was found for the original parameter name.
236+
237+
238+
239+
## Az.StreamAnalytics
240+
241+
### `Get-AzStreamAnalyticsDefaultFunctionDefinition`
242+
243+
The cmdlet 'Get-AzStreamAnalyticsDefaultFunctionDefinition' no longer supports the parameter 'File' and no alias was found for the original parameter name.
244+
245+
#### Before
246+
```powershell
247+
Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName "StreamAnalytics-Default-West-US" -JobName "StreamJob22" -File "C:\RetrieveDefaultDefinitionRequest.json" -Name "ScoreTweet"
248+
```
249+
#### After
250+
```powershell
251+
Get-AzStreamAnalyticsDefaultFunctionDefinition -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name mlsfunction-01 -BindingType Microsoft.MachineLearningServices -Endpoint "http://875da830-4d5f-44f1-b221-718a5f26a21d.eastus.azurecontainer.io/score"-UdfType Scalar
252+
Input is specified in flattened parameters instead from the input file.
253+
```
254+
255+
256+
### `New-AzStreamAnalyticsJob`
257+
The cmdlet 'New-AzStreamAnalyticsJob' no longer supports the parameter 'File' and no alias was found for the original parameter name.
258+
259+
#### Before
260+
```powershell
261+
New-AzStreamAnalyticsJob -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\JobDefinition.json"
262+
```
263+
#### After
264+
```powershell
265+
New-AzStreamAnalyticsJob -ResourceGroupName azure-rg-test -Name sajob-02-pwsh -Location westcentralus -SkuName Standard
266+
Input is specified in flattened parameters instead from the input file.
267+
```
268+
269+
270+
### `New-AzStreamAnalyticsTransformation`
271+
The cmdlet 'New-AzStreamAnalyticsTransformation' no longer supports the parameter 'File' and no alias was found for the original parameter name.
272+
273+
#### Before
274+
```powershell
275+
New-AzStreamAnalyticsTransformation -ResourceGroupName "StreamAnalytics-Default-West-US" -File "C:\Transformation.json" -JobName "StreamingJob" -Name "StreamingJobTransform"
276+
```
277+
#### After
278+
```powershell
279+
New-AzStreamAnalyticsTransformation -ResourceGroupName azure-rg-test -JobName sajob-01-pwsh -Name tranf-01 -StreamingUnit 6 -Query "Select Id, Name from input-01"
280+
Input is specified in flattened parameters instead from the input file.
281+
```
282+
283+
284+
## Az.RecoveryServices
285+
286+
### `Set-AzRecoveryServicesBackupProperty`
287+
Removed Set-AzRecoveryServicesBackupProperties plural alias, use Set-AzRecoveryServicesBackupProperty cmdlet name going forward
288+
289+
### `Get-AzRecoveryServicesBackupJobDetail`
290+
Removed Get-AzRecoveryServicesBackupJobDetails plural alias, use Get-AzRecoveryServicesBackupJobDetail cmdlet name going forward
291+
292+
#### Before
293+
```powershell
294+
$jobDetails = Get-AzRecoveryServicesBackupJobDetails -VaultId $vault.ID -Job $job
295+
$jobDetails2 = Get-AzRecoveryServicesBackupJobDetails -VaultId $vault.ID -JobId $job.JobId
296+
```
297+
#### After
298+
```powershell
299+
$jobDetails = Get-AzRecoveryServicesBackupJobDetail -VaultId $vault.ID -Job $job
300+
$jobDetails2 = Get-AzRecoveryServicesBackupJobDetail -VaultId $vault.ID -JobId $job.JobId
301+
```
302+
303+
304+
## Az.Storage
305+
306+
### `Remove-AzRmStorageShare`
307+
The cmdlet 'Remove-AzRmStorageShare' can remove share with snapshots by default before; but after the change remove share with snapshots will fail by default, need add parameter "-Include Snapshots" to make remove success.
308+
309+
#### Before
310+
```powershell
311+
Remove-AzRmStorageShare -ResourceGroupName $resourceGroupName -StorageAccountName $accountName -Name $shareName
312+
```
313+
#### After
314+
```powershell
315+
Remove-AzRmStorageShare -ResourceGroupName $resourceGroupName -StorageAccountName $accountName -Name $shareName -Force -Include Snapshots
316+
```
317+
318+
319+
## Az.ServiceFabric
320+
321+
### `Add-AzServiceFabricClusterCertificate`
322+
this cmdlet has been removed completly. please follow instructions here to add cluster certificates: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#add-a-secondary-certificate-using-azure-resource-manager
323+
324+
### `Get-AzServiceFabricManagedClusterService`
325+
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
326+
And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName
327+
328+
#### Before
329+
```powershell
330+
$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId
331+
$statelessService.Properties.ProvisioningState
332+
```
333+
#### After
334+
```powershell
335+
$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId
336+
$statelessService.ProvisioningState
337+
```
338+
339+
340+
### `New-AzServiceFabricManagedCluster`
341+
Remove deprecated parameter ReverseProxyEndpointPort.
342+
343+
### `New-AzServiceFabricManagedClusterService`
344+
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
345+
And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName
346+
347+
#### Before
348+
```powershell
349+
$service = New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemaSingleton
350+
$statelessService.Properties.ProvisioningState
351+
```
352+
#### After
353+
```powershell
354+
$service = New-AzServiceFabricManagedClusterService -ResourceGroupName $resourceGroupName -ClusterName $clusterName -ApplicationName $appName -Name $serviceName -Type $serviceTypeName -Stateless -InstanceCount -1 -PartitionSchemaSingleton
355+
$statelessService.ProvisioningState
356+
```
357+
358+
359+
### `Remove-AzServiceFabricClusterCertificate`
360+
this cmdlet has been removed completly. please follow instructions here to add cluster certificates: https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#remove-a-cluster-certificate-using-the-portal
361+
362+
### `Remove-AzServiceFabricManagedClusterService`
363+
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
364+
365+
### `Set-AzServiceFabricManagedCluster`
366+
Remove deprecated parameter ReverseProxyEndpointPort.
367+
368+
### `Set-AzServiceFabricManagedClusterService`
369+
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
370+
And remove deprecated parameters InstanceCloseDelayDuration, DropSourceReplicaOnMove and ServiceDnsName
371+
372+
#### Before
373+
```powershell
374+
$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId
375+
$statelessService.Properties.MinInstanceCount = 3
376+
service | Set-AzServiceFabricManagedClusterService
377+
```
378+
#### After
379+
```powershell
380+
$service = Get-AzServiceFabricManagedClusterService -ResourceId $resourceId
381+
$statelessService.MinInstanceCount = 3
382+
service | Set-AzServiceFabricManagedClusterService
383+
```
384+
385+
386+

0 commit comments

Comments
 (0)