azure.synapse.accesscontrol.operations package

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

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

check_principal_access(subject: ‘_models.SubjectInfo’, actions: List[‘_models.RequiredAction’], scope: str, **kwargs: Any)_models.CheckPrincipalAccessResponse[source]

Check if the given principalId has access to perform list of actions at a given scope.

Parameters
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

CheckPrincipalAccessResponse

Raises

~azure.core.exceptions.HttpResponseError

create_role_assignment(role_assignment_id: str, role_id: str, principal_id: str, scope: str, principal_type: Optional[str] = None, **kwargs: Any)_models.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

RoleAssignmentDetails

Raises

~azure.core.exceptions.HttpResponseError

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
  • role_assignment_id (str) – The ID of the role assignment.

  • scope (str) – Scope of the Synapse Built-in Role.

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_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

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)_models.RoleAssignmentDetailsList[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.

  • scope (str) – Scope of the Synapse Built-in Role.

  • continuation_token_parameter (str) – Continuation token.

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

RoleAssignmentDetailsList

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.operations.RoleDefinitionsOperations(client, config, serializer, deserializer)[source]

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

get_role_definition_by_id(role_definition_id: str, **kwargs: Any)_models.SynapseRoleDefinition[source]

Get role definition by role definition Id.

Parameters

role_definition_id (str) – Synapse Built-In Role Definition Id.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SynapseRoleDefinition, or the result of cls(response)

Return type

SynapseRoleDefinition

Raises

~azure.core.exceptions.HttpResponseError

list_role_definitions(is_built_in: Optional[bool] = None, scope: Optional[str] = None, **kwargs: Any)List[‘_models.SynapseRoleDefinition’][source]

List role definitions.

Parameters
  • is_built_in (bool) – Is a Synapse Built-In Role or not.

  • scope (str) – Scope of the Synapse Built-in Role.

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

list[SynapseRoleDefinition]

Raises

~azure.core.exceptions.HttpResponseError

list_scopes(**kwargs: Any)List[str][source]

List rbac scopes.

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

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'>