Share via


Catalog - Grant Acl To Database

Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog.

POST https://{accountName}.{adlaCatalogDnsSuffix}/catalog/usql/databases/{databaseName}/acl?op=GRANTACE&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.

api-version
query True

string

Client Api Version.

op
query True

string

The constant value for the operation.

Request Body

Name Required Type Description
aceType True

AclType

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively.

permission True

PermissionType

the permission type of the access control list (ACL) entry.

principalId True

string (uuid)

the Azure AD object ID of the user or group being specified in the access control list (ACL) entry.

Responses

Name Type Description
200 OK

Successfully granted the access control list (ACL) entry to the specified database.

Examples

Grants an access control list (ACL) entry to the database from the Data Lake Analytics catalog

Sample request

POST https://contosoadla.azuredatalakeanalytics.net/catalog/usql/databases/master/acl?op=GRANTACE&api-version=2016-11-01

{
  "aceType": "User",
  "principalId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
  "permission": "Use"
}

Sample response

Definitions

Name Description
AclCreateOrUpdateParameters

The parameters used to create or update an access control list (ACL) entry.

AclType

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively.

PermissionType

the permission type of the access control list (ACL) entry.

AclCreateOrUpdateParameters

The parameters used to create or update an access control list (ACL) entry.

Name Type Description
aceType

AclType

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively.

permission

PermissionType

the permission type of the access control list (ACL) entry.

principalId

string (uuid)

the Azure AD object ID of the user or group being specified in the access control list (ACL) entry.

AclType

the access control list (ACL) entry type. UserObj and GroupObj denote the owning user and group, respectively.

Value Description
UserObj
GroupObj
Other
User
Group

PermissionType

the permission type of the access control list (ACL) entry.

Value Description
None
Use
Create
Drop
Alter
Write
All