APIHub
Back to Explore

DataLakeAnalyticsCatalogManagementClient

Creates an Azure Data Lake Analytics catalog client.

Cloud
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

3001ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/catalog/usql/databases/{databaseName}

Retrieves the specified database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/acl

Retrieves the list of access control list (ACL) entries for the Data Lake Analytics catalog.

  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases

Retrieves the list of databases from the Data Lake Analytics catalog.

  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/acl

Retrieves the list of access control list (ACL) entries for the database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/assemblies

Retrieves the list of assemblies from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the assembly.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/assemblies/{assemblyName}

Retrieves the specified assembly from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the assembly.
  • assemblyName (path, required) — The name of the assembly.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/credentials

Retrieves the list of credentials from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the schema.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/credentials/{credentialName}

Retrieves the specified credential from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the schema.
  • credentialName (path, required) — The name of the credential.
  • api-version (query, required) — Client Api Version.
PATCH

/catalog/usql/databases/{databaseName}/credentials/{credentialName}

Modifies the specified credential for use with external data sources in the specified database

  • databaseName (path, required) — The name of the database containing the credential.
  • credentialName (path, required) — The name of the credential.
  • api-version (query, required) — Client Api Version.
POST

/catalog/usql/databases/{databaseName}/credentials/{credentialName}

Deletes the specified credential in the specified database

  • databaseName (path, required) — The name of the database containing the credential.
  • credentialName (path, required) — The name of the credential to delete
  • cascade (query) — Indicates if the delete should be a cascading delete (which deletes all resources dependent on the credential as well as the credential) or not. If false will fail if there are any resources relying on the credential.
  • api-version (query, required) — Client Api Version.
PUT

/catalog/usql/databases/{databaseName}/credentials/{credentialName}

Creates the specified credential for use with external data sources in the specified database.

  • databaseName (path, required) — The name of the database in which to create the credential. Note: This is NOT an external database name, but the name of an existing U-SQL database that should contain the new credential object.
  • credentialName (path, required) — The name of the credential.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/externaldatasources

Retrieves the list of external data sources from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the external data sources.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}

Retrieves the specified external data source from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the external data source.
  • externalDataSourceName (path, required) — The name of the external data source.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas

Retrieves the list of schemas from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the schema.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}

Retrieves the specified schema from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the schema.
  • schemaName (path, required) — The name of the schema.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages

Retrieves the list of packages from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the packages.
  • schemaName (path, required) — The name of the schema containing the packages.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/packages/{packageName}

Retrieves the specified package from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the package.
  • schemaName (path, required) — The name of the schema containing the package.
  • packageName (path, required) — The name of the package.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures

Retrieves the list of procedures from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the procedures.
  • schemaName (path, required) — The name of the schema containing the procedures.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}

Retrieves the specified procedure from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the procedure.
  • schemaName (path, required) — The name of the schema containing the procedure.
  • procedureName (path, required) — The name of the procedure.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/statistics

Retrieves the list of all table statistics within the specified schema from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the statistics.
  • schemaName (path, required) — The name of the schema containing the statistics.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables

Retrieves the list of tables from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the tables.
  • schemaName (path, required) — The name of the schema containing the tables.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • basic (query) — The basic switch indicates what level of information to return when listing tables. When basic is true, only database_name, schema_name, table_name and version are returned for each table, otherwise all table metadata is returned. By default, it is false. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}

Retrieves the specified table from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table.
  • schemaName (path, required) — The name of the schema containing the table.
  • tableName (path, required) — The name of the table.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/types

Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the types.
  • schemaName (path, required) — The name of the schema containing the types.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions

Retrieves the list of table partitions from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the partitions.
  • schemaName (path, required) — The name of the schema containing the partitions.
  • tableName (path, required) — The name of the table containing the partitions.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}

Retrieves the specified table partition from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the partition.
  • schemaName (path, required) — The name of the schema containing the partition.
  • tableName (path, required) — The name of the table containing the partition.
  • partitionName (path, required) — The name of the table partition.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}/previewrows

Retrieves a preview set of rows in given partition.

  • databaseName (path, required) — The name of the database containing the partition.
  • schemaName (path, required) — The name of the schema containing the partition.
  • tableName (path, required) — The name of the table containing the partition.
  • partitionName (path, required) — The name of the table partition.
  • maxRows (query) — The maximum number of preview rows to be retrieved.Rows returned may be less than or equal to this number depending on row sizes and number of rows in the partition.
  • maxColumns (query) — The maximum number of columns to be retrieved.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/previewrows

