diff --git a/src/ElasticSan/ElasticSan.Autorest/Properties/AssemblyInfo.cs b/src/ElasticSan/ElasticSan.Autorest/Properties/AssemblyInfo.cs index 0582c863dbca..51665853a8d9 100644 --- a/src/ElasticSan/ElasticSan.Autorest/Properties/AssemblyInfo.cs +++ b/src/ElasticSan/ElasticSan.Autorest/Properties/AssemblyInfo.cs @@ -20,7 +20,7 @@ [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - ElasticSan")] -[assembly: System.Reflection.AssemblyFileVersionAttribute("1.4.0")] -[assembly: System.Reflection.AssemblyVersionAttribute("1.4.0")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("1.4.1")] +[assembly: System.Reflection.AssemblyVersionAttribute("1.4.1")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] diff --git a/src/ElasticSan/ElasticSan.Autorest/README.md b/src/ElasticSan/ElasticSan.Autorest/README.md index 2b7035f8f2b5..d7564e6aaf34 100644 --- a/src/ElasticSan/ElasticSan.Autorest/README.md +++ b/src/ElasticSan/ElasticSan.Autorest/README.md @@ -28,11 +28,11 @@ For information on how to develop for `Az.ElasticSan`, see [how-to.md](how-to.md ``` yaml # Please specify the commit id that includes your features to make sure generated codes stable. -commit: 72c69a0cf561d41ae99fe6810c426a874d3a8372 +commit: bcacfd106d182630f9a9d1ee4837d1b32da5bc1b require: - $(this-folder)/../../readme.azure.noprofile.md input-file: - - $(repo)/specification/elasticsan/resource-manager/Microsoft.ElasticSan/stable/2024-05-01/elasticsan.json + - $(repo)/specification/elasticsan/resource-manager/Microsoft.ElasticSan/ElasticSan/stable/2025-09-01/elasticsan.json # Normally, title is the service name title: ElasticSan @@ -109,6 +109,18 @@ directive: subject: VolumeSnapshot verb: Update remove: true + - where: + verb: Backup + subject: VolumePre + set: + verb: Test + subject: VolumeBackup + - where: + verb: Restore + subject: VolumePre + set: + verb: Test + subject: VolumeRestore - where: parameter-name: EncryptionIdentityEncryptionUserAssignedIdentity set: @@ -125,6 +137,38 @@ directive: parameter-name: KeyVaultPropertyKeyVersion set: parameter-name: KeyVersion + - where: + parameter-name: ScaleUpPropertyAutoScalePolicyEnforcement + set: + parameter-name: AutoScalePolicyEnforcement + - where: + parameter-name: ScaleUpPropertyCapacityUnitScaleUpLimitTiB + set: + parameter-name: CapacityUnitScaleUpLimitTiB + - where: + parameter-name: ScaleUpPropertyIncreaseCapacityUnitByTiB + set: + parameter-name: IncreaseCapacityUnitByTiB + - where: + parameter-name: ScaleUpPropertyUnusedSizeTiB + set: + parameter-name: UnusedSizeTiB + - where: + property-name: ScaleUpPropertyAutoScalePolicyEnforcement + set: + property-name: AutoScalePolicyEnforcement + - where: + property-name: ScaleUpPropertyCapacityUnitScaleUpLimitTiB + set: + property-name: CapacityUnitScaleUpLimitTiB + - where: + property-name: ScaleUpPropertyIncreaseCapacityUnitByTiB + set: + property-name: IncreaseCapacityUnitByTiB + - where: + property-name: ScaleUpPropertyUnusedSizeTiB + set: + property-name: UnusedSizeTiB # Change the description of cmdlets that correspond to multiple APIs - from: swagger-document where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}"].get diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json index 14512db58407..2af83e3cde7c 100644 --- a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json +++ b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-snapshots.json @@ -1,6 +1,6 @@ { "resourceType": "elasticSans/volumegroups/snapshots", - "apiVersion": "2024-05-01", + "apiVersion": "2025-09-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.elasticsan" }, diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json index aa32d75268d9..43e9fcc0e57c 100644 --- a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json +++ b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups-volumes.json @@ -1,6 +1,6 @@ { "resourceType": "elasticSans/volumegroups/volumes", - "apiVersion": "2024-05-01", + "apiVersion": "2025-09-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.elasticsan" }, diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json index 28a4d5e67fa4..ded9a2df6b10 100644 --- a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json +++ b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans-volumegroups.json @@ -1,6 +1,6 @@ { "resourceType": "elasticSans/volumegroups", - "apiVersion": "2024-05-01", + "apiVersion": "2025-09-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.elasticsan" }, diff --git a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json index 3ee6d207a82e..0781ada26939 100644 --- a/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json +++ b/src/ElasticSan/ElasticSan.Autorest/UX/Microsoft.ElasticSan/elasticSans.json @@ -1,6 +1,6 @@ { "resourceType": "elasticSans", - "apiVersion": "2024-05-01", + "apiVersion": "2025-09-01", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.elasticsan" }, diff --git a/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSan.ps1 b/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSan.ps1 index 69fbe44e310c..1c6fe2230b1e 100644 --- a/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSan.ps1 +++ b/src/ElasticSan/ElasticSan.Autorest/custom/New-AzElasticSan.ps1 @@ -87,6 +87,31 @@ param( # The sku name. ${SkuName}, + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.PSArgumentCompleterAttribute("None", "Enabled", "Disabled")] + [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')] + [System.String] + # Enable or Disable scale up setting on Elastic San Appliance. + ${AutoScalePolicyEnforcement}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')] + [System.Int64] + # Maximum scale up size on Elastic San appliance in TiB. + ${CapacityUnitScaleUpLimitTiB}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')] + [System.Int64] + # Unit to increase Capacity Unit on Elastic San appliance in TiB. + ${IncreaseCapacityUnitByTiB}, + + [Parameter()] + [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')] + [System.Int64] + # Unused size on Elastic San appliance in TiB. + ${UnusedSizeTiB}, + [Parameter()] [AllowEmptyCollection()] [Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Category('Body')] diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md index 4950b79e1177..806115073a5d 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/Az.ElasticSan.md @@ -1,6 +1,6 @@ --- Module Name: Az.ElasticSan -Module Guid: ffcb466a-f0cf-4285-bdad-8a1bbeebe0c4 +Module Guid: 456b0445-36ce-4b34-8599-4a4c894f5d1d Download Help Link: https://learn.microsoft.com/powershell/module/az.elasticsan Help Version: 1.0.0.0 Locale: en-US @@ -30,19 +30,19 @@ Get either a list of all volume groups from an Elastic SAN or get a single volum Get a Volume Snapshot. ### [New-AzElasticSan](New-AzElasticSan.md) -create ElasticSan. +Create ElasticSan. ### [New-AzElasticSanVirtualNetworkRuleObject](New-AzElasticSanVirtualNetworkRuleObject.md) Create an in-memory object for VirtualNetworkRule. ### [New-AzElasticSanVolume](New-AzElasticSanVolume.md) -create a Volume. +Create a Volume. ### [New-AzElasticSanVolumeGroup](New-AzElasticSanVolumeGroup.md) Create a Volume Group. ### [New-AzElasticSanVolumeSnapshot](New-AzElasticSanVolumeSnapshot.md) -create a Volume Snapshot. +Create a Volume Snapshot. ### [Remove-AzElasticSan](Remove-AzElasticSan.md) Delete a Elastic San. @@ -59,11 +59,17 @@ Remove a list of virtual network rules from a VolumeGroup ### [Remove-AzElasticSanVolumeSnapshot](Remove-AzElasticSanVolumeSnapshot.md) Delete a Volume Snapshot. +### [Test-AzElasticSanVolumeBackup](Test-AzElasticSanVolumeBackup.md) +Validate whether a disk snapshot backup can be taken for list of volumes. + +### [Test-AzElasticSanVolumeRestore](Test-AzElasticSanVolumeRestore.md) +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + ### [Update-AzElasticSan](Update-AzElasticSan.md) -update a Elastic San. +Update a Elastic San. ### [Update-AzElasticSanVolume](Update-AzElasticSanVolume.md) -update an Volume. +Update an Volume. ### [Update-AzElasticSanVolumeGroup](Update-AzElasticSanVolumeGroup.md) Update an VolumeGroup. diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md index 16f0d0ae5ddc..3b6204e0f389 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/Get-AzElasticSan.md @@ -45,53 +45,70 @@ Get-AzElasticSan ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup - /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan1 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 9/19/2022 9:50:25 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 0 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 0 - +UnusedSizeTiB : +VolumeGroupCount : 4 +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan2 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan2 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:48 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:48 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 0 ``` This command gets all the Elastic SANs in a subscription. @@ -102,53 +119,70 @@ Get-AzElasticSan -ResourceGroupName myresourcegroup ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup - /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan1 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 9/19/2022 9:50:25 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 0 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 0 - +UnusedSizeTiB : +VolumeGroupCount : 4 +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan2 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan2 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:48 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:48 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 0 ``` This command gets all Elastic SANs in a resource group. @@ -159,29 +193,38 @@ Get-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : +Location : eastus2 Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 4 ``` This command gets a specific Elastic SAN. diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md index b838c8c503a3..8a0b65367c4e 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSan.md @@ -8,58 +8,72 @@ schema: 2.0.0 # New-AzElasticSan ## SYNOPSIS -create ElasticSan. +Create ElasticSan. ## SYNTAX ### CreateExpanded (Default) ``` New-AzElasticSan -Name -ResourceGroupName -Location -SkuName - [-SubscriptionId ] [-AvailabilityZone ] [-BaseSizeTiB ] - [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] [-AutoScalePolicyEnforcement ] [-AvailabilityZone ] + [-BaseSizeTiB ] [-CapacityUnitScaleUpLimitTiB ] [-ExtendedCapacitySizeTiB ] + [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] + [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] ``` ### CreateViaIdentityExpanded ``` New-AzElasticSan -InputObject -Location -SkuName - [-AvailabilityZone ] [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] - [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-Confirm] [-WhatIf] [] + [-AutoScalePolicyEnforcement ] [-AvailabilityZone ] [-BaseSizeTiB ] + [-CapacityUnitScaleUpLimitTiB ] [-ExtendedCapacitySizeTiB ] + [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] + [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION -create ElasticSan. +Create ElasticSan. ## EXAMPLES ### Example 1: Create an Elastic SAN ```powershell -New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 1 -ExtendedCapacitySizeTib 6 -Location eastus -SkuName 'Premium_LRS' -Tag @{tag1="value1";tag2="value2"} +New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 1 -ExtendedCapacitySizeTib 6 -Location eastus -SkuName 'Premium_LRS' -AvailabilityZone 1 -Tag @{tag1="value1";tag2="value2"} -AutoScalePolicyEnforcement Enabled -CapacityUnitScaleUpLimitTiB 30 -IncreaseCapacityUnitByTiB 2 -UnusedSizeTiB 6 ``` ```output -AvailabilityZone : +AutoScalePolicyEnforcement : Enabled +AvailabilityZone : {1} BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : 30 ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : 2 +Location : eastus2euap Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 9/19/2022 9:47:26 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:47:26 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SkuTier : +SystemDataCreatedAt : 10/29/2025 3:07:36 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/29/2025 3:07:36 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : 6 VolumeGroupCount : 0 ``` @@ -71,27 +85,35 @@ New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -Location ``` ```output -AvailabilityZone : -BaseSizeTiB : 1 -ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +AutoScalePolicyEnforcement : +AvailabilityZone : {1} +BaseSizeTiB : 20 +CapacityUnitScaleUpLimitTiB : +ExtendedCapacitySizeTiB : 0 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : +Location : eastus2euap Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 9/19/2022 9:47:26 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:47:26 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags -TotalIops : 5000 -TotalMBps : 80 +SkuTier : +SystemDataCreatedAt : 10/29/2025 6:00:04 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/29/2025 6:00:04 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +TotalIops : 100000 +TotalMBps : 4000 TotalSizeTiB : 20 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : VolumeGroupCount : 0 ``` @@ -114,6 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoScalePolicyEnforcement +Enable or Disable scale up setting on Elastic San Appliance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AvailabilityZone Logical zone for Elastic San resource; example: ["1"]. @@ -145,6 +182,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CapacityUnitScaleUpLimitTiB +Maximum scale up size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -177,6 +229,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncreaseCapacityUnitByTiB +Unit to increase Capacity Unit on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -329,6 +396,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnusedSizeTiB +Unused size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md index 063a7190820e..6a73b742ba8f 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/New-AzElasticSanVolume.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzElasticSanVolume ## SYNOPSIS -create a Volume. +Create a Volume. ## SYNTAX @@ -42,7 +42,7 @@ New-AzElasticSanVolume -Name -VolumegroupInputObject -VolumegroupInputObject -ResourceGroupName -VolumeGroupName + -VolumeName [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### Backup +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName -VolumeGroupName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### BackupViaIdentity +``` +Test-AzElasticSanVolumeBackup -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### BackupViaIdentityElasticSan +``` +Test-AzElasticSanVolumeBackup -ElasticSanInputObject -VolumeGroupName + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### BackupViaIdentityElasticSanExpanded +``` +Test-AzElasticSanVolumeBackup -ElasticSanInputObject -VolumeGroupName + -VolumeName [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### BackupViaIdentityExpanded +``` +Test-AzElasticSanVolumeBackup -InputObject -VolumeName + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### BackupViaJsonFilePath +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName -VolumeGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### BackupViaJsonString +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName -VolumeGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Validate whether a disk snapshot backup can be taken for list of volumes. + +## EXAMPLES + +### Example 1: Validate whether a disk snapshot backup can be taken for list of volumes. +```powershell +Test-AzElasticSanVolumeBackup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -VolumeName myvolume +``` + +```output +ValidationStatus +---------------- +Success +``` + +This command validates whether a disk snapshot backup can be taken for list of volumes. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: BackupViaIdentityElasticSan, BackupViaIdentityElasticSanExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: BackupViaIdentity, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object to hold array of volume names + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IVolumeNameList +Parameter Sets: Backup, BackupViaIdentity, BackupViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Backup, BackupExpanded, BackupViaIdentityElasticSan, BackupViaIdentityElasticSanExpanded, BackupViaJsonFilePath, BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +array of volume names + +```yaml +Type: System.String[] +Parameter Sets: BackupExpanded, BackupViaIdentityElasticSanExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IVolumeNameList + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IPreValidationResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Test-AzElasticSanVolumeRestore.md b/src/ElasticSan/ElasticSan.Autorest/docs/Test-AzElasticSanVolumeRestore.md new file mode 100644 index 000000000000..1fc3952380a4 --- /dev/null +++ b/src/ElasticSan/ElasticSan.Autorest/docs/Test-AzElasticSanVolumeRestore.md @@ -0,0 +1,333 @@ +--- +external help file: +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/test-azelasticsanvolumerestore +schema: 2.0.0 +--- + +# Test-AzElasticSanVolumeRestore + +## SYNOPSIS +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## SYNTAX + +### RestoreExpanded (Default) +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName -VolumeGroupName + -DiskSnapshotId [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### Restore +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName -VolumeGroupName + -Parameter [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentity +``` +Test-AzElasticSanVolumeRestore -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaIdentityElasticSan +``` +Test-AzElasticSanVolumeRestore -ElasticSanInputObject -VolumeGroupName + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaIdentityElasticSanExpanded +``` +Test-AzElasticSanVolumeRestore -ElasticSanInputObject -VolumeGroupName + -DiskSnapshotId [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### RestoreViaIdentityExpanded +``` +Test-AzElasticSanVolumeRestore -InputObject -DiskSnapshotId + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### RestoreViaJsonFilePath +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName -VolumeGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### RestoreViaJsonString +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName -VolumeGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## EXAMPLES + +### Example 1: Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. +```powershell +Test-AzElasticSanVolumeRestore -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -DiskSnapshotId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Compute/snapshots/mydisksnapshot" +``` + +```output +ValidationStatus +---------------- +Success +``` + +This command validates whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSnapshotId +array of DiskSnapshot ARM IDs + +```yaml +Type: System.String[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityElasticSanExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: RestoreViaIdentityElasticSan, RestoreViaIdentityElasticSanExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: RestoreViaIdentity, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object to hold array of Disk Snapshot ARM IDs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IDiskSnapshotList +Parameter Sets: Restore, RestoreViaIdentity, RestoreViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: Restore, RestoreExpanded, RestoreViaIdentityElasticSan, RestoreViaIdentityElasticSanExpanded, RestoreViaJsonFilePath, RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IDiskSnapshotList + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IPreValidationResponse + +## NOTES + +## RELATED LINKS + diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md index 2e470ff18619..e8f0573313c5 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSan.md @@ -8,60 +8,73 @@ schema: 2.0.0 # Update-AzElasticSan ## SYNOPSIS -update a Elastic San. +Update a Elastic San. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzElasticSan -Name -ResourceGroupName [-SubscriptionId ] - [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-AutoScalePolicyEnforcement ] [-BaseSizeTiB ] [-CapacityUnitScaleUpLimitTiB ] + [-ExtendedCapacitySizeTiB ] [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] + [-Tag ] [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzElasticSan -InputObject [-BaseSizeTiB ] - [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +Update-AzElasticSan -InputObject [-AutoScalePolicyEnforcement ] + [-BaseSizeTiB ] [-CapacityUnitScaleUpLimitTiB ] [-ExtendedCapacitySizeTiB ] + [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] [-Tag ] + [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION -update a Elastic San. +Update a Elastic San. ## EXAMPLES ### Example 1: Update an Elastic SAN ```powershell -$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 64 -ExtendedCapacitySizeTib 128 -Tag @{"tag3" = "value3"} +$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 5 -ExtendedCapacitySizeTib 20 -Tag @{"tag3" = "value3"} -CapacityUnitScaleUpLimitTiB 20 -IncreaseCapacityUnitByTiB 2 -UnusedSizeTiB 5 -AutoScalePolicyEnforcement Disabled ``` ```output -AvailabilityZone : -BaseSizeTiB : 64 -ExtendedCapacitySizeTiB : 128 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +AutoScalePolicyEnforcement : Disabled +AvailabilityZone : 1 +BaseSizeTiB : 5 +CapacityUnitScaleUpLimitTiB : 20 +ExtendedCapacitySizeTiB : 20 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : 2 +Location : eastus2 Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 8/16/2022 4:59:54 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/16/2022 4:59:54 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags -TotalIops : 320000 -TotalMBps : 5120 -TotalSizeTiB : 192 +SkuTier : +SystemDataCreatedAt : 9/30/2024 3:41:50 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/30/2024 3:55:11 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag3": "value3" + } +TotalIops : 25000 +TotalMBps : 1000 +TotalSizeTiB : 25 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : 5 VolumeGroupCount : 0 ``` -This command updates the BaseSizeTib, ExtendedCapacitySizeTib, and Tag properties of an Elastic SAN. +This command updates properties of an Elastic SAN. ## PARAMETERS @@ -80,6 +93,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoScalePolicyEnforcement +Enable or Disable scale up setting on Elastic San Appliance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BaseSizeTiB Base size of the Elastic San appliance in TiB. @@ -95,6 +123,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CapacityUnitScaleUpLimitTiB +Maximum scale up size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -126,6 +169,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncreaseCapacityUnitByTiB +Unit to increase Capacity Unit on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -233,6 +291,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnusedSizeTiB +Unused size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md index e4baac890ce4..76122889e7b0 100644 --- a/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md +++ b/src/ElasticSan/ElasticSan.Autorest/docs/Update-AzElasticSanVolume.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzElasticSanVolume ## SYNOPSIS -update an Volume. +Update an Volume. ## SYNTAX @@ -39,7 +39,7 @@ Update-AzElasticSanVolume -Name -VolumegroupInputObject ## Upcoming Release - +* Supported auto scale when creating and updating an Elastic SAN. + - `New-AzElasticSan` + - `Update-AzElasticSan` +* Supported checking whether disk snapshot backup can be taken for volumes. + - `Test-AzElasticSanVolumeBackup` + - `Test-AzElasticSanVolumeRestore` + ## Version 1.4.1 * Added warning message for data integrity checking when create/update a volume group. - `New-AzElasticSanVolumeGroup` diff --git a/src/ElasticSan/ElasticSan/help/Az.ElasticSan.md b/src/ElasticSan/ElasticSan/help/Az.ElasticSan.md index 1f567482fca5..e727cd430882 100644 --- a/src/ElasticSan/ElasticSan/help/Az.ElasticSan.md +++ b/src/ElasticSan/ElasticSan/help/Az.ElasticSan.md @@ -59,6 +59,12 @@ Remove a list of virtual network rules from a VolumeGroup ### [Remove-AzElasticSanVolumeSnapshot](Remove-AzElasticSanVolumeSnapshot.md) Delete a Volume Snapshot. +### [Test-AzElasticSanVolumeBackup](Test-AzElasticSanVolumeBackup.md) +Validate whether a disk snapshot backup can be taken for list of volumes. + +### [Test-AzElasticSanVolumeRestore](Test-AzElasticSanVolumeRestore.md) +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + ### [Update-AzElasticSan](Update-AzElasticSan.md) Update a Elastic San. diff --git a/src/ElasticSan/ElasticSan/help/Get-AzElasticSan.md b/src/ElasticSan/ElasticSan/help/Get-AzElasticSan.md index 4fcc9e5824b9..29f60e706c70 100644 --- a/src/ElasticSan/ElasticSan/help/Get-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan/help/Get-AzElasticSan.md @@ -47,53 +47,70 @@ Get-AzElasticSan ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup - /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan1 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 9/19/2022 9:50:25 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 0 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 0 - +UnusedSizeTiB : +VolumeGroupCount : 4 +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan2 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan2 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:48 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:48 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 0 ``` This command gets all the Elastic SANs in a subscription. @@ -104,53 +121,70 @@ Get-AzElasticSan -ResourceGroupName myresourcegroup ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup - /providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan1 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan1 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 9/19/2022 9:50:25 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:50:25 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 0 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 0 - +UnusedSizeTiB : +VolumeGroupCount : 4 +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan2 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan2 +IncreaseCapacityUnitByTiB : Location : eastus Name : myelasticsan2 +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:48 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:48 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 0 ``` This command gets all Elastic SANs in a resource group. @@ -161,29 +195,38 @@ Get-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan ``` ```output +AutoScalePolicyEnforcement : AvailabilityZone : BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Micr - osoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : +Location : eastus2 Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS SkuTier : -SystemDataCreatedAt : 8/18/2022 8:42:21 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/18/2022 8:42:21 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SystemDataCreatedAt : 9/29/2024 2:34:21 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/29/2024 2:34:21 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 -TotalVolumeSizeGiB : 100 +TotalVolumeSizeGiB : 120 Type : Microsoft.ElasticSan/ElasticSans -VolumeGroupCount : 7 +UnusedSizeTiB : +VolumeGroupCount : 4 ``` This command gets a specific Elastic SAN. diff --git a/src/ElasticSan/ElasticSan/help/New-AzElasticSan.md b/src/ElasticSan/ElasticSan/help/New-AzElasticSan.md index 5f1f800a6eb8..8e3c7bd2be48 100644 --- a/src/ElasticSan/ElasticSan/help/New-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan/help/New-AzElasticSan.md @@ -8,58 +8,72 @@ schema: 2.0.0 # New-AzElasticSan ## SYNOPSIS -create ElasticSan. +Create ElasticSan. ## SYNTAX ### CreateExpanded (Default) ``` New-AzElasticSan -Name -ResourceGroupName [-SubscriptionId ] -Location - -SkuName [-AvailabilityZone ] [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] - [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] + -SkuName [-AutoScalePolicyEnforcement ] [-CapacityUnitScaleUpLimitTiB ] + [-IncreaseCapacityUnitByTiB ] [-UnusedSizeTiB ] [-AvailabilityZone ] + [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-SkuTier ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateViaIdentityExpanded ``` New-AzElasticSan -InputObject -Location -SkuName - [-AvailabilityZone ] [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] - [-PublicNetworkAccess ] [-SkuTier ] [-Tag ] [-DefaultProfile ] [-AsJob] - [-NoWait] [-WhatIf] [-Confirm] [] + [-AutoScalePolicyEnforcement ] [-CapacityUnitScaleUpLimitTiB ] + [-IncreaseCapacityUnitByTiB ] [-UnusedSizeTiB ] [-AvailabilityZone ] + [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-SkuTier ] + [-Tag ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -create ElasticSan. +Create ElasticSan. ## EXAMPLES ### Example 1: Create an Elastic SAN ```powershell -New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 1 -ExtendedCapacitySizeTib 6 -Location eastus -SkuName 'Premium_LRS' -Tag @{tag1="value1";tag2="value2"} +New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 1 -ExtendedCapacitySizeTib 6 -Location eastus -SkuName 'Premium_LRS' -AvailabilityZone 1 -Tag @{tag1="value1";tag2="value2"} -AutoScalePolicyEnforcement Enabled -CapacityUnitScaleUpLimitTiB 30 -IncreaseCapacityUnitByTiB 2 -UnusedSizeTiB 6 ``` ```output -AvailabilityZone : +AutoScalePolicyEnforcement : Enabled +AvailabilityZone : {1} BaseSizeTiB : 1 +CapacityUnitScaleUpLimitTiB : 30 ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : 2 +Location : eastus2euap Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 9/19/2022 9:47:26 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:47:26 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags +SkuTier : +SystemDataCreatedAt : 10/29/2025 3:07:36 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/29/2025 3:07:36 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag1": "value1", + "tag2": "value2" + } TotalIops : 5000 -TotalMBps : 80 +TotalMBps : 200 TotalSizeTiB : 7 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : 6 VolumeGroupCount : 0 ``` @@ -71,27 +85,35 @@ New-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -Location ``` ```output -AvailabilityZone : -BaseSizeTiB : 1 -ExtendedCapacitySizeTiB : 6 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +AutoScalePolicyEnforcement : +AvailabilityZone : {1} +BaseSizeTiB : 20 +CapacityUnitScaleUpLimitTiB : +ExtendedCapacitySizeTiB : 0 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : +Location : eastus2euap Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 9/19/2022 9:47:26 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 9/19/2022 9:47:26 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags -TotalIops : 5000 -TotalMBps : 80 +SkuTier : +SystemDataCreatedAt : 10/29/2025 6:00:04 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 10/29/2025 6:00:04 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +TotalIops : 100000 +TotalMBps : 4000 TotalSizeTiB : 20 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : VolumeGroupCount : 0 ``` @@ -114,6 +136,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoScalePolicyEnforcement +Enable or Disable scale up setting on Elastic San Appliance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AvailabilityZone Logical zone for Elastic San resource; example: ["1"]. @@ -145,6 +182,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CapacityUnitScaleUpLimitTiB +Maximum scale up size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -177,6 +229,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncreaseCapacityUnitByTiB +Unit to increase Capacity Unit on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -329,6 +396,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnusedSizeTiB +Unused size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolume.md index d87939a4240d..c9e04d649972 100644 --- a/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolume.md +++ b/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolume.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzElasticSanVolume ## SYNOPSIS -create a Volume. +Create a Volume. ## SYNTAX @@ -43,7 +43,7 @@ New-AzElasticSanVolume -InputObject -SizeGiB [-Cre ``` ## DESCRIPTION -create a Volume. +Create a Volume. ## EXAMPLES diff --git a/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolumeSnapshot.md b/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolumeSnapshot.md index f06ff935bb02..c90d8487df75 100644 --- a/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolumeSnapshot.md +++ b/src/ElasticSan/ElasticSan/help/New-AzElasticSanVolumeSnapshot.md @@ -8,7 +8,7 @@ schema: 2.0.0 # New-AzElasticSanVolumeSnapshot ## SYNOPSIS -create a Volume Snapshot. +Create a Volume Snapshot. ## SYNTAX @@ -42,7 +42,7 @@ New-AzElasticSanVolumeSnapshot -InputObject -CreationDataS ``` ## DESCRIPTION -create a Volume Snapshot. +Create a Volume Snapshot. ## EXAMPLES diff --git a/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeBackup.md b/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeBackup.md new file mode 100644 index 000000000000..1c658bb5a3db --- /dev/null +++ b/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeBackup.md @@ -0,0 +1,334 @@ +--- +external help file: Az.ElasticSan-help.xml +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/test-azelasticsanvolumebackup +schema: 2.0.0 +--- + +# Test-AzElasticSanVolumeBackup + +## SYNOPSIS +Validate whether a disk snapshot backup can be taken for list of volumes. + +## SYNTAX + +### BackupExpanded (Default) +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -VolumeName [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaJsonString +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaJsonFilePath +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### Backup +``` +Test-AzElasticSanVolumeBackup -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityElasticSanExpanded +``` +Test-AzElasticSanVolumeBackup -VolumeGroupName -ElasticSanInputObject + -VolumeName [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityElasticSan +``` +Test-AzElasticSanVolumeBackup -VolumeGroupName -ElasticSanInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### BackupViaIdentityExpanded +``` +Test-AzElasticSanVolumeBackup -InputObject -VolumeName + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### BackupViaIdentity +``` +Test-AzElasticSanVolumeBackup -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Validate whether a disk snapshot backup can be taken for list of volumes. + +## EXAMPLES + +### Example 1: Validate whether a disk snapshot backup can be taken for list of volumes. +```powershell +Test-AzElasticSanVolumeBackup -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -VolumeName myvolume +``` + +```output +ValidationStatus +---------------- +Success +``` + +This command validates whether a disk snapshot backup can be taken for list of volumes. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: BackupViaIdentityElasticSanExpanded, BackupViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaJsonString, BackupViaJsonFilePath, Backup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: BackupViaIdentityExpanded, BackupViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Backup operation + +```yaml +Type: System.String +Parameter Sets: BackupViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object to hold array of volume names + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IVolumeNameList +Parameter Sets: Backup, BackupViaIdentityElasticSan, BackupViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaJsonString, BackupViaJsonFilePath, Backup +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaJsonString, BackupViaJsonFilePath, Backup +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: BackupExpanded, BackupViaJsonString, BackupViaJsonFilePath, Backup, BackupViaIdentityElasticSanExpanded, BackupViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeName +array of volume names + +```yaml +Type: System.String[] +Parameter Sets: BackupExpanded, BackupViaIdentityElasticSanExpanded, BackupViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IVolumeNameList + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IPreValidationResponse + +## NOTES + +## RELATED LINKS diff --git a/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeRestore.md b/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeRestore.md new file mode 100644 index 000000000000..8619d1c5b0e7 --- /dev/null +++ b/src/ElasticSan/ElasticSan/help/Test-AzElasticSanVolumeRestore.md @@ -0,0 +1,334 @@ +--- +external help file: Az.ElasticSan-help.xml +Module Name: Az.ElasticSan +online version: https://learn.microsoft.com/powershell/module/az.elasticsan/test-azelasticsanvolumerestore +schema: 2.0.0 +--- + +# Test-AzElasticSanVolumeRestore + +## SYNOPSIS +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## SYNTAX + +### RestoreExpanded (Default) +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -DiskSnapshotId [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonString +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaJsonFilePath +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### Restore +``` +Test-AzElasticSanVolumeRestore -ElasticSanName -ResourceGroupName [-SubscriptionId ] + -VolumeGroupName -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityElasticSanExpanded +``` +Test-AzElasticSanVolumeRestore -VolumeGroupName -ElasticSanInputObject + -DiskSnapshotId [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityElasticSan +``` +Test-AzElasticSanVolumeRestore -VolumeGroupName -ElasticSanInputObject + -Parameter [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### RestoreViaIdentityExpanded +``` +Test-AzElasticSanVolumeRestore -InputObject -DiskSnapshotId + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### RestoreViaIdentity +``` +Test-AzElasticSanVolumeRestore -InputObject -Parameter + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## EXAMPLES + +### Example 1: Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes. +```powershell +Test-AzElasticSanVolumeRestore -ResourceGroupName myresourcegroup -ElasticSanName myelasticsan -VolumeGroupName myvolumegroup -DiskSnapshotId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.Compute/snapshots/mydisksnapshot" +``` + +```output +ValidationStatus +---------------- +Success +``` + +This command validates whether a list of backed up disk snapshots can be restored into ElasticSan volumes. + +## PARAMETERS + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSnapshotId +array of DiskSnapshot ARM IDs + +```yaml +Type: System.String[] +Parameter Sets: RestoreExpanded, RestoreViaIdentityElasticSanExpanded, RestoreViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ElasticSanInputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: RestoreViaIdentityElasticSanExpanded, RestoreViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ElasticSanName +The name of the ElasticSan. + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaJsonString, RestoreViaJsonFilePath, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity +Parameter Sets: RestoreViaIdentityExpanded, RestoreViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Restore operation + +```yaml +Type: System.String +Parameter Sets: RestoreViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameter +object to hold array of Disk Snapshot ARM IDs + +```yaml +Type: Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IDiskSnapshotList +Parameter Sets: Restore, RestoreViaIdentityElasticSan, RestoreViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaJsonString, RestoreViaJsonFilePath, Restore +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaJsonString, RestoreViaJsonFilePath, Restore +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VolumeGroupName +The name of the VolumeGroup. + +```yaml +Type: System.String +Parameter Sets: RestoreExpanded, RestoreViaJsonString, RestoreViaJsonFilePath, Restore, RestoreViaIdentityElasticSanExpanded, RestoreViaIdentityElasticSan +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IDiskSnapshotList + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IElasticSanIdentity + +## OUTPUTS + +### Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.IPreValidationResponse + +## NOTES + +## RELATED LINKS diff --git a/src/ElasticSan/ElasticSan/help/Update-AzElasticSan.md b/src/ElasticSan/ElasticSan/help/Update-AzElasticSan.md index b3a1d8f1ac04..4cfd4e8b39b8 100644 --- a/src/ElasticSan/ElasticSan/help/Update-AzElasticSan.md +++ b/src/ElasticSan/ElasticSan/help/Update-AzElasticSan.md @@ -8,62 +8,73 @@ schema: 2.0.0 # Update-AzElasticSan ## SYNOPSIS -update a Elastic San. +Update a Elastic San. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzElasticSan -Name -ResourceGroupName [-SubscriptionId ] - [-BaseSizeTiB ] [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + [-AutoScalePolicyEnforcement ] [-BaseSizeTiB ] [-CapacityUnitScaleUpLimitTiB ] + [-ExtendedCapacitySizeTiB ] [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] + [-Tag ] [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzElasticSan -InputObject [-BaseSizeTiB ] - [-ExtendedCapacitySizeTiB ] [-PublicNetworkAccess ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] +Update-AzElasticSan -InputObject [-AutoScalePolicyEnforcement ] + [-BaseSizeTiB ] [-CapacityUnitScaleUpLimitTiB ] [-ExtendedCapacitySizeTiB ] + [-IncreaseCapacityUnitByTiB ] [-PublicNetworkAccess ] [-Tag ] + [-UnusedSizeTiB ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -update a Elastic San. +Update a Elastic San. ## EXAMPLES ### Example 1: Update an Elastic SAN ```powershell -$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 64 -ExtendedCapacitySizeTib 128 -Tag @{"tag3" = "value3"} +$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 5 -ExtendedCapacitySizeTib 20 -Tag @{"tag3" = "value3"} -CapacityUnitScaleUpLimitTiB 20 -IncreaseCapacityUnitByTiB 2 -UnusedSizeTiB 5 -AutoScalePolicyEnforcement Disabled ``` ```output -AvailabilityZone : -BaseSizeTiB : 64 -ExtendedCapacitySizeTiB : 128 -Id : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan -Location : eastus +AutoScalePolicyEnforcement : Disabled +AvailabilityZone : 1 +BaseSizeTiB : 5 +CapacityUnitScaleUpLimitTiB : 20 +ExtendedCapacitySizeTiB : 20 +Id : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myresourcegroup/providers/Microsoft.ElasticSan/elasticSans/myelasticsan +IncreaseCapacityUnitByTiB : 2 +Location : eastus2 Name : myelasticsan +PrivateEndpointConnection : ProvisioningState : Succeeded +PublicNetworkAccess : +ResourceGroupName : myresourcegroup SkuName : Premium_LRS -SkuTier : -SystemDataCreatedAt : 8/16/2022 4:59:54 AM -SystemDataCreatedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataCreatedByType : Application -SystemDataLastModifiedAt : 8/16/2022 4:59:54 AM -SystemDataLastModifiedBy : yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy -SystemDataLastModifiedByType : Application -Tag : Microsoft.Azure.PowerShell.Cmdlets.ElasticSan.Models.Api20211120Preview.ResourceTags -TotalIops : 320000 -TotalMBps : 5120 -TotalSizeTiB : 192 +SkuTier : +SystemDataCreatedAt : 9/30/2024 3:41:50 AM +SystemDataCreatedBy : example@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 9/30/2024 3:55:11 AM +SystemDataLastModifiedBy : example@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "tag3": "value3" + } +TotalIops : 25000 +TotalMBps : 1000 +TotalSizeTiB : 25 TotalVolumeSizeGiB : 0 Type : Microsoft.ElasticSan/ElasticSans +UnusedSizeTiB : 5 VolumeGroupCount : 0 ``` -This command updates the BaseSizeTib, ExtendedCapacitySizeTib, and Tag properties of an Elastic SAN. +This command updates properties of an Elastic SAN. ## PARAMETERS @@ -82,6 +93,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AutoScalePolicyEnforcement +Enable or Disable scale up setting on Elastic San Appliance. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -BaseSizeTiB Base size of the Elastic San appliance in TiB. @@ -97,6 +123,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -CapacityUnitScaleUpLimitTiB +Maximum scale up size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultProfile The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. @@ -128,6 +169,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncreaseCapacityUnitByTiB +Unit to increase Capacity Unit on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject Identity Parameter @@ -235,6 +291,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UnusedSizeTiB +Unused size on Elastic San appliance in TiB. + +```yaml +Type: System.Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. diff --git a/src/ElasticSan/ElasticSan/help/Update-AzElasticSanVolume.md b/src/ElasticSan/ElasticSan/help/Update-AzElasticSanVolume.md index 0405ea498d90..6c4a374e2824 100644 --- a/src/ElasticSan/ElasticSan/help/Update-AzElasticSanVolume.md +++ b/src/ElasticSan/ElasticSan/help/Update-AzElasticSanVolume.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Update-AzElasticSanVolume ## SYNOPSIS -update an Volume. +Update an Volume. ## SYNTAX @@ -40,7 +40,7 @@ Update-AzElasticSanVolume -InputObject [-SizeGiB ] ``` ## DESCRIPTION -update an Volume. +Update an Volume. ## EXAMPLES