UNPKG

azure-arm-datalake-analytics

Version:

Microsoft Azure Data Lake Analytics Management Client Library for node

1,015 lines (976 loc) 235 kB
/* * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for * license information. * * Code generated by Microsoft (R) AutoRest Code Generator. * Changes may cause incorrect behavior and will be lost if the code is * regenerated. */ import { ServiceClientOptions, RequestOptions, ServiceCallback, HttpOperationResponse } from 'ms-rest'; import * as models from '../models'; /** * @class * Catalog * __NOTE__: An instance of this class is automatically created for an * instance of the DataLakeAnalyticsCatalogManagementClient. */ export interface Catalog { /** * 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. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database in which to create the * secret. * * @param {string} secretName The name of the secret. * * @param {object} parameters The parameters required to create the secret * (name and password) * * @param {string} parameters.password the password for the secret to pass in * * @param {string} [parameters.uri] the URI identifier for the secret in the * format <hostname>:<port> * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ createSecretWithHttpOperationResponse(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * 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. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database in which to create the * secret. * * @param {string} secretName The name of the secret. * * @param {object} parameters The parameters required to create the secret * (name and password) * * @param {string} parameters.password the password for the secret to pass in * * @param {string} [parameters.uri] the URI identifier for the secret in the * format <hostname>:<port> * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ createSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; createSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, callback: ServiceCallback<void>): void; createSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * 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. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret. * * @param {object} parameters The parameters required to modify the secret * (name and password) * * @param {string} parameters.password the password for the secret to pass in * * @param {string} [parameters.uri] the URI identifier for the secret in the * format <hostname>:<port> * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ updateSecretWithHttpOperationResponse(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * 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. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret. * * @param {object} parameters The parameters required to modify the secret * (name and password) * * @param {string} parameters.password the password for the secret to pass in * * @param {string} [parameters.uri] the URI identifier for the secret in the * format <hostname>:<port> * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ updateSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; updateSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, callback: ServiceCallback<void>): void; updateSecret(accountName: string, databaseName: string, secretName: string, parameters: models.DataLakeAnalyticsCatalogSecretCreateOrUpdateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Deletes the specified secret in the specified database. This is deprecated * and will be removed in the next release. Please use DeleteCredential * instead. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret to delete * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteSecretWithHttpOperationResponse(accountName: string, databaseName: string, secretName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * Deletes the specified secret in the specified database. This is deprecated * and will be removed in the next release. Please use DeleteCredential * instead. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret to delete * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteSecret(accountName: string, databaseName: string, secretName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; deleteSecret(accountName: string, databaseName: string, secretName: string, callback: ServiceCallback<void>): void; deleteSecret(accountName: string, databaseName: string, secretName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Gets the specified secret in the specified database. This is deprecated and * will be removed in the next release. Please use GetCredential instead. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret to get * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<USqlSecret>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getSecretWithHttpOperationResponse(accountName: string, databaseName: string, secretName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.USqlSecret>>; /** * Gets the specified secret in the specified database. This is deprecated and * will be removed in the next release. Please use GetCredential instead. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {string} secretName The name of the secret to get * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {USqlSecret} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {USqlSecret} [result] - The deserialized result object if an error did not occur. * See {@link USqlSecret} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getSecret(accountName: string, databaseName: string, secretName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.USqlSecret>; getSecret(accountName: string, databaseName: string, secretName: string, callback: ServiceCallback<models.USqlSecret>): void; getSecret(accountName: string, databaseName: string, secretName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.USqlSecret>): void; /** * 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 * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteAllSecretsWithHttpOperationResponse(accountName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * 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 * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the secret. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteAllSecrets(accountName: string, databaseName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; deleteAllSecrets(accountName: string, databaseName: string, callback: ServiceCallback<void>): void; deleteAllSecrets(accountName: string, databaseName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Creates the specified credential for use with external data sources in the * specified database. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName 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. * * @param {string} credentialName The name of the credential. * * @param {object} parameters The parameters required to create the credential * (name and password) * * @param {string} parameters.password the password for the credential and user * with access to the data source. * * @param {string} parameters.uri the URI identifier for the data source this * credential can connect to in the format <hostname>:<port> * * @param {string} parameters.userId the object identifier for the user * associated with this credential with access to the data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ createCredentialWithHttpOperationResponse(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialCreateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * Creates the specified credential for use with external data sources in the * specified database. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName 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. * * @param {string} credentialName The name of the credential. * * @param {object} parameters The parameters required to create the credential * (name and password) * * @param {string} parameters.password the password for the credential and user * with access to the data source. * * @param {string} parameters.uri the URI identifier for the data source this * credential can connect to in the format <hostname>:<port> * * @param {string} parameters.userId the object identifier for the user * associated with this credential with access to the data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ createCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialCreateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; createCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialCreateParameters, callback: ServiceCallback<void>): void; createCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialCreateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Modifies the specified credential for use with external data sources in the * specified database * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * credential. * * @param {string} credentialName The name of the credential. * * @param {object} parameters The parameters required to modify the credential * (name and password) * * @param {string} [parameters.password] the current password for the * credential and user with access to the data source. This is required if the * requester is not the account owner. * * @param {string} [parameters.newPassword] the new password for the credential * and user with access to the data source. * * @param {string} [parameters.uri] the URI identifier for the data source this * credential can connect to in the format <hostname>:<port> * * @param {string} [parameters.userId] the object identifier for the user * associated with this credential with access to the data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ updateCredentialWithHttpOperationResponse(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * Modifies the specified credential for use with external data sources in the * specified database * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * credential. * * @param {string} credentialName The name of the credential. * * @param {object} parameters The parameters required to modify the credential * (name and password) * * @param {string} [parameters.password] the current password for the * credential and user with access to the data source. This is required if the * requester is not the account owner. * * @param {string} [parameters.newPassword] the new password for the credential * and user with access to the data source. * * @param {string} [parameters.uri] the URI identifier for the data source this * credential can connect to in the format <hostname>:<port> * * @param {string} [parameters.userId] the object identifier for the user * associated with this credential with access to the data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ updateCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialUpdateParameters, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>; updateCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialUpdateParameters, callback: ServiceCallback<void>): void; updateCredential(accountName: string, databaseName: string, credentialName: string, parameters: models.DataLakeAnalyticsCatalogCredentialUpdateParameters, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Deletes the specified credential in the specified database * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * credential. * * @param {string} credentialName The name of the credential to delete * * @param {object} [options] Optional Parameters. * * @param {object} [options.parameters] The parameters to delete a credential * if the current user is not the account owner. * * @param {string} [options.parameters.password] the current password for the * credential and user with access to the data source. This is required if the * requester is not the account owner. * * @param {boolean} [options.cascade] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<null>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ deleteCredentialWithHttpOperationResponse(accountName: string, databaseName: string, credentialName: string, options?: { parameters? : models.DataLakeAnalyticsCatalogCredentialDeleteParameters, cascade? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>; /** * Deletes the specified credential in the specified database * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * credential. * * @param {string} credentialName The name of the credential to delete * * @param {object} [options] Optional Parameters. * * @param {object} [options.parameters] The parameters to delete a credential * if the current user is not the account owner. * * @param {string} [options.parameters.password] the current password for the * credential and user with access to the data source. This is required if the * requester is not the account owner. * * @param {boolean} [options.cascade] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {null} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {null} [result] - The deserialized result object if an error did not occur. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ deleteCredential(accountName: string, databaseName: string, credentialName: string, options?: { parameters? : models.DataLakeAnalyticsCatalogCredentialDeleteParameters, cascade? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<void>; deleteCredential(accountName: string, databaseName: string, credentialName: string, callback: ServiceCallback<void>): void; deleteCredential(accountName: string, databaseName: string, credentialName: string, options: { parameters? : models.DataLakeAnalyticsCatalogCredentialDeleteParameters, cascade? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void; /** * Retrieves the specified credential from the Data Lake Analytics catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the schema. * * @param {string} credentialName The name of the credential. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<USqlCredential>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getCredentialWithHttpOperationResponse(accountName: string, databaseName: string, credentialName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.USqlCredential>>; /** * Retrieves the specified credential from the Data Lake Analytics catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the schema. * * @param {string} credentialName The name of the credential. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {USqlCredential} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {USqlCredential} [result] - The deserialized result object if an error did not occur. * See {@link USqlCredential} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getCredential(accountName: string, databaseName: string, credentialName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.USqlCredential>; getCredential(accountName: string, databaseName: string, credentialName: string, callback: ServiceCallback<models.USqlCredential>): void; getCredential(accountName: string, databaseName: string, credentialName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.USqlCredential>): void; /** * Retrieves the list of credentials from the Data Lake Analytics catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the schema. * * @param {object} [options] Optional Parameters. * * @param {string} [options.filter] OData filter. Optional. * * @param {number} [options.top] The number of items to return. Optional. * * @param {number} [options.skip] The number of items to skip over before * returning elements. Optional. * * @param {string} [options.select] OData Select statement. Limits the * properties on each entry to just those requested, e.g. * Categories?$select=CategoryName,Description. Optional. * * @param {string} [options.orderby] 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. * * @param {boolean} [options.count] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<USqlCredentialList>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listCredentialsWithHttpOperationResponse(accountName: string, databaseName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.USqlCredentialList>>; /** * Retrieves the list of credentials from the Data Lake Analytics catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the schema. * * @param {object} [options] Optional Parameters. * * @param {string} [options.filter] OData filter. Optional. * * @param {number} [options.top] The number of items to return. Optional. * * @param {number} [options.skip] The number of items to skip over before * returning elements. Optional. * * @param {string} [options.select] OData Select statement. Limits the * properties on each entry to just those requested, e.g. * Categories?$select=CategoryName,Description. Optional. * * @param {string} [options.orderby] 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. * * @param {boolean} [options.count] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {USqlCredentialList} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {USqlCredentialList} [result] - The deserialized result object if an error did not occur. * See {@link USqlCredentialList} for more information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listCredentials(accountName: string, databaseName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<models.USqlCredentialList>; listCredentials(accountName: string, databaseName: string, callback: ServiceCallback<models.USqlCredentialList>): void; listCredentials(accountName: string, databaseName: string, options: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.USqlCredentialList>): void; /** * Retrieves the specified external data source from the Data Lake Analytics * catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * external data source. * * @param {string} externalDataSourceName The name of the external data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<USqlExternalDataSource>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ getExternalDataSourceWithHttpOperationResponse(accountName: string, databaseName: string, externalDataSourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.USqlExternalDataSource>>; /** * Retrieves the specified external data source from the Data Lake Analytics * catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * external data source. * * @param {string} externalDataSourceName The name of the external data source. * * @param {object} [options] Optional Parameters. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {USqlExternalDataSource} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {USqlExternalDataSource} [result] - The deserialized result object if an error did not occur. * See {@link USqlExternalDataSource} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ getExternalDataSource(accountName: string, databaseName: string, externalDataSourceName: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.USqlExternalDataSource>; getExternalDataSource(accountName: string, databaseName: string, externalDataSourceName: string, callback: ServiceCallback<models.USqlExternalDataSource>): void; getExternalDataSource(accountName: string, databaseName: string, externalDataSourceName: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.USqlExternalDataSource>): void; /** * Retrieves the list of external data sources from the Data Lake Analytics * catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * external data sources. * * @param {object} [options] Optional Parameters. * * @param {string} [options.filter] OData filter. Optional. * * @param {number} [options.top] The number of items to return. Optional. * * @param {number} [options.skip] The number of items to skip over before * returning elements. Optional. * * @param {string} [options.select] OData Select statement. Limits the * properties on each entry to just those requested, e.g. * Categories?$select=CategoryName,Description. Optional. * * @param {string} [options.orderby] 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. * * @param {boolean} [options.count] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @returns {Promise} A promise is returned * * @resolve {HttpOperationResponse<USqlExternalDataSourceList>} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. */ listExternalDataSourcesWithHttpOperationResponse(accountName: string, databaseName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.USqlExternalDataSourceList>>; /** * Retrieves the list of external data sources from the Data Lake Analytics * catalog. * * @param {string} accountName The Azure Data Lake Analytics account upon which * to execute catalog operations. * * @param {string} databaseName The name of the database containing the * external data sources. * * @param {object} [options] Optional Parameters. * * @param {string} [options.filter] OData filter. Optional. * * @param {number} [options.top] The number of items to return. Optional. * * @param {number} [options.skip] The number of items to skip over before * returning elements. Optional. * * @param {string} [options.select] OData Select statement. Limits the * properties on each entry to just those requested, e.g. * Categories?$select=CategoryName,Description. Optional. * * @param {string} [options.orderby] 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. * * @param {boolean} [options.count] 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. * * @param {object} [options.customHeaders] Headers that will be added to the * request * * @param {ServiceCallback} [optionalCallback] - The optional callback. * * @returns {ServiceCallback|Promise} If a callback was passed as the last * parameter then it returns the callback else returns a Promise. * * {Promise} A promise is returned. * * @resolve {USqlExternalDataSourceList} - The deserialized result object. * * @reject {Error|ServiceError} - The error object. * * {ServiceCallback} optionalCallback(err, result, request, response) * * {Error|ServiceError} err - The Error object if an error occurred, null otherwise. * * {USqlExternalDataSourceList} [result] - The deserialized result object if an error did not occur. * See {@link USqlExternalDataSourceList} for more * information. * * {WebResource} [request] - The HTTP Request object if an error did not occur. * * {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur. */ listExternalDataSources(accountName: string, databaseName: string, options?: { filter? : string, top? : number, skip? : number, select? : string, orderby? : string, count? : boolean, customHeaders? : { [headerName: string]: string; } }): Promise<models.USqlExternalDataSourceList>; listExternalDataSources(accountName: string, databaseName: string, callback: