Update-AzElasticSan
Syntax
UpdateExpanded (Default)
Update-AzElasticSan
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AutoScalePolicyEnforcement <String>]
[-BaseSizeTiB <Int64>]
[-CapacityUnitScaleUpLimitTiB <Int64>]
[-ExtendedCapacitySizeTiB <Int64>]
[-IncreaseCapacityUnitByTiB <Int64>]
[-PublicNetworkAccess <String>]
[-Tag <Hashtable>]
[-UnusedSizeTiB <Int64>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
Update-AzElasticSan
-InputObject <IElasticSanIdentity>
[-AutoScalePolicyEnforcement <String>]
[-BaseSizeTiB <Int64>]
[-CapacityUnitScaleUpLimitTiB <Int64>]
[-ExtendedCapacitySizeTiB <Int64>]
[-IncreaseCapacityUnitByTiB <Int64>]
[-PublicNetworkAccess <String>]
[-Tag <Hashtable>]
[-UnusedSizeTiB <Int64>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Update an Elastic SAN
$elasticSan = Update-AzElasticSan -ResourceGroupName myresourcegroup -Name myelasticsan -BaseSizeTib 5 -ExtendedCapacitySizeTib 20 -Tag @{"tag3" = "value3"} -CapacityUnitScaleUpLimitTiB 20 -IncreaseCapacityUnitByTiB 2 -UnusedSizeTiB 5 -AutoScalePolicyEnforcement Disabled
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 : 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 properties of an Elastic SAN.
Parameters
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-AutoScalePolicyEnforcement
Enable or Disable scale up setting on Elastic San Appliance.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-BaseSizeTiB
Base size of the Elastic San appliance in TiB.
Parameter properties
Type: Int64
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-CapacityUnitScaleUpLimitTiB
Maximum scale up size on Elastic San appliance in TiB.
Parameter properties
Type: Int64
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: cf
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Parameter properties
Type: PSObject
Default value: None
Supports wildcards: False
DontShow: False
Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ExtendedCapacitySizeTiB
Extended size of the Elastic San appliance in TiB.
Parameter properties
Type: Int64
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-IncreaseCapacityUnitByTiB
Unit to increase Capacity Unit on Elastic San appliance in TiB.
Parameter properties
Type: Int64
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
Identity Parameter
UpdateViaIdentityExpanded
Position: Named
Mandatory: True
Value from pipeline: True
Value from pipeline by property name: False
Value from remaining arguments: False
-Name
The name of the ElasticSan.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Aliases: ElasticSanName
Parameter sets
UpdateExpanded
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-PublicNetworkAccess
Allow or disallow public network access to ElasticSan Account.
Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
UpdateExpanded
Position: Named
Mandatory: True
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id
Supports wildcards: False
DontShow: False
Parameter sets
UpdateExpanded
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-Tag
Update tags
Parameter properties
Type: Hashtable
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-UnusedSizeTiB
Unused size on Elastic San appliance in TiB.
Parameter properties
Type: Int64
Default value: None
Supports wildcards: False
DontShow: False
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None
Supports wildcards: False
DontShow: False
Aliases: wi
Parameter sets
(All)
Position: Named
Mandatory: False
Value from pipeline: False
Value from pipeline by property name: False
Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs