Share via

Catalog - Create Credential

  • Reference
Service:
Data Lake Analytics
API Version:
2016-11-01

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

PUT 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 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.
api-version
 query True

string

Client Api Version.

Request Body

Name Required Type Description
password True

string

the password for the credential and user with access to the data source.
uri True

string

the URI identifier for the data source this credential can connect to in the format :
userId True

string

the object identifier for the user associated with this credential with access to the data source.

Responses

Name Type Description
200 OK

Successfully created the credential within the specified database.

Examples

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

Sample Request

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

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

Sample Response

Status code:
200

Definitions

DataLakeAnalyticsCatalogCredentialCreateParameters

Data Lake Analytics catalog credential creation parameters.

Name Type Description
password

string

the password for the credential and user with access to the data source.
uri

string

the URI identifier for the data source this credential can connect to in the format :
userId

string

the object identifier for the user associated with this credential with access to the data source.