Catalog - Update Credential

Service:

Data Lake Analytics

API Version:

2016-11-01

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

PATCH https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/credentials/{credentialName}?api-version=2016-11-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The Azure Data Lake Analytics account upon which to execute catalog operations.
adlaCatalogDnsSuffix	path	True	string	Gets the DNS suffix used as the base for all Azure Data Lake Analytics Catalog service requests.
credentialName	path	True	string	The name of the credential.
databaseName	path	True	string	The name of the database containing the credential.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
newPassword	string	the new password for the credential and user with access to the data source.
password	string	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.
uri	string	the URI identifier for the data source this credential can connect to in the format <hostname>:<port>
userId	string	the object identifier for the user associated with this credential with access to the data source.

Responses

Name	Type	Description
200 OK		Successfully updated the specified credential's password in the specified database

Examples

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

Sample request

HTTP

PATCH https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/credentials/test_credential_name?api-version=2016-11-01

{
  "password": "test_password",
  "newPassword": "test_new_password",
  "uri": "test_host:8000",
  "userId": "test_user_id"
}

Sample response

Status code:

200

Definitions

DataLakeAnalyticsCatalogCredentialUpdateParameters

Object

Data Lake Analytics catalog credential update parameters.

Name	Type	Description
newPassword	string	the new password for the credential and user with access to the data source.
password	string	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.
uri	string	the URI identifier for the data source this credential can connect to in the format <hostname>:<port>
userId	string	the object identifier for the user associated with this credential with access to the data source.