Skip to content

Latest commit

 

History

History
194 lines (152 loc) · 5.1 KB

Get-AzNetAppFilesVolume.md

File metadata and controls

194 lines (152 loc) · 5.1 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.NetAppFiles.dll-Help.xml
Az.NetAppFiles
2.0.0

Get-AzNetAppFilesVolume

SYNOPSIS

Gets details of an Azure NetApp Files (ANF) volume.

SYNTAX

ByFieldsParameterSet (Default)

Get-AzNetAppFilesVolume -ResourceGroupName <String> -AccountName <String> -PoolName <String> [-Name <String>]
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ByParentObjectParameterSet

Get-AzNetAppFilesVolume [-Name <String>] -PoolObject <PSNetAppFilesPool>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

ByResourceIdParameterSet

Get-AzNetAppFilesVolume -ResourceId <String> [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

DESCRIPTION

The Get-AzNetAppFilesVolume cmdlet gets details of an ANF volume.

EXAMPLES

Example 1: Get an ANF volume

Get-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume"
ResourceGroupName : MyRG
Location          : westus2
Id                : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume
Name              : MyAnfAccount/MyAnfPool/MyAnfVolume
Type              : Microsoft.NetApp/netAppAccounts/capacityPools/volumes
Tags              :
FileSystemId      : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf
CreationToken     :
ServiceLevel      : Premium
UsageThreshold    : 1099511627776
ProvisioningState : Succeeded
SubnetId          : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyRG-vnet/subnets/default

This command gets the volume named MyAnfVolume from the pool "MyAnfPool".

PARAMETERS

-AccountName

The name of the ANF account

Type: System.String
Parameter Sets: ByFieldsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultProfile

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

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the ANF volume

Type: System.String
Parameter Sets: ByFieldsParameterSet, ByParentObjectParameterSet
Aliases: VolumeName

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PoolName

The name of the ANF pool

Type: System.String
Parameter Sets: ByFieldsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PoolObject

The pool object containing the volume to return

Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool
Parameter Sets: ByParentObjectParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-ResourceGroupName

The resource group of the ANF volume

Type: System.String
Parameter Sets: ByFieldsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

The resource id of the ANF volume

Type: System.String
Parameter Sets: ByResourceIdParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
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.

INPUTS

System.String

Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesPool

OUTPUTS

Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume

NOTES

RELATED LINKS

New-AzNetAppFilesVolume Update-AzNetAppFilesVolume Remove-AzNetAppFilesVolume Restore-AzNetAppFilesVolume Set-AzNetAppFilesVolumePool Get-AzNetAppFilesVolumeBackupStatus Get-AzNetAppFilesVolumeRestoreStatus Approve-AzNetAppFilesReplication Initialize-AzNetAppFilesReplication Resume-AzNetAppFilesReplication Remove-AzNetAppFilesReplication