AccessControlClient | @azure/synapse-access-control

Hierarchy

AccessControlClientContext
- AccessControlClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AccessControlClient(credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials, endpoint: string, options?: AccessControlClientOptionalParams): AccessControlClient

Overrides AccessControlClientContext.constructor
- Defined in accessControlClient.ts:24
Initializes a new instance of the AccessControlClient class.

Parameters
- credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials
  
  Subscription credentials which uniquely identify client subscription.
- endpoint: string
  
  The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.
- Optional options: AccessControlClientOptionalParams
  
  The parameter options
Returns AccessControlClient

Properties

apiVersion

apiVersion: string

endpoint

endpoint: string

Methods

createRoleAssignment

createRoleAssignment(createRoleAssignmentOptions: RoleAssignmentOptions, options?: coreHttp.OperationOptions): Promise<AccessControlClientCreateRoleAssignmentResponse>

- Defined in accessControlClient.ts:152
Create role assignment.

Parameters
- createRoleAssignmentOptions: RoleAssignmentOptions
  
  Details of role id and object id.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<AccessControlClientCreateRoleAssignmentResponse>

deleteRoleAssignmentById

deleteRoleAssignmentById(roleAssignmentId: string, options?: coreHttp.OperationOptions): Promise<coreHttp.RestResponse>

- Defined in accessControlClient.ts:251
Delete role assignment by role assignment Id.

Parameters
- roleAssignmentId: string
  
  The ID of the role assignment.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<coreHttp.RestResponse>

getCallerRoleAssignments

getCallerRoleAssignments(options?: coreHttp.OperationOptions): Promise<AccessControlClientGetCallerRoleAssignmentsResponse>

- Defined in accessControlClient.ts:284
List role assignments of the caller.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<AccessControlClientGetCallerRoleAssignmentsResponse>

getRoleAssignmentById

getRoleAssignmentById(roleAssignmentId: string, options?: coreHttp.OperationOptions): Promise<AccessControlClientGetRoleAssignmentByIdResponse>

- Defined in accessControlClient.ts:217
Get role assignment by role assignment Id.

Parameters
- roleAssignmentId: string
  
  The ID of the role assignment.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<AccessControlClientGetRoleAssignmentByIdResponse>

getRoleAssignments

getRoleAssignments(options?: AccessControlClientGetRoleAssignmentsOptionalParams): Promise<AccessControlClientGetRoleAssignmentsResponse>

- Defined in accessControlClient.ts:185
List role assignments.

Parameters
- Optional options: AccessControlClientGetRoleAssignmentsOptionalParams
  
  The options parameters.
Returns Promise<AccessControlClientGetRoleAssignmentsResponse>

getRoleDefinitionById

getRoleDefinitionById(roleId: string, options?: coreHttp.OperationOptions): Promise<AccessControlClientGetRoleDefinitionByIdResponse>

- Defined in accessControlClient.ts:118
Get role by role Id.

Parameters
- roleId: string
  
  Synapse Built-In Role Id.
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns Promise<AccessControlClientGetRoleDefinitionByIdResponse>

listRoleDefinitions

listRoleDefinitions(options?: coreHttp.OperationOptions): PagedAsyncIterableIterator<SynapseRole>

- Defined in accessControlClient.ts:44
List roles.

Parameters
- Optional options: coreHttp.OperationOptions
  
  The options parameters.
Returns PagedAsyncIterableIterator<SynapseRole>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

credentials: coreHttp.TokenCredential | coreHttp.ServiceClientCredentials

endpoint: string

Optional options: AccessControlClientOptionalParams

Returns AccessControlClient

Properties

apiVersion

endpoint

Methods

createRoleAssignment

Parameters

createRoleAssignmentOptions: RoleAssignmentOptions

Optional options: coreHttp.OperationOptions

Returns Promise<AccessControlClientCreateRoleAssignmentResponse>

deleteRoleAssignmentById

Parameters

roleAssignmentId: string

Optional options: coreHttp.OperationOptions

Returns Promise<coreHttp.RestResponse>

getCallerRoleAssignments

Parameters

Optional options: coreHttp.OperationOptions

Returns Promise<AccessControlClientGetCallerRoleAssignmentsResponse>

getRoleAssignmentById

Parameters

roleAssignmentId: string

Optional options: coreHttp.OperationOptions

Returns Promise<AccessControlClientGetRoleAssignmentByIdResponse>

getRoleAssignments

Parameters

Optional options: AccessControlClientGetRoleAssignmentsOptionalParams

Returns Promise<AccessControlClientGetRoleAssignmentsResponse>

getRoleDefinitionById

Parameters

roleId: string

Optional options: coreHttp.OperationOptions

Returns Promise<AccessControlClientGetRoleDefinitionByIdResponse>

listRoleDefinitions

Parameters

Optional options: coreHttp.OperationOptions

Returns PagedAsyncIterableIterator<SynapseRole>