azure.synapse.accesscontrol.aio.operations package¶
-
class
azure.synapse.accesscontrol.aio.operations.
RoleAssignmentsOperations
(client, config, serializer, deserializer)[source]¶ RoleAssignmentsOperations 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.
- 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.
-
async
check_principal_access
(subject: azure.synapse.accesscontrol.models._models_py3.SubjectInfo, actions: List[azure.synapse.accesscontrol.models._models_py3.RequiredAction], scope: str, **kwargs: Any) → azure.synapse.accesscontrol.models._models_py3.CheckPrincipalAccessResponse[source]¶ Check if the given principalId has access to perform list of actions at a given scope.
- Parameters
subject (SubjectInfo) – Subject details.
actions (list[RequiredAction]) – List of actions.
scope (str) – Scope at which the check access is done.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
CheckPrincipalAccessResponse, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
create_role_assignment
(role_assignment_id: str, role_id: str, principal_id: str, scope: str, principal_type: Optional[str] = None, **kwargs: Any) → azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetails[source]¶ Create role assignment.
- Parameters
role_assignment_id (str) – The ID of the role assignment.
role_id (str) – Role ID of the Synapse Built-In Role.
principal_id (str) – Object ID of the AAD principal or security-group.
scope (str) – Scope at which the role assignment is created.
principal_type (str) – Type of the principal Id: User, Group or ServicePrincipal.
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
async
delete_role_assignment_by_id
(role_assignment_id: str, scope: Optional[str] = None, **kwargs: Any) → None[source]¶ Delete role assignment by role assignment Id.
- Parameters
- 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
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_role_assignment_by_id
(role_assignment_id: str, **kwargs: Any) → azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetails[source]¶ Get role assignment by role assignment Id.
-
async
list_role_assignments
(role_id: Optional[str] = None, principal_id: Optional[str] = None, scope: Optional[str] = None, continuation_token_parameter: Optional[str] = None, **kwargs: Any) → azure.synapse.accesscontrol.models._models_py3.RoleAssignmentDetailsList[source]¶ List role assignments.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
RoleAssignmentDetailsList, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.synapse.accesscontrol.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse-accesscontrol/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/accesscontrol/models/__init__.py'>¶
-
class
azure.synapse.accesscontrol.aio.operations.
RoleDefinitionsOperations
(client, config, serializer, deserializer)[source]¶ RoleDefinitionsOperations 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.
- 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.
-
async
get_role_definition_by_id
(role_definition_id: str, **kwargs: Any) → azure.synapse.accesscontrol.models._models_py3.SynapseRoleDefinition[source]¶ Get role definition by role definition Id.
-
async
list_role_definitions
(is_built_in: Optional[bool] = None, scope: Optional[str] = None, **kwargs: Any) → List[azure.synapse.accesscontrol.models._models_py3.SynapseRoleDefinition][source]¶ List role definitions.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
list of SynapseRoleDefinition, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
models
= <module 'azure.synapse.accesscontrol.models' from '/mnt/vss/_work/1/s/sdk/synapse/azure-synapse-accesscontrol/.tox/sphinx/lib/python3.6/site-packages/azure/synapse/accesscontrol/models/__init__.py'>¶