Edit

Share via

Test-AzureRmDataLakeAnalyticsCatalogItem

  • Reference
Module:
AzureRM.DataLakeAnalytics

Checks for the existence of a catalog item.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

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

Description

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

Examples

Example 1: Test whether a catalog item exists

PS C:\>Test-AzureRmDataLakeAnalyticsCatalogItem -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.

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: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 to check. The acceptable values for this parameter are:

  • Database
  • Schema
  • Assembly
  • Table
  • TablePartition
  • TableValuedFunction
  • TableStatistics
  • ExternalDataSource
  • View
  • Procedure
  • Secret
  • Credential
  • Types
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 path to the item to fetch, or the path to the parent item of the items to list.

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

Inputs

String

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

CatalogPathInstance

Outputs

Boolean