Get-​Azure​Rm​Data​Lake​Store​Item​Content

Gets the contents of a file in Data Lake Store.

Syntax

Get-AzureRmDataLakeStoreItemContent
   [-Account] <String>
   [-Path] <DataLakeStorePathInstance>
   [[-Offset] <Int64>]
   [[-Length] <Int64>]
   [[-Encoding] <FileSystemCmdletProviderEncoding>]
   [-Force]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Get-AzureRmDataLakeStoreItemContent
   [-Account] <String>
   [-Path] <DataLakeStorePathInstance>
   [[-Head] <Int32>]
   [[-Encoding] <FileSystemCmdletProviderEncoding>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]
Get-AzureRmDataLakeStoreItemContent
   [-Account] <String>
   [-Path] <DataLakeStorePathInstance>
   [[-Tail] <Int32>]
   [[-Encoding] <FileSystemCmdletProviderEncoding>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Get-AzureRmDataLakeStoreItemContent cmdlet gets the contents of a file in Data Lake Store.

Examples

Example 1: Get the contents of a file

PS C:\>Get-AzureRmDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt"

This command gets the contents of the file MyFile.txt in the ContosoADL account.

Example 2: Get the first two rows of a file

PS C:\>Get-AzureRmDataLakeStoreItemContent -AccountName "ContosoADL" -Path "/MyFile.txt" -Head 2

This command gets the first two new line separated rows in the file MyFile.txt in the ContosoADL account.

Required Parameters

-Account

Specifies the name of the Data Lake Store account.

Type:String
Aliases:AccountName
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Path

Specifies the Data Lake Store path of a file, starting with the root directory (/).

Type:DataLakeStorePathInstance
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Encoding

Specifies the encoding for the item to create. The acceptable values for this parameter are:

  • Unknown
  • String
  • Unicode
  • Byte
  • BigEndianUnicode
  • UTF8
  • UTF7
  • Ascii
  • Default
  • Oem
  • BigEndianUTF32
Type:FileSystemCmdletProviderEncoding
Parameter Sets:Unknown, String, Unicode, Byte, BigEndianUnicode, UTF8, UTF7, UTF32, Ascii, Default, Oem, BigEndianUTF32
Position:4
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:5
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Head

The number of rows (new line delimited) from the beginning of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned.

Type:Int32
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Length

Specifies the length, in bytes, of the content to get.

Type:Int64
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Offset

Specifies the number of bytes to skip in a file before getting content.

Type:Int64
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Tail

The number of rows (new line delimited) from the end of the file to preview. If no new line is encountered in the first 4mb of data, only that data will be returned.

Type:Int32
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

byte[]

The byte stream representation of the file contents retrieved.

Outputs

string

The string representation (in the specified encoding) of the file contents retrieved.