Edit

Get-AzStorageShare

  • Reference
Module:
Az.Storage

Gets a list of file shares.

Syntax

Get-AzStorageShare
   [[-Prefix] <String>]
   [-IncludeDeleted]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [<CommonParameters>]
Get-AzStorageShare
   [-Name] <String>
   [[-SnapshotTime] <DateTimeOffset>]
   [-SkipGetProperty]
   [-Context <IStorageContext>]
   [-ServerTimeoutPerRequest <Int32>]
   [-ClientTimeoutPerRequest <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [-ConcurrentTaskCount <Int32>]
   [<CommonParameters>]

Description

The Get-AzStorageShare cmdlet gets a list of file shares for a storage account.

Examples

Example 1: Get a file share

Get-AzStorageShare -Name "ContosoShare06"

This command gets the file share named ContosoShare06.

Example 2: Get all file shares that begin with a string

Get-AzStorageShare -Prefix "Contoso"

This command gets all file shares that have names that begin with Contoso.

Example 3: Get all file shares in a specified context

$Context = New-AzStorageContext -Local
Get-AzStorageShare -Context $Context

The first command uses the New-AzStorageContext cmdlet to create a context by using the Local parameter, and then stores that context object in the $Context variable. The second command gets the file shares for the context object stored in $Context.

Example 4: Get a file share snapshot with specific share name and SnapshotTime

Get-AzStorageShare -Name "ContosoShare06" -SnapshotTime "6/16/2017 9:48:41 AM +00:00"

This command gets a file share snapshot with specific share name and SnapshotTime.

Example 5: Get a file share object without fetch share properties with OAuth authentication.

New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount -EnableFileBackupRequestIntent
$share = Get-AzStorageShare -Name "ContosoShare06" -SkipGetProperty -Context $ctx

This command gets a file share snapshot without get share properties with OAuth authentication. Get share properties with OAuth authentication will fail since the API not support OAuth. So to get share object with OAuth authentication must skip fetch share properties.

Parameters

-ClientTimeoutPerRequest

Specifies the client-side time-out interval, in seconds, for one service request. If the previous call fails in the specified interval, this cmdlet retries the request. If this cmdlet does not receive a successful response before the interval elapses, this cmdlet returns an error.

Type:Nullable<T>[Int32]
Aliases:ClientTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConcurrentTaskCount

Specifies the maximum concurrent network calls. You can use this parameter to limit the concurrency to throttle local CPU and bandwidth usage by specifying the maximum number of concurrent network calls. The specified value is an absolute count and is not multiplied by the core count. This parameter can help reduce network connection problems in low bandwidth environments, such as 100 kilobits per second. The default value is 10.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Specifies an Azure Storage context. To obtain a context, use the New-AzStorageContext cmdlet.

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeDeleted

Include deleted shares, by default get share won't include deleted shares

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

-Name

Specifies the name of the file share. This cmdlet gets the file share that this parameter specifies, or nothing if you specify the name of a file share that does not exist.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Prefix

Specifies the prefix for file shares. This cmdlet gets file shares that match the prefix that this parameter specifies, or no file shares if no file shares match the specified prefix.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ServerTimeoutPerRequest

Specifies the length of the time-out period for the server part of a request.

Type:Nullable<T>[Int32]
Aliases:ServerTimeoutPerRequestInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipGetProperty

Specify this parameter to only generate a local share object, without get share properties from server.

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

-SnapshotTime

SnapshotTime of the file share snapshot to be received.

Type:Nullable<T>[DateTimeOffset]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IStorageContext

Outputs

AzureStorageFileShare