Share via


Get-AzsVolume

Return the requested a storage volume.

Syntax

Get-AzsVolume
   -ScaleUnit <String>
   -StorageSubSystem <String>
   [-Location <String>]
   [-ResourceGroupName <String>]
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-Skip <String>]
   [-Top <String>]
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]
Get-AzsVolume
   -Name <String>
   -ScaleUnit <String>
   -StorageSubSystem <String>
   [-Location <String>]
   [-ResourceGroupName <String>]
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]
Get-AzsVolume
   -INPUTOBJECT \<IFabricAdminIdentity>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]

Description

Return the requested a storage volume.

Examples

Example 1:

PS C:\> $scaleUnit = Get-AzsScaleUnit | select -First 1
PS C:\> $storageSubSystem = Get-AzsStorageSubSystem -ScaleUnit $scaleUnit.Name
PS C:\> Get-AzsVolume -ScaleUnit $scaleUnit.Name -StorageSubSystem $storageSubSystem.Name

Get a list of all storage volumes at a given location.

Example 2:

PS C:\> $scaleUnit = Get-AzsScaleUnit | select -First 1
PS C:\> $storageSubSystem = Get-AzsStorageSubSystem -ScaleUnit $scaleUnit.Name
PS C:\> Get-AzsVolume -ScaleUnit $scaleUnit.Name -StorageSubSystem $storageSubSystem.Name -Name ee594cf5-cf54-46b4-a641-139553307195

Get a storage volume by name at a given location.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:System.Management.Automation.PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

OData filter parameter.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Location

Location of the resource.

Type:System.String
Position:Named
Default value:(Get-AzLocation)[0].Location
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Name of the storage volume.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Name of the resource group.

Type:System.String
Position:Named
Default value:-join("System.",(Get-AzLocation)[0].Location)
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScaleUnit

Name of the scale units.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Skip

OData skip parameter.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StorageSubSystem

Name of the storage system.

Type:System.String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:System.String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

OData top parameter.

Type:System.String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.IFabricAdminIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.FabricAdmin.Models.Api20190501.IVolume

Notes

COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IFabricAdminIdentity>: Identity Parameter

  • [Drive <String>]: Name of the storage drive.
  • [EdgeGateway <String>]: Name of the edge gateway.
  • [EdgeGatewayPool <String>]: Name of the edge gateway pool.
  • [FabricLocation <String>]: Fabric location.
  • [FileShare <String>]: Fabric file share name.
  • [IPPool <String>]: IP pool name.
  • [Id <String>]: Resource identity path
  • [InfraRole <String>]: Infrastructure role name.
  • [InfraRoleInstance <String>]: Name of an infrastructure role instance.
  • [Location <String>]: Location of the resource.
  • [LogicalNetwork <String>]: Name of the logical network.
  • [LogicalSubnet <String>]: Name of the logical subnet.
  • [MacAddressPool <String>]: Name of the MAC address pool.
  • [Operation <String>]: Operation identifier.
  • [ResourceGroupName <String>]: Name of the resource group.
  • [ScaleUnit <String>]: Name of the scale units.
  • [ScaleUnitNode <String>]: Name of the scale unit node.
  • [SlbMuxInstance <String>]: Name of a SLB MUX instance.
  • [StorageSubSystem <String>]: Name of the storage system.
  • [SubscriptionId <String>]: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • [Volume <String>]: Name of the storage volume.