Share via

az dla catalog credential

  • Deprecated
  • Reference

This command group is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

Manage Data Lake Analytics catalog credentials.

Commands

Name Description Type Status
az dla catalog credential create

Create a new catalog credential for use with an external data source.

 Core Deprecated
az dla catalog credential delete

Delete a catalog credential.

 Core Deprecated
az dla catalog credential list

List catalog credentials.

 Core Deprecated
az dla catalog credential show

Retrieve a catalog credential.

 Core Deprecated
az dla catalog credential update

Update a catalog credential for use with an external data source.

 Core Deprecated

az dla catalog credential create

Edit
Deprecated

This command is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

Create a new catalog credential for use with an external data source.

az dla catalog credential create --account
                                 --credential-name
                                 --database-name
                                 --uri
                                 --user-name
                                 [--password]

Required Parameters

--account -n

Name of the Data Lake Analytics account.

--credential-name

The name of the credential.

--database-name

The name of the database in which to create the credential.

--uri

URI of the external data source.

--user-name

The user name that will be used when authenticating with this credential.

Optional Parameters

--password -p

Password for the credential user. Will prompt if not given.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla catalog credential delete

Edit
Deprecated

This command is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

Delete a catalog credential.

az dla catalog credential delete --credential-name
                                 --database-name
                                 [--account]
                                 [--cascade]
                                 [--ids]
                                 [--password]
                                 [--subscription]

Required Parameters

--credential-name

The name of the credential to delete.

--database-name

The name of the database containing the credential.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--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.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla catalog credential list

Edit
Deprecated

This command is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

List catalog credentials.

az dla catalog credential list --database-name
                               [--account]
                               [--count]
                               [--filter]
                               [--ids]
                               [--orderby]
                               [--select]
                               [--skip]
                               [--subscription]
                               [--top]

Required Parameters

--database-name

The name of the database containing the schema.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--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.

--filter

OData filter. Optional.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--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.

--select

OData Select statement. Limits the properties on each entry to just those requested, e.g. Categories?$select=CategoryName,Description. Optional.

--skip

The number of items to skip over before returning elements.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--top

Maximum number of items to return.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla catalog credential show

Edit
Deprecated

This command is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

Retrieve a catalog credential.

az dla catalog credential show --credential-name
                               --database-name
                               [--account]
                               [--ids]
                               [--subscription]

Required Parameters

--credential-name

The name of the credential.

--database-name

The name of the database containing the schema.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az dla catalog credential update

Edit
Deprecated

This command is implicitly deprecated because command group 'dla' is deprecated and will be removed in version '2.67.0'.

Update a catalog credential for use with an external data source.

az dla catalog credential update --credential-name
                                 --database-name
                                 --uri
                                 --user-name
                                 [--account]
                                 [--ids]
                                 [--new-password]
                                 [--password]
                                 [--subscription]

Required Parameters

--credential-name

The name of the credential to update.

--database-name

The name of the database in which the credential exists.

--uri

URI of the external data source.

--user-name

The user name associated with the credential that will have its password updated.

Optional Parameters

--account -n

Name of the Data Lake Analytics account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--new-password

New password for the credential user. Will prompt if not given.

--password -p

Current password for the credential user. Will prompt if not given.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.