RoleAssignmentsOperations Class
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.
- Inheritance
-
builtins.objectRoleAssignmentsOperations
Constructor
RoleAssignmentsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| create |
Creates a role assignment. |
| create_by_id |
Creates a role assignment by ID. |
| delete |
Deletes a role assignment. |
| delete_by_id |
Deletes a role assignment. |
| get |
Get the specified role assignment. |
| get_by_id |
Gets a role assignment by ID. |
| list |
Gets all role assignments for the subscription. |
| list_for_resource |
Gets role assignments for a resource. |
| list_for_resource_group |
Gets role assignments for a resource group. |
| list_for_scope |
Gets role assignments for a scope. |
create
Creates a role assignment.
async create(scope: str, role_assignment_name: str, parameters: azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentCreateParameters, **kwargs: Any) -> azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentParameters
- scope
- str
The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.
- role_assignment_name
- str
The name of the role assignment to create. It can be any valid GUID.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
create_by_id
Creates a role assignment by ID.
async create_by_id(role_assignment_id: str, parameters: azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentCreateParameters, **kwargs: Any) -> azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentParameters
- role_assignment_id
- str
The fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
delete
Deletes a role assignment.
async delete(scope: str, role_assignment_name: str, **kwargs: Any) -> Optional[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignment]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
delete_by_id
Deletes a role assignment.
async delete_by_id(role_assignment_id: str, **kwargs: Any) -> Optional[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignment]Parameters
- role_assignment_id
- str
The fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
get
Get the specified role assignment.
async get(scope: str, role_assignment_name: str, **kwargs: Any) -> azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
get_by_id
Gets a role assignment by ID.
async get_by_id(role_assignment_id: str, **kwargs: Any) -> azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentParameters
- role_assignment_id
- str
The fully qualified ID of the role assignment, including the scope, resource name and resource type. Use the format, /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/{subId}/resourcegroups/{rgname}//providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
RoleAssignment, or the result of cls(response)
Return type
Exceptions
list
Gets all role assignments for the subscription.
list(filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentListResult]Parameters
- filter
- str
The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RoleAssignmentListResult or the result of cls(response)
Return type
Exceptions
list_for_resource
Gets role assignments for a resource.
list_for_resource(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentListResult]Parameters
- filter
- str
The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RoleAssignmentListResult or the result of cls(response)
Return type
Exceptions
list_for_resource_group
Gets role assignments for a resource group.
list_for_resource_group(resource_group_name: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentListResult]Parameters
- filter
- str
The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RoleAssignmentListResult or the result of cls(response)
Return type
Exceptions
list_for_scope
Gets role assignments for a scope.
list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) -> AsyncIterable[azure.mgmt.authorization.v2015_07_01.models._models_py3.RoleAssignmentListResult]Parameters
- filter
- str
The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either RoleAssignmentListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.authorization.v2015_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\authorization\\v2015_07_01\\models\\__init__.py'>Feedback
Submit and view feedback for