< Back
Get-AzureRmDataLakeAnalyticsCatalogItem
Post
NAME Get-AzureRmDataLakeAnalyticsCatalogItem
SYNOPSIS
Gets a Data Lake Analytics catalog item or types of items.
SYNTAX
Get-AzureRmDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] {Database | Schema | Assembly | Table | TablePartition |
TableValuedFunction | TableStatistics | ExternalDataSource | View | Procedure | Secret | Credential | Types | Package} [[-Path]
<CatalogPathInstance>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataLakeAnalyticsCatalogItem gets a specified Azure Data Lake Analytics catalog item, or gets catalog items of a specified type.
PARAMETERS
-Account <String>
Specifies the Data Lake Analytics account name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ItemType <CatalogItemType>
Specifies the catalog item type of the item(s) being fetched or listed. The acceptable values for this parameter are:
- Database
- Schema
- Assembly
- Table
- TableValuedFunction
- TableStatistics
- ExternalDataSource
- View
- Procedure
- Secret
- Credential
- Types
- TablePartition
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <CatalogPathInstance>
Specifies the multi-part path to the item to retrieve, or to the parent item of the items to list. The parts of the path should be separated
by a period (.).
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
CatalogItem
The specified catalog item.
List<CatalogItem>
The list of the specified catalog items underneath their corresponding container.
NOTES
Example 1: Get a specified database
PS C:\\>Get-AzureRmDataLakeAnalyticsCatalogItem -Account "contosoadla" -ItemType Database -Path "databaseName"
This command gets the specified database.
Example 2: Get tables in a specified database and schema
PS C:\\>Get-AzureRmDataLakeAnalyticsDataSource -AccountName "contosoadla" -ItemType Table -Path "databaseName.schemaName"
This command gets a list of tables in the specified database.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... atalogitem
Test-AzureRmDataLakeAnalyticsCatalogItem
SYNOPSIS
Gets a Data Lake Analytics catalog item or types of items.
SYNTAX
Get-AzureRmDataLakeAnalyticsCatalogItem [-Account] <String> [-ItemType] {Database | Schema | Assembly | Table | TablePartition |
TableValuedFunction | TableStatistics | ExternalDataSource | View | Procedure | Secret | Credential | Types | Package} [[-Path]
<CatalogPathInstance>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmDataLakeAnalyticsCatalogItem gets a specified Azure Data Lake Analytics catalog item, or gets catalog items of a specified type.
PARAMETERS
-Account <String>
Specifies the Data Lake Analytics account name.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ItemType <CatalogItemType>
Specifies the catalog item type of the item(s) being fetched or listed. The acceptable values for this parameter are:
- Database
- Schema
- Assembly
- Table
- TableValuedFunction
- TableStatistics
- ExternalDataSource
- View
- Procedure
- Secret
- Credential
- Types
- TablePartition
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <CatalogPathInstance>
Specifies the multi-part path to the item to retrieve, or to the parent item of the items to list. The parts of the path should be separated
by a period (.).
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
CatalogItem
The specified catalog item.
List<CatalogItem>
The list of the specified catalog items underneath their corresponding container.
NOTES
Example 1: Get a specified database
PS C:\\>Get-AzureRmDataLakeAnalyticsCatalogItem -Account "contosoadla" -ItemType Database -Path "databaseName"
This command gets the specified database.
Example 2: Get tables in a specified database and schema
PS C:\\>Get-AzureRmDataLakeAnalyticsDataSource -AccountName "contosoadla" -ItemType Table -Path "databaseName.schemaName"
This command gets a list of tables in the specified database.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... atalogitem
Test-AzureRmDataLakeAnalyticsCatalogItem