azure.synapse.accesscontrol.operations package¶

class azure.synapse.accesscontrol.operations.AccessControlOperations(client, config, serializer, deserializer)[source]¶

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

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_role_assignment(create_role_assignment_options: ‘models.RoleAssignmentOptions’, **kwargs: Any) → ’models.RoleAssignmentDetails’[source]¶

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

delete_role_assignment_by_id(role_assignment_id: str, **kwargs: Any) → None [source]¶

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

get_caller_role_assignments(**kwargs: Any) → List[str][source]¶

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

get_role_assignment_by_id(role_assignment_id: str, **kwargs: Any) → ’models.RoleAssignmentDetails’[source]¶

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

get_role_assignments(role_id: Optional[str] = None, principal_id: Optional[str] = None, continuation_token_parameter: Optional[str] = None, **kwargs: Any) → List[‘models.RoleAssignmentDetails’][source]¶

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

get_role_definition_by_id(role_id: str, **kwargs: Any) → ’models.SynapseRole’[source]¶

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: Any) → Iterable[‘models.RolesListResponse’][source]¶

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: ItemPaged[RolesListResponse]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.synapse.accesscontrol.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/accesscontrol/models/__init__.py'>¶