Catalog - Get Secret

Service:

Data Lake Analytics

API Version:

2016-11-01

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

GET https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/secrets/{secretName}?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.
databaseName	path	True	string	The name of the database containing the secret.
secretName	path	True	string	The name of the secret to get
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	USqlSecret	Successfully retrieved details of the specified secret in the specified database.

Examples

Gets the specified secret in the specified database

Sample Request

HTTP

GET https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/secrets/test_secret_name?api-version=2016-11-01

Sample Response

Status code:

200

{
  "computeAccountName": "contosoadla",
  "version": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
  "databaseName": "master",
  "secretName": "test_secret_name",
  "creationTime": "2017-04-14T13:21:56.6819037-07:00",
  "uri": "test_host:8000",
  "password": "test_password"
}

Definitions

USqlSecret

A Data Lake Analytics catalog U-SQL secret item.

Name	Type	Description
computeAccountName	string	the name of the Data Lake Analytics account.
creationTime	string	the creation time of the credential object. This is the only information returned about a secret from a GET.
databaseName	string	the name of the database.
password	string	the password for the secret to pass in
secretName	string	the name of the secret.
uri	string	the URI identifier for the secret in the format :
version	string	the version of the catalog item.