< Back
Set-AzureStorSimpleDeviceVolume
Post
NAME Set-AzureStorSimpleDeviceVolume
SYNOPSIS
Updates the properties of an existing volume.
SYNTAX
Set-AzureStorSimpleDeviceVolume [-DeviceName] <System.String> [-VolumeName] <System.String> [[-Online] <Nullable [System.Boolean]>]
[[-VolumeSizeInBytes] <Nullable [System.Int64]>] [[-VolumeAppType] {PrimaryVolume | ArchiveVolume}] [[-AccessControlRecords] <0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35]]>] [[-WaitForComplete]] [[-NewName] <System.String>] [-Profile
<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<CommonParameters>]
Set-AzureStorSimpleDeviceVolume [-DeviceName] <System.String> [-Volume] <Microsoft.WindowsAzure.Management.StorSimple.Models.VirtualDisk> [[-Online]
<Nullable [System.Boolean]>] [[-VolumeSizeInBytes] <Nullable [System.Int64]>] [[-VolumeAppType] {PrimaryVolume | ArchiveVolume}]
[[-AccessControlRecords] <0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]>] [[-WaitForComplete]] [[-NewName] <System.String>] [-Profile
<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<CommonParameters>]
DESCRIPTION
The Set-AzureStorSimpleDeviceVolume cmdlet updates the properties of an existing volume. This cmdlet associates a volume with one or more access control
records. To obtain AccessControlRecord objects, use the Get-AzureStorSimpleAccessControlRecord cmdlet. Update the size or type for the volume. Also,
update whether to create the volume online.
PARAMETERS
-AccessControlRecords [<0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]>]
Specifies a list of access control records to associate with the volume.
Required? false
Position? 6
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-DeviceName <System.String>
Specifies the name of the StorSimple device on which to update the volume exists.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NewName [<System.String>]
Specifies a new name for the StorSimple device.
Required? false
Position? 8
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Online [<Nullable [System.Boolean]>]
Specifies whether the volume is online.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]
Specifies an Azure profile.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Volume <Microsoft.WindowsAzure.Management.StorSimple.Models.VirtualDisk>
Specifies the name of the volume to update.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-VolumeAppType [<Nullable [Microsoft.WindowsAzure.Management.StorSimple.Models.AppType]>]
Specifies whether to update the volume to be a primary or archive volume. Valid values are: PrimaryVolume and ArchiveVolume.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-VolumeName <System.String>
Specifies the name of the volume to update.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-VolumeSizeInBytes [<Nullable [System.Int64]>]
Specifies the updated size, in bytes, for the volume.
Required? false
Position? 4
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-WaitForComplete [<SwitchParameter>]
Indicates that this cmdlet waits for the operation to complete before it returns control to the Windows PowerShell????????? console.
Required? false
Position? 7
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
List<AccessControlRecord>
This cmdlet accepts a list of AccessControlRecord objects to associate to a volume.
OUTPUTS
TaskStatusInfo
This cmdlet returns a TaskStatusInfo object, if you specify the WaitForComplete parameter.
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, store, storsimple
Example 1: Update online value for a volume
PS C:\\>Set-AzureStorSimpleDeviceVolume -DeviceName "Contoso63-AppVm" -VolumeName "Volume18" -Online $False
VERBOSE: ClientRequestId: f2869570-ea47-4be7-801e-9c0f22f2600d_PS
VERBOSE: ClientRequestId: c70bb86a-51d3-4390-be17-4d0847641dc3_PS
VERBOSE: ClientRequestId: d20cb5b2-6b3c-4e06-af99-cada28c5e50a_PS
VERBOSE: ClientRequestId: ab6d533e-b55b-4cfb-9c58-9153295e0547_PS
de7000f1-29c7-4102-a375-b52432f9e67e
VERBOSE: The update task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
de7000f1-29c7-4102-a375-b52432f9e67e for tracking the task's status
This command updates the volume named Volume18 to have an online value of $False. This command starts the task, and then returns a TaskResponse object.
To see the status of the task, use the Get-AzureStorSimpleTask cmdlet.
Example 2: Modify online value and type
PS C:\\>Set-AzureStorSimpleDeviceVolume -DeviceName "Contoso63-AppVm" -VolumeName "Volume18" -Online $True -VolumeAppType ArchiveVolume
VERBOSE: ClientRequestId: af42b02a-645e-4801-a2d7-4197511c68cf_PS
VERBOSE: ClientRequestId: 7cb4f3b4-548e-42dc-a38c-0df0911c5206_PS
VERBOSE: ClientRequestId: 7cc706ad-a58f-4939-8e78-cabae8379a51_PS
VERBOSE: ClientRequestId: 6bed21d5-12fc-4a12-a89c-120bdb5636b1_PS
aa977225-af78-4c93-b754-72704afc928f
VERBOSE: The update task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
aa977225-af78-4c93-b754-72704afc928f for tracking the task's status
This command updates the volume named Volume18. It modifies the type and changes the value of the Online parameter to $True.
RELATED LINKS
Get-AzureStorSimpleDeviceVolumeContainer
New-AzureStorSimpleDeviceVolume
Remove-AzureStorSimpleDeviceVolume
Get-AzureStorSimpleAccessControlRecord
Get-AzureStorSimpleJob
SYNOPSIS
Updates the properties of an existing volume.
SYNTAX
Set-AzureStorSimpleDeviceVolume [-DeviceName] <System.String> [-VolumeName] <System.String> [[-Online] <Nullable [System.Boolean]>]
[[-VolumeSizeInBytes] <Nullable [System.Int64]>] [[-VolumeAppType] {PrimaryVolume | ArchiveVolume}] [[-AccessControlRecords] <0, Culture=neutral,
PublicKeyToken=31bf3856ad364e35]]>] [[-WaitForComplete]] [[-NewName] <System.String>] [-Profile
<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<CommonParameters>]
Set-AzureStorSimpleDeviceVolume [-DeviceName] <System.String> [-Volume] <Microsoft.WindowsAzure.Management.StorSimple.Models.VirtualDisk> [[-Online]
<Nullable [System.Boolean]>] [[-VolumeSizeInBytes] <Nullable [System.Int64]>] [[-VolumeAppType] {PrimaryVolume | ArchiveVolume}]
[[-AccessControlRecords] <0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]>] [[-WaitForComplete]] [[-NewName] <System.String>] [-Profile
<Microsoft.Azure.Common.Authentication.Models.AzureProfile>] [<CommonParameters>]
DESCRIPTION
The Set-AzureStorSimpleDeviceVolume cmdlet updates the properties of an existing volume. This cmdlet associates a volume with one or more access control
records. To obtain AccessControlRecord objects, use the Get-AzureStorSimpleAccessControlRecord cmdlet. Update the size or type for the volume. Also,
update whether to create the volume online.
PARAMETERS
-AccessControlRecords [<0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]]>]
Specifies a list of access control records to associate with the volume.
Required? false
Position? 6
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-DeviceName <System.String>
Specifies the name of the StorSimple device on which to update the volume exists.
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NewName [<System.String>]
Specifies a new name for the StorSimple device.
Required? false
Position? 8
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Online [<Nullable [System.Boolean]>]
Specifies whether the volume is online.
Required? false
Position? 3
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]
Specifies an Azure profile.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Volume <Microsoft.WindowsAzure.Management.StorSimple.Models.VirtualDisk>
Specifies the name of the volume to update.
Required? true
Position? 2
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-VolumeAppType [<Nullable [Microsoft.WindowsAzure.Management.StorSimple.Models.AppType]>]
Specifies whether to update the volume to be a primary or archive volume. Valid values are: PrimaryVolume and ArchiveVolume.
Required? false
Position? 5
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-VolumeName <System.String>
Specifies the name of the volume to update.
Required? true
Position? 2
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-VolumeSizeInBytes [<Nullable [System.Int64]>]
Specifies the updated size, in bytes, for the volume.
Required? false
Position? 4
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-WaitForComplete [<SwitchParameter>]
Indicates that this cmdlet waits for the operation to complete before it returns control to the Windows PowerShell????????? console.
Required? false
Position? 7
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
List<AccessControlRecord>
This cmdlet accepts a list of AccessControlRecord objects to associate to a volume.
OUTPUTS
TaskStatusInfo
This cmdlet returns a TaskStatusInfo object, if you specify the WaitForComplete parameter.
NOTES
Keywords: azure, azuresm, servicemanagement, management, service, store, storsimple
Example 1: Update online value for a volume
PS C:\\>Set-AzureStorSimpleDeviceVolume -DeviceName "Contoso63-AppVm" -VolumeName "Volume18" -Online $False
VERBOSE: ClientRequestId: f2869570-ea47-4be7-801e-9c0f22f2600d_PS
VERBOSE: ClientRequestId: c70bb86a-51d3-4390-be17-4d0847641dc3_PS
VERBOSE: ClientRequestId: d20cb5b2-6b3c-4e06-af99-cada28c5e50a_PS
VERBOSE: ClientRequestId: ab6d533e-b55b-4cfb-9c58-9153295e0547_PS
de7000f1-29c7-4102-a375-b52432f9e67e
VERBOSE: The update task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
de7000f1-29c7-4102-a375-b52432f9e67e for tracking the task's status
This command updates the volume named Volume18 to have an online value of $False. This command starts the task, and then returns a TaskResponse object.
To see the status of the task, use the Get-AzureStorSimpleTask cmdlet.
Example 2: Modify online value and type
PS C:\\>Set-AzureStorSimpleDeviceVolume -DeviceName "Contoso63-AppVm" -VolumeName "Volume18" -Online $True -VolumeAppType ArchiveVolume
VERBOSE: ClientRequestId: af42b02a-645e-4801-a2d7-4197511c68cf_PS
VERBOSE: ClientRequestId: 7cb4f3b4-548e-42dc-a38c-0df0911c5206_PS
VERBOSE: ClientRequestId: 7cc706ad-a58f-4939-8e78-cabae8379a51_PS
VERBOSE: ClientRequestId: 6bed21d5-12fc-4a12-a89c-120bdb5636b1_PS
aa977225-af78-4c93-b754-72704afc928f
VERBOSE: The update task is submitted successfully. Please use the command Get-AzureStorSimpleTask -InstanceId
aa977225-af78-4c93-b754-72704afc928f for tracking the task's status
This command updates the volume named Volume18. It modifies the type and changes the value of the Online parameter to $True.
RELATED LINKS
Get-AzureStorSimpleDeviceVolumeContainer
New-AzureStorSimpleDeviceVolume
Remove-AzureStorSimpleDeviceVolume
Get-AzureStorSimpleAccessControlRecord
Get-AzureStorSimpleJob