azure.synapse.accesscontrol.aio package¶

class azure.synapse.accesscontrol.aio.AccessControlClient(credential: AsyncTokenCredential, endpoint: str, **kwargs: Any)[source]¶

AccessControlClient.

Parameters

credential (AsyncTokenCredential) – Credential needed for the client to connect to Azure.
endpoint (str) – The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.

async close() → None [source]¶

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

Create role assignment.

Parameters: create_role_assignment_options (RoleAssignmentOptions) – Details of role id and object id.
Keyword Arguments: 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
Raises: ~azure.core.exceptions.HttpResponseError

async delete_role_assignment_by_id(role_assignment_id: str, **kwargs) → None ¶

Delete role assignment by role assignment Id.

Parameters: role_assignment_id (str) – The ID of the role assignment.
Keyword Arguments: 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
Raises: ~azure.core.exceptions.HttpResponseError

async get_caller_role_assignments(**kwargs) → List[str]¶

List role assignments of the caller.

Keyword Arguments: 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]
Raises: ~azure.core.exceptions.HttpResponseError

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

Get role assignment by role assignment Id.

Parameters: role_assignment_id (str) – The ID of the role assignment.
Keyword Arguments: 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
Raises: ~azure.core.exceptions.HttpResponseError

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]¶

List role assignments.

Parameters

role_id (str) – Synapse Built-In Role Id.
principal_id (str) – Object ID of the AAD principal or security-group.
continuation_token_parameter (str) – Continuation token.

Keyword Arguments

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]

Raises

~azure.core.exceptions.HttpResponseError

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

Get role by role Id.

Parameters: role_id (str) – Synapse Built-In Role Id.
Keyword Arguments: 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
Raises: ~azure.core.exceptions.HttpResponseError

get_role_definitions(**kwargs) → AsyncIterable[azure.synapse.accesscontrol.models._models_py3.RolesListResponse]¶

List roles.

Keyword Arguments: 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]
Raises: ~azure.core.exceptions.HttpResponseError

Subpackages¶

azure.synapse.accesscontrol.aio.operations package