swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Catalog API description: Operations for listing the registry catalog schemes: - https tags: - name: Catalog description: Operations for listing the registry catalog paths: /acr/v1/_catalog: get: operationId: Catalog_List summary: Microsoft Azure List Repositories description: List repositories in the registry. tags: - Catalog parameters: - name: last in: query description: Query parameter for the last item in the previous call. schema: type: string example: example_value - name: n in: query description: Number of repositories to return. schema: type: integer example: 10 responses: '200': description: Successfully returned the list of repositories. content: application/json: schema: $ref: '#/components/schemas/Repositories' examples: CatalogList200Example: summary: Default Catalog_List 200 response x-microcks-default: true value: repositories: - example_value default: description: ACR error response. content: application/json: schema: $ref: '#/components/schemas/AcrErrors' examples: CatalogListdefaultExample: summary: Default Catalog_List default response x-microcks-default: true value: errors: - code: example_value message: example_value detail: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /catalog/usql/databases/{databaseName}/secrets/{secretName}: put: tags: - Catalog operationId: microsoftAzureCatalogCreatesecret description: Creates the specified secret for use with external data sources in the specified database. parameters: - name: databaseName in: path required: true type: string description: The name of the database in which to create the secret. - name: secretName in: path required: true type: string description: The name of the secret. - name: parameters in: body required: true schema: $ref: '#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters' description: The parameters required to create the secret (name and password) - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlSecret' summary: Microsoft Azure Put Catalog Usql Databases Databasename Secrets Secretname patch: tags: - Catalog operationId: microsoftAzureCatalogUpdatesecret description: Modifies the specified secret for use with external data sources in the specified database parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the secret. - name: secretName in: path required: true type: string description: The name of the secret. - name: parameters in: body required: true schema: $ref: '#/definitions/DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters' description: The parameters required to modify the secret (name and password) - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlSecret' summary: Microsoft Azure Patch Catalog Usql Databases Databasename Secrets Secretname get: tags: - Catalog operationId: microsoftAzureCatalogGetsecret description: Gets the specified secret in the specified database parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the secret. - name: secretName in: path required: true type: string description: The name of the secret to get - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlSecret' summary: Microsoft Azure Get Catalog Usql Databases Databasename Secrets Secretname delete: tags: - Catalog operationId: microsoftAzureCatalogDeletesecret description: Deletes the specified secret in the specified database parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the secret. - name: secretName in: path required: true type: string description: The name of the secret to delete - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' summary: Microsoft Azure Delete Catalog Usql Databases Databasename Secrets Secretname /catalog/usql/databases/{databaseName}/secrets: delete: tags: - Catalog operationId: microsoftAzureCatalogDeleteallsecrets description: Deletes all secrets in the specified database parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the secret. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' summary: Microsoft Azure Delete Catalog Usql Databases Databasename Secrets /catalog/usql/databases/{databaseName}/externaldatasources/{externalDataSourceName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetexternaldatasource description: Retrieves the specified external data source from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the external data source. - name: externalDataSourceName in: path required: true type: string description: The name of the external data source. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlExternalDataSource' summary: Microsoft Azure Get Catalog Usql Databases Databasename Externaldatasources Externaldatasourcename /catalog/usql/databases/{databaseName}/externaldatasources: get: tags: - Catalog operationId: microsoftAzureCatalogListexternaldatasources description: Retrieves the list of external data sources from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the external data sources. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlExternalDataSourceList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlExternalDataSource' summary: Microsoft Azure Get Catalog Usql Databases Databasename Externaldatasources /catalog/usql/databases/{databaseName}/credentials/{credentialName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetcredential description: Retrieves the specified credential from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the schema. - name: credentialName in: path required: true type: string description: The name of the credential. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlCredential' summary: Microsoft Azure Get Catalog Usql Databases Databasename Credentials Credentialname /catalog/usql/databases/{databaseName}/credentials: get: tags: - Catalog operationId: microsoftAzureCatalogListcredentials description: Retrieves the list of credentials from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the schema. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlCredentialList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlCredential' summary: Microsoft Azure Get Catalog Usql Databases Databasename Credentials /catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures/{procedureName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetprocedure description: Retrieves the specified procedure from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the procedure. - name: schemaName in: path required: true type: string description: The name of the schema containing the procedure. - name: procedureName in: path required: true type: string description: The name of the procedure. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlProcedure' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Procedures Procedurename /catalog/usql/databases/{databaseName}/schemas/{schemaName}/procedures: get: tags: - Catalog operationId: microsoftAzureCatalogListprocedures description: Retrieves the list of procedures from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the procedures. - name: schemaName in: path required: true type: string description: The name of the schema containing the procedures. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlProcedureList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlProcedure' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Procedures /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}: get: tags: - Catalog operationId: microsoftAzureCatalogGettable description: Retrieves the specified table from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the table. - name: schemaName in: path required: true type: string description: The name of the schema containing the table. - name: tableName in: path required: true type: string description: The name of the table. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTable' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables Tablename /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables: get: tags: - Catalog operationId: microsoftAzureCatalogListtables description: Retrieves the list of tables from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the tables. - name: schemaName in: path required: true type: string description: The name of the schema containing the tables. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlTable' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes/{tableTypeName}: get: tags: - Catalog operationId: microsoftAzureCatalogGettabletype description: Retrieves the specified table type from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the table type. - name: schemaName in: path required: true type: string description: The name of the schema containing the table type. - name: tableTypeName in: path required: true type: string description: The name of the table type to retrieve. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableType' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tabletypes Tabletypename /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tabletypes: get: tags: - Catalog operationId: microsoftAzureCatalogListtabletypes description: Retrieves the list of table types from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the table types. - name: schemaName in: path required: true type: string description: The name of the schema containing the table types. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableTypeList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlTableType' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tabletypes /catalog/usql/databases/{databaseName}/schemas/{schemaName}/views/{viewName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetview description: Retrieves the specified view from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the view. - name: schemaName in: path required: true type: string description: The name of the schema containing the view. - name: viewName in: path required: true type: string description: The name of the view. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlView' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Views Viewname /catalog/usql/databases/{databaseName}/schemas/{schemaName}/views: get: tags: - Catalog operationId: microsoftAzureCatalogListviews description: Retrieves the list of views from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the views. - name: schemaName in: path required: true type: string description: The name of the schema containing the views. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlViewList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlView' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Views /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics/{statisticsName}: get: tags: - Catalog operationId: microsoftAzureCatalogGettablestatistic description: Retrieves the specified table statistics from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the statistics. - name: schemaName in: path required: true type: string description: The name of the schema containing the statistics. - name: tableName in: path required: true type: string description: The name of the table containing the statistics. - name: statisticsName in: path required: true type: string description: The name of the table statistics. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableStatistics' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables Tablename Statistics Statisticsname /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/statistics: get: tags: - Catalog operationId: microsoftAzureCatalogListtablestatistics description: Retrieves the list of table statistics from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the statistics. - name: schemaName in: path required: true type: string description: The name of the schema containing the statistics. - name: tableName in: path required: true type: string description: The name of the table containing the statistics. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableStatisticsList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlTableStatistics' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables Tablename Statistics /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions/{partitionName}: get: tags: - Catalog operationId: microsoftAzureCatalogGettablepartition description: Retrieves the specified table partition from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the partition. - name: schemaName in: path required: true type: string description: The name of the schema containing the partition. - name: tableName in: path required: true type: string description: The name of the table containing the partition. - name: partitionName in: path required: true type: string description: The name of the table partition. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTablePartition' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables Tablename Partitions Partitionname /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/partitions: get: tags: - Catalog operationId: microsoftAzureCatalogListtablepartitions description: Retrieves the list of table partitions from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the partitions. - name: schemaName in: path required: true type: string description: The name of the schema containing the partitions. - name: tableName in: path required: true type: string description: The name of the table containing the partitions. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTablePartitionList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlTablePartition' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tables Tablename Partitions /catalog/usql/databases/{databaseName}/schemas/{schemaName}/types: get: tags: - Catalog operationId: microsoftAzureCatalogListtypes description: Retrieves the list of types within the specified database and schema from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the types. - name: schemaName in: path required: true type: string description: The name of the schema containing the types. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTypeList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlType' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Types /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions/{tableValuedFunctionName}: get: tags: - Catalog operationId: microsoftAzureCatalogGettablevaluedfunction description: Retrieves the specified table valued function from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the table valued function. - name: schemaName in: path required: true type: string description: The name of the schema containing the table valued function. - name: tableValuedFunctionName in: path required: true type: string description: The name of the tableValuedFunction. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableValuedFunction' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tablevaluedfunctions Tablevaluedfunctionname /catalog/usql/databases/{databaseName}/schemas/{schemaName}/tablevaluedfunctions: get: tags: - Catalog operationId: microsoftAzureCatalogListtablevaluedfunctions description: Retrieves the list of table valued functions from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the table valued functions. - name: schemaName in: path required: true type: string description: The name of the schema containing the table valued functions. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlTableValuedFunctionList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlTableValuedFunction' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname Tablevaluedfunctions /catalog/usql/databases/{databaseName}/assemblies/{assemblyName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetassembly description: Retrieves the specified assembly from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the assembly. - name: assemblyName in: path required: true type: string description: The name of the assembly. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlAssembly' summary: Microsoft Azure Get Catalog Usql Databases Databasename Assemblies Assemblyname /catalog/usql/databases/{databaseName}/assemblies: get: tags: - Catalog operationId: microsoftAzureCatalogListassemblies description: Retrieves the list of assemblies from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the assembly. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlAssemblyList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlAssembly' summary: Microsoft Azure Get Catalog Usql Databases Databasename Assemblies /catalog/usql/databases/{databaseName}/schemas/{schemaName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetschema description: Retrieves the specified schema from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the schema. - name: schemaName in: path required: true type: string description: The name of the schema. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlSchema' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas Schemaname /catalog/usql/databases/{databaseName}/schemas: get: tags: - Catalog operationId: microsoftAzureCatalogListschemas description: Retrieves the list of schemas from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database containing the schema. - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlSchemaList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlSchema' summary: Microsoft Azure Get Catalog Usql Databases Databasename Schemas /catalog/usql/databases/{databaseName}: get: tags: - Catalog operationId: microsoftAzureCatalogGetdatabase description: Retrieves the specified database from the Data Lake Analytics catalog. parameters: - name: databaseName in: path required: true type: string description: The name of the database. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlDatabase' summary: Microsoft Azure Get Catalog Usql Databases Databasename /catalog/usql/databases: get: tags: - Catalog operationId: microsoftAzureCatalogListdatabases description: Retrieves the list of databases from the Data Lake Analytics catalog. parameters: - name: $filter in: query required: false type: string description: OData filter. Optional. - name: $top in: query required: false type: integer format: int32 description: The number of items to return. Optional. - name: $skip in: query required: false type: integer format: int32 description: The number of items to skip over before returning elements. Optional. - name: $expand in: query required: false type: string description: OData expansion. Expand related resources in line with the retrieved resources, e.g. Categories?$expand=Products would expand Product data in line with each Category entry. Optional. - name: $select in: query required: false type: string description: OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional. - name: $orderby in: query required: false type: string description: 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. - name: $count in: query required: false type: boolean description: 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. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: '' schema: $ref: '#/definitions/USqlDatabaseList' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/USqlDatabase' summary: Microsoft Azure Get Catalog Usql Databases components: schemas: Repositories: type: object description: List of repositories. properties: repositories: type: array items: type: string description: List of repository names. example: [] AcrErrors: type: object description: ACR error response. properties: errors: type: array items: $ref: '#/components/schemas/AcrErrorInfo' description: Array of detailed error information. example: [] AcrErrorInfo: type: object description: Error information. properties: code: type: string description: Error code. example: example_value message: type: string description: Error message. example: example_value detail: type: object description: Error details. example: example_value definitions: USqlTablePartition: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this table partition and database. partitionName: type: string x-ms-client-name: name description: the name of the table partition. parentName: $ref: '#/definitions/DdlName' description: the Ddl object of the partition's parent. indexId: type: integer format: int32 description: the index ID for this partition. label: type: array items: type: string description: the list of labels associated with this partition. createDate: type: string format: date-time description: the creation time of the partition description: A Data Lake Analytics catalog U-SQL table partition item. USqlDirectedColumn: properties: name: type: string description: the name of the index in the table. descending: type: boolean description: the switch indicating if the index is descending or not. description: A Data Lake Analytics catalog U-SQL directed column item. USqlCredential: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database the credential is in. identity: type: string description: the name of the secret associated with the credential. credentialName: type: string x-ms-client-name: name description: the name of the credential. userName: type: string description: the user name associated with the credential. description: A Data Lake Analytics catalog U-SQL credential item. USqlViewList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlView' description: the list of view in the database and schema combination description: A Data Lake Analytics catalog U-SQL view item list. USqlType: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this table and database. typeName: type: string x-ms-client-name: name description: the name of type for this type. typeFamily: type: string description: the type family for this type. cSharpName: type: string description: the C# name for this type. fullCSharpName: type: string description: the fully qualified C# name for this type. systemTypeId: type: integer format: int32 description: the system type ID for this type. userTypeId: type: integer format: int32 description: the user type ID for this type. schemaId: type: integer format: int32 description: the schema ID for this type. principalId: type: integer format: int32 description: the principal ID for this type. isNullable: type: boolean description: The switch indicating if this type is nullable. isUserDefined: type: boolean description: The switch indicating if this type is user defined. isAssemblyType: type: boolean description: The switch indicating if this type is an assembly type. isTableType: type: boolean description: The switch indicating if this type is a table type. isComplexType: type: boolean description: The switch indicating if this type is a complex type. description: A Data Lake Analytics catalog U-SQL type item. USqlTableValuedFunctionList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlTableValuedFunction' description: the list of table valued functions in the database and schema combination description: A Data Lake Analytics catalog U-SQL table valued function item list. CatalogItem: properties: computeAccountName: type: string description: the name of the Data Lake Analytics account. version: type: string format: uuid description: the version of the catalog item. description: A Data Lake Analytics catalog item. USqlTableList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlTable' description: the list of tables in the database and schema combination description: A Data Lake Analytics catalog U-SQL table item list. DdlName: properties: firstPart: type: string description: the name of the table associated with this database and schema. secondPart: type: string description: the name of the table associated with this database and schema. thirdPart: type: string description: the name of the table associated with this database and schema. server: type: string description: the name of the table associated with this database and schema. description: A Data Lake Analytics DDL name item. EntityId: properties: name: $ref: '#/definitions/DdlName' description: the name of the external table associated with this database, schema and table. version: type: string format: uuid description: the version of the external data source. description: A Data Lake Analytics catalog entity identifier object. TypeFieldInfo: properties: name: type: string description: the name of the field associated with this type. type: type: string description: the type of the field. description: A Data Lake Analytics catalog type field information item. USqlTableTypeList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlTableType' description: the list of table types in the database and schema combination description: A Data Lake Analytics catalog U-SQL table type item list. USqlAssemblyDependencyInfo: properties: entityId: $ref: '#/definitions/EntityId' description: the EntityId of the dependency. description: A Data Lake Analytics catalog U-SQL dependency information item. USqlTableStatisticsList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlTableStatistics' description: the list of table statistics in the database, schema and table combination description: A Data Lake Analytics catalog U-SQL table statistics item list. CatalogItemList: properties: count: type: integer format: int32 description: the count of items in the list. nextLink: type: string description: the link to the next page of results. description: A Data Lake Analytics catalog item list. USqlAssembly: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. assemblyName: type: string x-ms-client-name: name description: the name of the assembly. clrName: type: string description: the name of the CLR. isVisible: type: boolean description: the switch indicating if this assembly is visible or not. isUserDefined: type: boolean description: the switch indicating if this assembly is user defined or not. files: type: array items: $ref: '#/definitions/USqlAssemblyFileInfo' description: the list of files associated with the assembly dependencies: type: array items: $ref: '#/definitions/USqlAssemblyDependencyInfo' description: the list of dependencies associated with the assembly description: A Data Lake Analytics catalog U-SQL Assembly. USqlTableStatistics: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this table and database. tableName: type: string description: the name of the table. statisticsName: type: string x-ms-client-name: name description: the name of the table statistics. userStatName: type: string description: the name of the user statistics. statDataPath: type: string description: the path to the statistics data. createTime: type: string format: date-time description: the creation time of the statistics. updateTime: type: string format: date-time description: the last time the statistics were updated. isUserCreated: type: boolean description: the switch indicating if these statistics are user created. isAutoCreated: type: boolean description: the switch indicating if these statistics are automatically created. hasFilter: type: boolean description: the switch indicating if these statistics have a filter. filterDefinition: type: string description: the filter definition for the statistics. colNames: type: array items: type: string description: the list of column names associated with these statistics. description: A Data Lake Analytics catalog U-SQL table statistics item. USqlTableColumn: properties: name: type: string description: the name of the column in the table. type: type: string description: the object type of the specified column (such as System.String). description: A Data Lake Analytics catalog U-SQL table column item. USqlExternalDataSourceList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlExternalDataSource' description: the list of external data sources in the database description: A Data Lake Analytics catalog U-SQL external datasource item list. USqlProcedureList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlProcedure' description: the list of procedure in the database and schema combination description: A Data Lake Analytics catalog U-SQL procedure item list. USqlDistributionInfo: properties: type: type: integer format: int32 description: the type of this distribution. keys: type: array items: $ref: '#/definitions/USqlDirectedColumn' description: the list of directed columns in the distribution count: type: integer format: int32 description: the count of indices using this distribution. dynamicCount: type: integer format: int32 description: the dynamic count of indices using this distribution. description: A Data Lake Analytics catalog U-SQL distribution information object. USqlTableType: allOf: - $ref: '#/definitions/USqlType' properties: columns: type: array readOnly: true items: $ref: '#/definitions/TypeFieldInfo' description: the type field information associated with this table type. description: A Data Lake Analytics catalog U-SQL table type item. USqlAssemblyFileInfo: properties: type: type: string description: the assembly file type. enum: - Assembly - Resource x-ms-enum: name: FileType modelAsString: false originalPath: type: string description: The original path to the assembly file. contentPath: type: string description: The content path to the assembly file. description: A Data Lake Analytics catalog U-SQL assembly file information item. DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters: properties: password: type: string description: the password for the secret to pass in uri: type: string description: the URI identifier for the secret in the format : required: - password description: DataLakeAnalytics DataLakeAnalyticsAccount information. USqlDatabaseList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlDatabase' description: the list of databases description: A Data Lake Analytics catalog U-SQL database item list. USqlIndex: properties: name: type: string description: the name of the index in the table. indexKeys: type: array items: $ref: '#/definitions/USqlDirectedColumn' description: the list of directed columns in the index columns: type: array items: type: string description: the list of columns in the index distributionInfo: $ref: '#/definitions/USqlDistributionInfo' description: the distributions info of the index partitionFunction: type: string format: uuid description: partition function ID for the index. partitionKeyList: type: array items: type: string description: the list of partition keys in the index streamNames: type: array items: type: string description: the list of full paths to the streams that contain this index in the DataLake account. isColumnstore: type: boolean description: the switch indicating if this index is a columnstore index. indexId: type: integer format: int32 description: the ID of this index within the table. isUnique: type: boolean description: the switch indicating if this index is a unique index. description: A Data Lake Analytics catalog U-SQL table index item. USqlProcedure: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this procedure and database. procName: type: string x-ms-client-name: name description: the name of the procedure. definition: type: string description: the defined query of the procedure. description: A Data Lake Analytics catalog U-SQL procedure item. USqlCredentialList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlCredential' description: the list of credentials in the database description: A Data Lake Analytics catalog U-SQL credential item list. USqlSchema: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string x-ms-client-name: name description: the name of the schema. description: A Data Lake Analytics catalog U-SQL schema item. USqlDatabase: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string x-ms-client-name: name description: the name of the database. description: A Data Lake Analytics catalog U-SQL database item. USqlSecret: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. secretName: type: string x-ms-client-name: name description: the name of the secret. creationTime: type: string format: date-time description: the creation time of the credential object. This is the only information returned about a secret from a GET. uri: type: string description: the URI identifier for the secret in the format : password: type: string description: the password for the secret to pass in description: A Data Lake Analytics catalog U-SQL secret item. USqlAssemblyClr: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. assemblyClrName: type: string x-ms-client-name: name description: the name of the assembly. clrName: type: string description: the name of the CLR. description: A Data Lake Analytics catalog U-SQL assembly CLR item. USqlAssemblyList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlAssemblyClr' description: the list of assemblies in the database description: A Data Lake Analytics catalog U-SQL assembly CLR item list. USqlView: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this view and database. viewName: type: string x-ms-client-name: name description: the name of the view. definition: type: string description: the defined query of the view. description: A Data Lake Analytics catalog U-SQL view item. USqlTableValuedFunction: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this database. tvfName: type: string x-ms-client-name: name description: the name of the table valued function. definition: type: string description: the definition of the table valued function. description: A Data Lake Analytics catalog U-SQL table valued function item. USqlTable: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. schemaName: type: string description: the name of the schema associated with this table and database. tableName: type: string x-ms-client-name: name description: the name of the table. columnList: type: array items: $ref: '#/definitions/USqlTableColumn' description: the list of columns in this table indexList: type: array items: $ref: '#/definitions/USqlIndex' description: the list of indices in this table partitionKeyList: type: array items: type: string description: the list of partition keys in the table externalTable: $ref: '#/definitions/ExternalTable' description: the external table associated with the table. distributionInfo: $ref: '#/definitions/USqlDistributionInfo' description: the distributions info of the table description: A Data Lake Analytics catalog U-SQL table item. USqlSchemaList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlSchema' description: the list of schemas in the database description: A Data Lake Analytics catalog U-SQL schema item list. USqlExternalDataSource: allOf: - $ref: '#/definitions/CatalogItem' properties: databaseName: type: string description: the name of the database. externalDataSourceName: type: string x-ms-client-name: name description: the name of the external data source. provider: type: string description: the name of the provider for the external data source. providerString: type: string description: the name of the provider string for the external data source. pushdownTypes: type: array items: type: string description: the list of types to push down from the external data source. description: A Data Lake Analytics catalog U-SQL external datasource item. ExternalTable: properties: tableName: type: string description: the name of the table associated with this database and schema. dataSource: $ref: '#/definitions/EntityId' description: the data source associated with this external table. description: A Data Lake Analytics catalog external table item. USqlTypeList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlType' description: the list of types in the database and schema combination description: A Data Lake Analytics catalog U-SQL type item list. USqlTablePartitionList: allOf: - $ref: '#/definitions/CatalogItemList' properties: value: type: array readOnly: true items: $ref: '#/definitions/USqlTablePartition' description: the list of table partitions in the database, schema and table combination description: A Data Lake Analytics catalog U-SQL table partition item list. parameters: ApiVersionParameter: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'