Skip to content

Commit 2e9221e

Browse files
authored
[Az.ElasticSan]Update warning for data integration check in new/create volume group cmdlets (#28002)
1 parent 1d832c7 commit 2e9221e

14 files changed

+46
-36
lines changed

src/ElasticSan/ElasticSan.Autorest/Properties/AssemblyInfo.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")]
2121
[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")]
2222
[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - ElasticSan")]
23-
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.2.1")]
24-
[assembly: System.Reflection.AssemblyVersionAttribute("1.2.1")]
23+
[assembly: System.Reflection.AssemblyFileVersionAttribute("1.4.0")]
24+
[assembly: System.Reflection.AssemblyVersionAttribute("1.4.0")]
2525
[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)]
2626
[assembly: System.CLSCompliantAttribute(false)]

src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSan.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,13 @@ param(
9797
[Parameter()]
9898
[Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
9999
[System.Int64]
100-
# Base size of the Elastic San appliance in TiB. Default vaule is 20.
100+
# Base size of the Elastic San appliance in TiB. Default value is 20.
101101
${BaseSizeTiB},
102102

103103
[Parameter()]
104104
[Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')]
105105
[System.Int64]
106-
# Extended size of the Elastic San appliance in TiB. Default vaule is 0.
106+
# Extended size of the Elastic San appliance in TiB. Default value is 0.
107107
${ExtendedCapacitySizeTiB},
108108

109109
[Parameter()]

src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSanVolumeGroup.ps1

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,8 +239,11 @@ function New-AzElasticSanVolumeGroup {
239239
$null = $PSBoundParameters.Remove('IdentityUserAssignedIdentityId')
240240
}
241241

242-
if (($PSBoundParameters.ContainsKey("EnforceDataIntegrityCheckForIscsi") -eq $false) -or ($PSBoundParameters.EnforceDataIntegrityCheckForIscsi -eq $true)) {
243-
Write-Warning "This needs CRC32C to be set on header and data digests on the client for all the connections from the client to the volumes in this volume group. You can do this by connecting to the volumes from the client using multi-session scripts generated in portal connect flow or from documentation, which contain steps to set CRC32C on header and data digests. Do not enable CRC protection on the volume group if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Refer to https://learn.microsoft.com/en-us/azure/storage/elastic-san/elastic-san-create?tabs=azure-portal for more information."
242+
if (($PSBoundParameters.ContainsKey("EnforceDataIntegrityCheckForIscsi") -eq $true) -and ($PSBoundParameters.EnforceDataIntegrityCheckForIscsi -eq $true)) {
243+
Write-Warning "CRC protection feature is not supported for Azure VMware solution (AVS) yet. Do not enable this flag if you plan to use the volumes within this volume group as datastores for AVS, as the datastore creation will fail. For Azure Virtual Machines, enabling this flag would need CRC32C to be set on iSCSI header and data digests on the client for all the connections from the client to the volumes in this volume group. You can achieve that by disconnecting the volumes from the client and reconnecting using multi-session scripts generated in portal connect flow or from documentation, which contain steps to set CRC32C on header and data digests. Do not enable CRC protection on the volume group if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Learn more: https://go.microsoft.com/fwlink/?LinkId=2294733&id=Microsoft_Azure_ElasticSan"
244+
}
245+
else {
246+
Write-Warning "CRC protection is recommended if you plan to connect the volumes in this volume group to Azure Virtual Machines. Do not enable it if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. on your VM, as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Also, do not enable this flag if you plan to use the volumes within this volume group as datastores for Azure VMware Solution (AVS), as this feature is not supported for AVS yet and the datastore creation will fail. Learn more: https://go.microsoft.com/fwlink/?LinkId=2294733&id=Microsoft_Azure_ElasticSan"
244247
}
245248

246249
Az.ElasticSan.internal\New-AzElasticSanVolumeGroup @PSBoundParameters

src/ElasticSan/ElasticSan.Autorest/custom/Update-AzElasticSanVolumeGroup.ps1

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,12 @@ function Update-AzElasticSanVolumeGroup {
268268
}
269269

270270
if ($PSBoundParameters.ContainsKey("EnforceDataIntegrityCheckForIscsi") -and ($PSBoundParameters.EnforceDataIntegrityCheckForIscsi -eq $true)) {
271-
Write-Warning "This needs CRC32C to be set on header and data digests on the client for all the connections from the client to the volumes in this volume group. You can do this by disconnecting the volumes from the client and reconnecting using multi-session scripts generated in portal connect flow or from documentation, which contain steps to set CRC32C on header and data digests. Do not enable CRC protection on the volume group if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Refer to https://learn.microsoft.com/en-us/azure/storage/elastic-san/elastic-san-create?tabs=azure-portal for more information."
272-
}
271+
Write-Warning "CRC protection feature is not supported for Azure VMware solution (AVS) yet. Do not enable this flag if you plan to use the volumes within this volume group as datastores for AVS, as the datastore creation will fail. For Azure Virtual Machines, enabling this flag would need CRC32C to be set on iSCSI header and data digests on the client for all the connections from the client to the volumes in this volume group. You can achieve that by disconnecting the volumes from the client and reconnecting using multi-session scripts generated in portal connect flow or from documentation, which contain steps to set CRC32C on header and data digests. Do not enable CRC protection on the volume group if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Learn more: https://go.microsoft.com/fwlink/?LinkId=2294733&id=Microsoft_Azure_ElasticSan"
272+
}
273+
else {
274+
Write-Warning "CRC protection is recommended if you plan to connect the volumes in this volume group to Azure Virtual Machines. Do not enable it if you are using Fedora or its downstream Linux distributions such as RHEL, CentOS etc. on your VM, as data digests are not supported on them. If you enable this flag for those distributions, connectivity to the volumes will fail. Also, do not enable this flag if you plan to use the volumes within this volume group as datastores for Azure VMware Solution (AVS), as this feature is not supported for AVS yet and the datastore creation will fail. Learn more: https://go.microsoft.com/fwlink/?LinkId=2294733&id=Microsoft_Azure_ElasticSan"
275+
}
276+
273277
Az.ElasticSan.internal\Update-AzElasticSanVolumeGroup @PSBoundParameters
274278
}
275279
}

src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
Module Name: Az.ElasticSan
3-
Module Guid: 4ec5915a-3898-41f7-a00b-29a4da49fc64
3+
Module Guid: ffcb466a-f0cf-4285-bdad-8a1bbeebe0c4
44
Download Help Link: https://learn.microsoft.com/powershell/module/az.elasticsan
55
Help Version: 1.0.0.0
66
Locale: en-US

src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Accept wildcard characters: False
131131
132132
### -BaseSizeTiB
133133
Base size of the Elastic San appliance in TiB.
134-
Default vaule is 20.
134+
Default value is 20.
135135
136136
```yaml
137137
Type: System.Int64
@@ -163,7 +163,7 @@ Accept wildcard characters: False
163163
164164
### -ExtendedCapacitySizeTiB
165165
Extended size of the Elastic San appliance in TiB.
166-
Default vaule is 0.
166+
Default value is 0.
167167
168168
```yaml
169169
Type: System.Int64

src/ElasticSan/ElasticSan.Autorest/docs/Remove-AzElasticSanVolumeGroupNetworkRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Remove a list of virtual network rules from a VolumeGroup
3333

3434
### Example 1: Remove network rules by NetworkAclsVirtualNetworkRule objects
3535
```powershell
36-
# Initialze network rule objects
36+
# Initialize network rule objects
3737
$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow
3838
$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow
3939
$virtualNetworkRule3 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3" -Action Allow

src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolumeGroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ SystemDataLastModifiedByType : Application
7272
Type : Microsoft.ElasticSan/ElasticSans
7373
```
7474

75-
This example updates the protocol type and virtual network rules of a volume gorup
75+
This example updates the protocol type and virtual network rules of a volume group
7676

7777
### Example 2: Update a volume group virtual network rule with JSON input
7878
```powershell

src/ElasticSan/ElasticSan.Autorest/examples/Remove-AzElasticSanVolumeGroupNetworkRule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Example 1: Remove network rules by NetworkAclsVirtualNetworkRule objects
22
```powershell
3-
# Initialze network rule objects
3+
# Initialize network rule objects
44
$virtualNetworkRule1 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet1" -Action Allow
55
$virtualNetworkRule2 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet2" -Action Allow
66
$virtualNetworkRule3 = New-AzElasticSanVirtualNetworkRuleObject -VirtualNetworkResourceId "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/subnet3" -Action Allow

src/ElasticSan/ElasticSan.Autorest/examples/Update-AzElasticSanVolumeGroup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ SystemDataLastModifiedByType : Application
2323
Type : Microsoft.ElasticSan/ElasticSans
2424
```
2525

26-
This example updates the protocol type and virtual network rules of a volume gorup
26+
This example updates the protocol type and virtual network rules of a volume group
2727

2828
### Example 2: Update a volume group virtual network rule with JSON input
2929
```powershell

0 commit comments

Comments
 (0)