Microsoft Azure

Azure Datalake Analytics: Catalog

Creates an Azure Data Lake Analytics catalog client.

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Creates an Azure Data Lake Analytics catalog client.

Endpoints 45

Catalog

  • GETCatalog_GetSecret/catalog/usql/databases/:databaseName/secrets/:secretName?api-version=stringDeprecated. Gets the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use GetCredential instead.
  • PUTCatalog_CreateSecret/catalog/usql/databases/:databaseName/secrets/:secretName?api-version=stringDeprecated. Creates the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next…
  • DELETECatalog_DeleteSecret/catalog/usql/databases/:databaseName/secrets/:secretName?api-version=stringDeprecated. Deletes the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use DeleteCredential…
  • PATCHCatalog_UpdateSecret/catalog/usql/databases/:databaseName/secrets/:secretName?api-version=stringDeprecated. Modifies the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next…
  • DELETECatalog_DeleteAllSecrets/catalog/usql/databases/:databaseName/secrets?api-version=stringDeprecated. Deletes all secrets in the specified database. This is deprecated and will be removed in the next release. In the future, please only drop…
  • GETCatalog_GetCredential/catalog/usql/databases/:databaseName/credentials/:credentialName?api-version=stringRetrieves the specified credential from the Data Lake Analytics catalog.
  • PUTCatalog_CreateCredential/catalog/usql/databases/:databaseName/credentials/:credentialName?api-version=stringCreates the specified credential for use with external data sources in the specified database.
  • POSTCatalog_DeleteCredential/catalog/usql/databases/:databaseName/credentials/:credentialName?cascade=false&api-version=stringDeletes the specified credential in the specified database
  • PATCHCatalog_UpdateCredential/catalog/usql/databases/:databaseName/credentials/:credentialName?api-version=stringModifies the specified credential for use with external data sources in the specified database
  • GETCatalog_ListCredentials/catalog/usql/databases/:databaseName/credentials?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of credentials from the Data Lake Analytics catalog.
  • GETCatalog_GetExternalDataSource/catalog/usql/databases/:databaseName/externaldatasources/:externalDataSourceName?api-version=stringRetrieves the specified external data source from the Data Lake Analytics catalog.
  • GETCatalog_ListExternalDataSources/catalog/usql/databases/:databaseName/externaldatasources?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of external data sources from the Data Lake Analytics catalog.
  • GETCatalog_GetProcedure/catalog/usql/databases/:databaseName/schemas/:schemaName/procedures/:procedureName?api-version=stringRetrieves the specified procedure from the Data Lake Analytics catalog.
  • GETCatalog_ListProcedures/catalog/usql/databases/:databaseName/schemas/:schemaName/procedures?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of procedures from the Data Lake Analytics catalog.
  • GETCatalog_GetTable/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName?api-version=stringRetrieves the specified table from the Data Lake Analytics catalog.
  • GETCatalog_ListTableFragments/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/tablefragments?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of table fragments from the Data Lake Analytics catalog.
  • GETCatalog_ListTables/catalog/usql/databases/:databaseName/schemas/:schemaName/tables?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&basic=false&api-version=stringRetrieves the list of tables from the Data Lake Analytics catalog.
  • GETCatalog_ListTableStatisticsByDatabaseAndSchema/catalog/usql/databases/:databaseName/schemas/:schemaName/statistics?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.
  • GETCatalog_GetTableType/catalog/usql/databases/:databaseName/schemas/:schemaName/tabletypes/:tableTypeName?api-version=stringRetrieves the specified table type from the Data Lake Analytics catalog.
  • GETCatalog_ListTableTypes/catalog/usql/databases/:databaseName/schemas/:schemaName/tabletypes?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of table types from the Data Lake Analytics catalog.
  • GETCatalog_GetPackage/catalog/usql/databases/:databaseName/schemas/:schemaName/packages/:packageName?api-version=stringRetrieves the specified package from the Data Lake Analytics catalog.
  • GETCatalog_ListPackages/catalog/usql/databases/:databaseName/schemas/:schemaName/packages?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of packages from the Data Lake Analytics catalog.
  • GETCatalog_GetView/catalog/usql/databases/:databaseName/schemas/:schemaName/views/:viewName?api-version=stringRetrieves the specified view from the Data Lake Analytics catalog.
  • GETCatalog_ListViews/catalog/usql/databases/:databaseName/schemas/:schemaName/views?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of views from the Data Lake Analytics catalog.
  • GETCatalog_GetTableStatistic/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/statistics/:statisticsName?api-version=stringRetrieves the specified table statistics from the Data Lake Analytics catalog.
  • GETCatalog_ListTableStatistics/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/statistics?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of table statistics from the Data Lake Analytics catalog.
  • GETCatalog_PreviewTablePartition/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/partitions/:partitionName/previewrows?maxRows=0&maxColumns=0&api-version=stringRetrieves a preview set of rows in given partition.
  • GETCatalog_GetTablePartition/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/partitions/:partitionName?api-version=stringRetrieves the specified table partition from the Data Lake Analytics catalog.
  • GETCatalog_PreviewTable/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/previewrows?maxRows=0&maxColumns=0&api-version=stringRetrieves a preview set of rows in given table.
  • GETCatalog_ListTablePartitions/catalog/usql/databases/:databaseName/schemas/:schemaName/tables/:tableName/partitions?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of table partitions from the Data Lake Analytics catalog.
  • GETCatalog_ListTypes/catalog/usql/databases/:databaseName/schemas/:schemaName/types?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.
  • GETCatalog_GetTableValuedFunction/catalog/usql/databases/:databaseName/schemas/:schemaName/tablevaluedfunctions/:tableValuedFunctionName?api-version=stringRetrieves the specified table valued function from the Data Lake Analytics catalog.
  • GETCatalog_ListTableValuedFunctions/catalog/usql/databases/:databaseName/schemas/:schemaName/tablevaluedfunctions?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of table valued functions from the Data Lake Analytics catalog.
  • GETCatalog_GetAssembly/catalog/usql/databases/:databaseName/assemblies/:assemblyName?api-version=stringRetrieves the specified assembly from the Data Lake Analytics catalog.
  • GETCatalog_ListAssemblies/catalog/usql/databases/:databaseName/assemblies?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of assemblies from the Data Lake Analytics catalog.
  • GETCatalog_GetSchema/catalog/usql/databases/:databaseName/schemas/:schemaName?api-version=stringRetrieves the specified schema from the Data Lake Analytics catalog.
  • GETCatalog_ListSchemas/catalog/usql/databases/:databaseName/schemas?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of schemas from the Data Lake Analytics catalog.
  • GETCatalog_ListTableStatisticsByDatabase/catalog/usql/databases/:databaseName/statistics?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of all statistics in a database from the Data Lake Analytics catalog.
  • GETCatalog_ListTablesByDatabase/catalog/usql/databases/:databaseName/tables?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&basic=false&api-version=stringRetrieves the list of all tables in a database from the Data Lake Analytics catalog.
  • GETCatalog_ListTableValuedFunctionsByDatabase/catalog/usql/databases/:databaseName/tablevaluedfunctions?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of all table valued functions in a database from the Data Lake Analytics catalog.
  • GETCatalog_ListViewsByDatabase/catalog/usql/databases/:databaseName/views?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of all views in a database from the Data Lake Analytics catalog.
  • GETCatalog_ListAclsByDatabase/catalog/usql/databases/:databaseName/acl?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog.
  • GETCatalog_ListAcls/catalog/usql/acl?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog.
  • GETCatalog_GetDatabase/catalog/usql/databases/:databaseName?api-version=stringRetrieves the specified database from the Data Lake Analytics catalog.
  • GETCatalog_ListDatabases/catalog/usql/databases?$filter=string&$top=1&$skip=1&$select=string&$orderby=string&$count=true&api-version=stringRetrieves the list of databases from the Data Lake Analytics catalog.

API details

Authentication
None declared in the description
Operations
45 operations on 39 pathsGET 38PUT 2PATCH 2DELETE 2POST 1
5 marked deprecated
Main resources
Catalog 45
Response formats
application/json
Description format
Swagger 2.0, API version 2016-11-01

How to test the Azure Datalake Analytics: Catalog in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Datalake Analytics: Catalog collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Catalog_GetSecret” (GET /catalog/usql/databases/:databaseName/secrets/:secretName?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Datalake Analytics: Catalog?

Creates an Azure Data Lake Analytics catalog client. It is listed under Data & analytics and has 45 endpoints.

Who publishes the Azure Datalake Analytics: Catalog?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Datalake Analytics: Catalog?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Datalake Analytics: Catalog have?

45 operations on 39 paths (38 GET, 2 PUT, 2 PATCH, 2 DELETE, 1 POST). The largest groups are Catalog.

Is forking the Azure Datalake Analytics: Catalog free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.