Retrieves a preview set of rows in given table.

  • databaseName (path, required) — The name of the database containing the table.
  • schemaName (path, required) — The name of the schema containing the table.
  • tableName (path, required) — The name of the table.
  • maxRows (query) — The maximum number of preview rows to be retrieved. Rows returned may be less than or equal to this number depending on row sizes and number of rows in the table.
  • maxColumns (query) — The maximum number of columns to be retrieved.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics

Retrieves the list of table statistics from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the statistics.
  • schemaName (path, required) — The name of the schema containing the statistics.
  • tableName (path, required) — The name of the table containing the statistics.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics/{statisticsName}

Retrieves the specified table statistics from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the statistics.
  • schemaName (path, required) — The name of the schema containing the statistics.
  • tableName (path, required) — The name of the table containing the statistics.
  • statisticsName (path, required) — The name of the table statistics.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/tablefragments

Retrieves the list of table fragments from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table fragments.
  • schemaName (path, required) — The name of the schema containing the table fragments.
  • tableName (path, required) — The name of the table containing the table fragments.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes

Retrieves the list of table types from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table types.
  • schemaName (path, required) — The name of the schema containing the table types.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes/{tableTypeName}

Retrieves the specified table type from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table type.
  • schemaName (path, required) — The name of the schema containing the table type.
  • tableTypeName (path, required) — The name of the table type to retrieve.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions

Retrieves the list of table valued functions from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table valued functions.
  • schemaName (path, required) — The name of the schema containing the table valued functions.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions/{tableValuedFunctionName}

Retrieves the specified table valued function from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table valued function.
  • schemaName (path, required) — The name of the schema containing the table valued function.
  • tableValuedFunctionName (path, required) — The name of the tableValuedFunction.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views

Retrieves the list of views from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the views.
  • schemaName (path, required) — The name of the schema containing the views.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/schemas/{schemaName}/views/{viewName}

Retrieves the specified view from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the view.
  • schemaName (path, required) — The name of the schema containing the view.
  • viewName (path, required) — The name of the view.
  • api-version (query, required) — Client Api Version.
DELETE

/catalog/usql/databases/{databaseName}/secrets

Deletes all secrets in the specified database. This is deprecated and will be removed in the next release. In the future, please only drop individual credentials using DeleteCredential

  • databaseName (path, required) — The name of the database containing the secret.
  • api-version (query, required) — Client Api Version.
DELETE

/catalog/usql/databases/{databaseName}/secrets/{secretName}

Deletes the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use DeleteCredential instead.

  • databaseName (path, required) — The name of the database containing the secret.
  • secretName (path, required) — The name of the secret to delete
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/secrets/{secretName}

Gets the specified secret in the specified database. This is deprecated and will be removed in the next release. Please use GetCredential instead.

  • databaseName (path, required) — The name of the database containing the secret.
  • secretName (path, required) — The name of the secret to get
  • api-version (query, required) — Client Api Version.
PATCH

/catalog/usql/databases/{databaseName}/secrets/{secretName}

Modifies the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use UpdateCredential instead.

  • databaseName (path, required) — The name of the database containing the secret.
  • secretName (path, required) — The name of the secret.
  • api-version (query, required) — Client Api Version.
PUT

/catalog/usql/databases/{databaseName}/secrets/{secretName}

Creates the specified secret for use with external data sources in the specified database. This is deprecated and will be removed in the next release. Please use CreateCredential instead.

  • databaseName (path, required) — The name of the database in which to create the secret.
  • secretName (path, required) — The name of the secret.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/statistics

Retrieves the list of all statistics in a database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table statistics.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/tables

Retrieves the list of all tables in a database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the tables.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • basic (query) — The basic switch indicates what level of information to return when listing tables. When basic is true, only database_name, schema_name, table_name and version are returned for each table, otherwise all table metadata is returned. By default, it is false
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/tablevaluedfunctions

Retrieves the list of all table valued functions in a database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the table valued functions.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.
GET

/catalog/usql/databases/{databaseName}/views

Retrieves the list of all views in a database from the Data Lake Analytics catalog.

  • databaseName (path, required) — The name of the database containing the views.
  • $filter (query) — OData filter. Optional.
  • $top (query, limit) — The number of items to return. Optional.
  • $skip (query, offset) — The number of items to skip over before returning elements. Optional.
  • $select (query) — OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.
  • $orderby (query) — OrderBy clause. One or more comma-separated expressions with an optional "asc" (the default) or "desc" depending on the order you'd like the values sorted, e.g. Categories?$orderby=CategoryName desc. Optional.
  • $count (query, limit) — The Boolean value of true or false to request a count of the matching resources included with the resources in the response, e.g. Categories?$count=true. Optional.
  • api-version (query, required) — Client Api Version.

45 endpoints auto-detected

curl -X GET \
  "https://azure.local/catalog/usql/databases/{databaseName}"

azure.local · HTTPS only