Export-AzDataLakeStoreChildItemProperty

Module:

Az.DataLakeStore Module

Exports the properties (Disk usage and Acl) for the entire tree from the specified path to a output path

Syntax

GetDiskUsage

Export-AzDataLakeStoreChildItemProperty
    [-Account] <String>
    [-Path] <DataLakeStorePathInstance>
    [-OutputPath] <String>
    [-SaveToAdl]
    [-IncludeFile]
    [-MaximumDepth <Int32>]
    [-Concurrency <Int32>]
    [-GetDiskUsage]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetAllProperties

Export-AzDataLakeStoreChildItemProperty
    [-Account] <String>
    [-Path] <DataLakeStorePathInstance>
    [-OutputPath] <String>
    [-SaveToAdl]
    [-IncludeFile]
    [-MaximumDepth <Int32>]
    [-Concurrency <Int32>]
    [-GetDiskUsage]
    [-GetAcl]
    [-HideConsistentAcl]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

GetAclDump

Export-AzDataLakeStoreChildItemProperty
    [-Account] <String>
    [-Path] <DataLakeStorePathInstance>
    [-OutputPath] <String>
    [-SaveToAdl]
    [-IncludeFile]
    [-MaximumDepth <Int32>]
    [-Concurrency <Int32>]
    [-GetAcl]
    [-HideConsistentAcl]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Export-AzDataLakeStoreChildItemProperty is used to report the ADLS space usage or/and ACL usage for the given directory and it's sub directories and files.

Examples

Example 1: Get the disk usage and ACL usage for all subdirectories and files

Export-AzDataLakeStoreChildItemProperty -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -GetDiskUsage -IncludeFile

Get the disk usage and ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also

Example 2: Get the ACL usage for all subdirectories and files with the consistent ACL hidden

$fullAcl="user:contoso-userid:--x|user::rwx|other::---|group::rwx"
$newFullAcl = $fullAcl.Split("{|}");
Set-AzDataLakeStoreItemAcl -Account ContosoADL -Path /a -Acl $newFullAcl -Recurse -Debug

Export-AzDataLakeStoreChildItemProperty -Account ContosoADL -Path /a -OutputPath "C:\Users\contoso\Desktop\DumpFile.txt" -GetAcl -HideConsistentAcl -IncludeFile

Get the ACL usage for all subdirectories and files under /a. IncludeFile ensures the usage is reported for files also. HideconsistentAcl in this case will show the Acl of /a, not it's children since all of the children has same acl as /a. This flag skips the acl output of subtree if all it's acls are same as the root.

Parameters

-Account

The Data Lake Store account to execute the filesystem operation in

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AccountName

Parameter sets

(All)

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Concurrency

Indicates the number of files/directories processed in parallel. Default will be computed as a best effort based on system specification.

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-GetAcl

Retrieves the acl starting from the root path

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetAllProperties

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetAclDump

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-GetDiskUsage

Retrieves the disk usage starting from the root path

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetDiskUsage

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetAllProperties

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-HideConsistentAcl

Do not show directory subtree if the ACLs are the same throughout the entire subtree. This makes it easier to see only the paths up to which the ACLs differ.For example if all files and folders under /a/b are the same, do not show the subtreeunder /a/b, and just output /a/b with 'True' in the Consistent ACL columnCannot be set if IncludeFiles is not set, because consistent Acl cannot be determined without retrieving acls for the files.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetAllProperties

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetAclDump

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-IncludeFile

Show stats at file level (default is to show directory-level info only)

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-MaximumDepth

Maximum depth from the root directory till which disk usage or acl is displayed

Parameter properties

Type:	Int32
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-OutputPath

Path to output file. Can be a Local path or Adl Path. By default it is local. If SaveToAdl is specified then it is an ADL path in the same account

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	2
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-PassThru

Indicates a boolean response should be returned indicating the result of the delete operation.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Path

The path in the specified Data Lake account that should be retrieve. Can be a file or folder In the format '/folder/file.txt', where the first '/' after the DNS indicates the root of the file system.

Parameter properties

Type:	DataLakeStorePathInstance
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-SaveToAdl

If passed then saves the dump file to ADL. The DumpFile wil be a ADL path in that case

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-WhatIf

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

DataLakeStorePathInstance

SwitchParameter

Int32

Outputs

Boolean