AccessControlOperations Class

AccessControlOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

AccessControlOperations

Constructor

AccessControlOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_role_assignment	Create role assignment.
delete_role_assignment_by_id	Delete role assignment by role assignment Id.
get_caller_role_assignments	List role assignments of the caller.
get_role_assignment_by_id	Get role assignment by role assignment Id.
get_role_assignments	List role assignments.
get_role_definition_by_id	Get role by role Id.
get_role_definitions	List roles.

create_role_assignment

Create role assignment.

async create_role_assignment(create_role_assignment_options: azure.synapse.accesscontrol.models._models_py3.RoleAssignmentOptions, **kwargs) -> azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetails

Parameters

create_role_assignment_options

RoleAssignmentOptions

Required

Details of role id and object id.

cls

callable

A custom type or function that will be passed the direct response

Returns

RoleAssignmentDetails, or the result of cls(response)

Return type

RoleAssignmentDetails

Exceptions

HttpResponseError

delete_role_assignment_by_id

Delete role assignment by role assignment Id.

async delete_role_assignment_by_id(role_assignment_id: str, **kwargs) -> None

Parameters

role_assignment_id

str

Required

The ID of the role assignment.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get_caller_role_assignments

List role assignments of the caller.

async get_caller_role_assignments(**kwargs) -> List[str]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

list of str, or the result of cls(response)

Return type

list[str]

Exceptions

HttpResponseError

get_role_assignment_by_id

Get role assignment by role assignment Id.

async get_role_assignment_by_id(role_assignment_id: str, **kwargs) -> azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetails

Parameters

role_assignment_id

str

Required

The ID of the role assignment.

cls

callable

A custom type or function that will be passed the direct response

Returns

RoleAssignmentDetails, or the result of cls(response)

Return type

RoleAssignmentDetails

Exceptions

HttpResponseError

get_role_assignments

List role assignments.

async get_role_assignments(role_id: Optional[str] = None, principal_id: Optional[str] = None, continuation_token_parameter: Optional[str] = None, **kwargs) -> List[azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetails]

Parameters

role_id

str

default value: None

Synapse Built-In Role Id.

principal_id

str

default value: None

Object ID of the AAD principal or security-group.

continuation_token_parameter

str

default value: None

Continuation token.

cls

callable

A custom type or function that will be passed the direct response

Returns

list of RoleAssignmentDetails, or the result of cls(response)

Return type

list[RoleAssignmentDetails]

Exceptions

HttpResponseError

get_role_definition_by_id

Get role by role Id.

async get_role_definition_by_id(role_id: str, **kwargs) -> azure.synapse.accesscontrol.models._models_py3.SynapseRole

Parameters

role_id

str

Required

Synapse Built-In Role Id.

cls

callable

A custom type or function that will be passed the direct response

Returns

SynapseRole, or the result of cls(response)

Return type

SynapseRole

Exceptions

HttpResponseError

get_role_definitions

List roles.

get_role_definitions(**kwargs) -> AsyncIterable[azure.synapse.accesscontrol.models._models_py3.RolesListResponse]

Parameters

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RolesListResponse or the result of cls(response)

Return type

AsyncItemPaged[RolesListResponse]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.synapse.accesscontrol.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\synapse\\accesscontrol\\models\\__init__.py'>