Catalog - Delete Credential

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

Deletes the specified credential in the specified database

POST https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/credentials/{credentialName}?api-version=2016-11-01
With optional parameters: 
POST https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/credentials/{credentialName}?cascade={cascade}&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 to delete
databaseName
 path True

string

The name of the database containing the credential.
api-version
 query True

string

Client Api Version.
cascade
 query

boolean

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.

Request Body

Name Type Description
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.

Responses

Name Type Description
200 OK

Successfully deleted the specified credential from the specified database.

Examples

Deletes the specified credential in the specified database

Sample Request

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

{
  "password": "test_password"
}

Sample Response

Status code:
200

Definitions

DataLakeAnalyticsCatalogCredentialDeleteParameters

Data Lake Analytics catalog credential deletion parameters.

Name Type Description
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.