Edit

Share via


Test-AzDataLakeAnalyticsCatalogItem

Checks for the existence of a catalog item.

Syntax

Default (Default)

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

Description

The Test-AzDataLakeAnalyticsCatalogItem cmdlet checks for the existence of an Azure Data Lake Analytics catalog item.

Examples

Example 1: Test whether a catalog item exists

Test-AzDataLakeAnalyticsCatalogItem -Account "ContosoAdlAccount" -ItemType Schema -Path "databaseName.schemaName"

This command tests whether a specified Schema item exists.

Parameters

-Account

Specifies the Data Lake Analytics account name.

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

-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

-ItemType

Specifies the catalog item type of the item to check. The acceptable values for this parameter are:

  • Database
  • Schema
  • Assembly
  • Table
  • TablePartition
  • TableValuedFunction
  • TableStatistics
  • ExternalDataSource
  • View
  • Procedure
  • Secret
  • Credential
  • Types

Parameter properties

Type:Microsoft.Azure.Commands.DataLakeAnalytics.Models.DataLakeAnalyticsEnums+CatalogItemType
Default value:None
Accepted values:Database, Schema, Assembly, Table, TablePartition, TableValuedFunction, TableStatistics, ExternalDataSource, View, Procedure, Secret, Credential, Types, Package
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

-Path

Specifies the path to the item to fetch, or the path to the parent item of the items to list.

Parameter properties

Type:CatalogPathInstance
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

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

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

CatalogPathInstance

Outputs

Boolean