Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureStorageFileContent

Get-AzureStorageFileContent

microsoft.windowsazure.commands.storage.dll

Synopsis

Download the specified azure storage file.

Syntax

Get-AzureStorageFileContent [-ShareName] [-Path] [-Destination] [-PassThru] [-Force] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-AzureStorageFileContent [-Share] [-Path] [-Destination] [-PassThru] [-Force] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-AzureStorageFileContent [-Directory] [-Path] [-Destination] [-PassThru] [-Force] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-AzureStorageFileContent [-File] [-Destination] [-PassThru] [-Force] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-AzureStorageFileContent [-PassThru] [-Force] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-AzureStorageFileContent [-PassThru] [-Force] [-Context] [-ServerTimeoutPerRequest] [-ClientTimeoutPerRequest] [-ConcurrentTaskCount] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

Download the specified azure storage file.

Parameters

-ShareName <String>

The file share name

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Path <String>

the path of the azure storage file to download

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Destination <String>

The destination to put the downloaded file

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

If this parameter is set, it will overwrite the local file when there is name conflict.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Context <AzureStorageContext>

Azure Storage Context. You can create it by New-AzureStorageContext cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-ServerTimeoutPerRequest <Nullable`1[Int32]>

Server side timeout value for the request.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ClientTimeoutPerRequest <Nullable`1[Int32]>

Client side timeout value for the request.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ConcurrentTaskCount <Nullable`1[Int32]>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Share <CloudFileShare>

The file share object

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Directory <CloudFileDirectory>

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-File <CloudFile>

The file object

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-ClientRequestId <string>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PipelineVariable <string>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

This example downloads the file whose path is sampledir/samplefile in the sample file share.

PS C:\> Get-AzureStorageFileContent -FileShareName sample -FilePath sampledir/samplefile

-------------------------- Example 2 --------------------------

This example downloads the files under sample file share

PS C:\> Get-AzureStorageFile -ShareName sample | ? IsFile | Get-AzureStorageFileContent

Get-AzureStorageFile
Set-AzureStorageFileContent