Edit

Share via

Get-AzDataLakeAnalyticsCatalogItem

  • Reference
Module:
Az.DataLakeAnalytics

Gets a Data Lake Analytics catalog item or types of items.

Syntax

Get-AzDataLakeAnalyticsCatalogItem
   [-Account] <String>
   [-ItemType] <CatalogItemType>
   [[-Path] <CatalogPathInstance>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzDataLakeAnalyticsCatalogItem gets a specified Azure Data Lake Analytics catalog item, or gets catalog items of a specified type.

Examples

Example 1: Get a specified database

Get-AzDataLakeAnalyticsCatalogItem -Account "contosoadla" -ItemType Database -Path "databaseName"

This command gets the specified database.

Example 2: Get tables in a specified database and schema

Get-AzDataLakeAnalyticsCatalogItem -AccountName "contosoadla" -ItemType Table -Path "databaseName.schemaName"

This command gets a list of tables in the specified database.

Parameters

-Account

Specifies the Data Lake Analytics account name.

Type:String
Aliases:AccountName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ItemType

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
Type:Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType
Accepted values:Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

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 (.).

Type:CatalogPathInstance
Position:2
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType

CatalogPathInstance

Outputs

CatalogItem