Get-​Azure​Storage​Share

Gets a list of file shares.

Syntax

Get-AzureStorageShare
   [-Name] <String>
   [-ClientTimeoutPerRequest <Int32>]
   [-ConcurrentTaskCount <Int32>]
   [-Context <AzureStorageContext>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-PipelineVariable <String>]
   [-ServerTimeoutPerRequest <Int32>]
   [<CommonParameters>]
Get-AzureStorageShare
   [[-Prefix] <String>]
   [-ClientTimeoutPerRequest <Int32>]
   [-ConcurrentTaskCount <Int32>]
   [-Context <AzureStorageContext>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-PipelineVariable <String>]
   [-ServerTimeoutPerRequest <Int32>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get a file share

PS C:\>Get-AzureStorageShare -Name "ContosoShare06"

This command gets the file share named ContosoShare06.

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

PS C:\>Get-AzureStorageShare -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

PS C:\>$Context = New-AzureStorageContext -Local
PS C:\> Get-AzureStorageShare -Context $Context

The first command uses the New-AzureStorageContext 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.

Required Parameters

-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
Accept pipeline input:False
Accept wildcard characters:False

Optional 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:Int32
Position:Named
Default value:None
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:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Context

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

Type:AzureStorageContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PipelineVariable

Stores the value of the current pipeline element as a variable, for any named command as it flows through the pipeline.

Type:String
Aliases:pv
Position:Named
Default value:None
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
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:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False