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

Constructor

RoleAssignmentsOperations(client, config, serializer, deserializer) -> None

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

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.

create(scope: str, role_assignment_name: str, parameters: azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignmentCreateParameters, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

scope
str
Required

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
Required

The name of the role assignment to create. It can be any valid GUID.

parameters
RoleAssignmentCreateParameters
Required

Parameters for the role assignment.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

create_by_id

Creates a role assignment by ID.

create_by_id(role_id: str, parameters: azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignmentCreateParameters, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

role_id
str
Required

The ID of the role assignment to create.

parameters
RoleAssignmentCreateParameters
Required

Parameters for the role assignment.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

delete

Deletes a role assignment.

delete(scope: str, role_assignment_name: str, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

scope
str
Required

The scope of the role assignment to delete.

role_assignment_name
str
Required

The name of the role assignment to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

delete_by_id

Deletes a role assignment.

delete_by_id(role_id: str, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

role_id
str
Required

The ID of the role assignment to delete.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

get

Get the specified role assignment.

get(scope: str, role_assignment_name: str, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

scope
str
Required

The scope of the role assignment.

role_assignment_name
str
Required

The name of the role assignment to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

get_by_id

Gets a role assignment by ID.

get_by_id(role_id: str, **kwargs) -> azure.mgmt.authorization.v2018_01_01_preview.models._models_py3.RoleAssignment

Parameters

role_id
str
Required

The ID of the role assignment to get.

cls
callable

A custom type or function that will be passed the direct response

Returns

RoleAssignment, or the result of cls(response)

Return type

list

Gets all role assignments for the subscription.

list(filter: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.RoleAssignmentListResult')]

Parameters

filter
str
default value: None

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

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: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.RoleAssignmentListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

resource_provider_namespace
str
Required

The namespace of the resource provider.

parent_resource_path
str
Required

The parent resource identity.

resource_type
str
Required

The resource type of the resource.

resource_name
str
Required

The name of the resource to get role assignments for.

filter
str
default value: None

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

list_for_resource_group

Gets role assignments for a resource group.

list_for_resource_group(resource_group_name: str, filter: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.RoleAssignmentListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

filter
str
default value: None

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

list_for_scope

Gets role assignments for a scope.

list_for_scope(scope: str, filter: typing.Union[str, NoneType] = None, **kwargs) -> typing.AsyncIterable[_ForwardRef('_models.RoleAssignmentListResult')]

Parameters

scope
str
Required

The scope of the role assignments.

filter
str
default value: None

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

Attributes

models

models = <module 'azure.mgmt.authorization.v2018_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\authorization\\v2018_01_01_preview\\models\\__init__.py'>