azure.mgmt.authorization.v2020_10_01_preview.operations module

class azure.mgmt.authorization.v2020_10_01_preview.operations.EligibleChildResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s eligible_child_resources attribute.

get(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.EligibleChildResource][source]

Get the child resources of a resource on which user has eligible access.

Parameters

  • scope (str) – The scope of the role management policy. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=resourceType+eq+’Subscription’ to filter on only resource of type = ‘Subscription’. Use $filter=resourceType+eq+’subscription’+or+resourceType+eq+’resourcegroup’ to filter on resource of type = ‘Subscription’ or ‘ResourceGroup’. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either EligibleChildResource or the result of cls(response)

Return type

ItemPaged[EligibleChildResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleAssignmentScheduleInstancesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_assignment_schedule_instances attribute.

get(scope: str, role_assignment_schedule_instance_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentScheduleInstance[source]

Gets the specified role assignment schedule instance.

Parameters

  • scope (str) – The scope of the role assignments schedules. Required.

  • role_assignment_schedule_instance_name (str) – The name (hash of schedule name + time) of the role assignment schedule to get. Required.

Keyword Arguments

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

Returns

RoleAssignmentScheduleInstance or the result of cls(response)

Return type

RoleAssignmentScheduleInstance

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentScheduleInstance][source]

Gets role assignment schedule instances of a role assignment schedule.

Parameters

  • scope (str) – The scope of the role assignment schedule. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo(‘{userId}’) to return all role assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignmentScheduleInstance or the result of cls(response)

Return type

ItemPaged[RoleAssignmentScheduleInstance]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleAssignmentScheduleRequestsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_assignment_schedule_requests attribute.

cancel(scope: str, role_assignment_schedule_request_name: str, **kwargs: Any) → None[source]

Cancels a pending role assignment schedule request.

Parameters

  • scope (str) – The scope of the role assignment request to cancel. Required.

  • role_assignment_schedule_request_name (str) – The name of the role assignment request to cancel. Required.

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

HttpResponseError –

create(scope: str, role_assignment_schedule_request_name: str, parameters: _models.RoleAssignmentScheduleRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignmentScheduleRequest[source]
create(scope: str, role_assignment_schedule_request_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignmentScheduleRequest

Creates a role assignment schedule request.

Parameters

  • scope (str) – The scope of the role assignment schedule request to create. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.

  • role_assignment_schedule_request_name (str) – A GUID for the role assignment to create. The name must be unique and different for each role assignment. Required.

  • parameters (RoleAssignmentScheduleRequest or IO) – Parameters for the role assignment schedule request. Is either a RoleAssignmentScheduleRequest type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleAssignmentScheduleRequest or the result of cls(response)

Return type

RoleAssignmentScheduleRequest

Raises

HttpResponseError –

get(scope: str, role_assignment_schedule_request_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentScheduleRequest[source]

Get the specified role assignment schedule request.

Parameters

  • scope (str) – The scope of the role assignment schedule request. Required.

  • role_assignment_schedule_request_name (str) – The name (guid) of the role assignment schedule request to get. Required.

Keyword Arguments

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

Returns

RoleAssignmentScheduleRequest or the result of cls(response)

Return type

RoleAssignmentScheduleRequest

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentScheduleRequest][source]

Gets role assignment schedule requests for a scope.

Parameters

  • scope (str) – The scope of the role assignments schedule requests. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedule requests requested by the current user. Use $filter=asTarget() to return all role assignment schedule requests created for the current user. Use $filter=asApprover() to return all role assignment schedule requests where the current user is an approver. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignmentScheduleRequest or the result of cls(response)

Return type

ItemPaged[RoleAssignmentScheduleRequest]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleAssignmentSchedulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_assignment_schedules attribute.

get(scope: str, role_assignment_schedule_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentSchedule[source]

Get the specified role assignment schedule for a resource scope.

Parameters

  • scope (str) – The scope of the role assignment schedule. Required.

  • role_assignment_schedule_name (str) – The name (guid) of the role assignment schedule to get. Required.

Keyword Arguments

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

Returns

RoleAssignmentSchedule or the result of cls(response)

Return type

RoleAssignmentSchedule

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignmentSchedule][source]

Gets role assignment schedules for a resource scope.

Parameters

  • scope (str) – The scope of the role assignments schedules. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo(‘{userId}’) to return all role assignment schedules for the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignmentSchedule or the result of cls(response)

Return type

ItemPaged[RoleAssignmentSchedule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleAssignmentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_assignments attribute.

create(scope: str, role_assignment_name: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignment[source]
create(scope: str, role_assignment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignment

Create or update a role assignment by scope and name.

Parameters

  • scope (str) – The scope of the operation or resource. Valid scopes are: subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.

  • role_assignment_name (str) – The name of the role assignment. It can be any valid GUID. Required.

  • parameters (RoleAssignmentCreateParameters or IO) – Parameters for the role assignment. Is either a RoleAssignmentCreateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleAssignment or the result of cls(response)

Return type

RoleAssignment

Raises

HttpResponseError –

create_by_id(role_assignment_id: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignment[source]
create_by_id(role_assignment_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleAssignment

Create or update a role assignment by ID.

Parameters

  • role_assignment_id (str) – The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>. Required.

  • parameters (RoleAssignmentCreateParameters or IO) – Parameters for the role assignment. Is either a RoleAssignmentCreateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleAssignment or the result of cls(response)

Return type

RoleAssignment

Raises

HttpResponseError –

delete(scope: str, role_assignment_name: str, tenant_id: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

Delete a role assignment by scope and name.

Parameters

  • scope (str) – The scope of the operation or resource. Valid scopes are: subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.

  • role_assignment_name (str) – The name of the role assignment. It can be any valid GUID. Required.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

RoleAssignment or None or the result of cls(response)

Return type

RoleAssignment or None

Raises

HttpResponseError –

delete_by_id(role_assignment_id: str, tenant_id: Optional[str] = None, **kwargs: Any) → Optional[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

Delete a role assignment by ID.

Parameters

  • role_assignment_id (str) – The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>. Required.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

RoleAssignment or None or the result of cls(response)

Return type

RoleAssignment or None

Raises

HttpResponseError –

get(scope: str, role_assignment_name: str, tenant_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment[source]

Get a role assignment by scope and name.

Parameters

  • scope (str) – The scope of the operation or resource. Valid scopes are: subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.

  • role_assignment_name (str) – The name of the role assignment. It can be any valid GUID. Required.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

RoleAssignment or the result of cls(response)

Return type

RoleAssignment

Raises

HttpResponseError –

get_by_id(role_assignment_id: str, tenant_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment[source]

Get a role assignment by ID.

Parameters

  • role_assignment_id (str) – The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>. Required.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

RoleAssignment or the result of cls(response)

Return type

RoleAssignment

Raises

HttpResponseError –

list_for_resource(resource_group_name: str, resource_provider_namespace: str, resource_type: str, resource_name: str, filter: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

List all role assignments that apply to a resource.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • resource_provider_namespace (str) – The namespace of the resource provider. Required.

  • resource_type (str) – The resource type name. For example the type name of a web app is ‘sites’ (from Microsoft.Web/sites). Required.

  • resource_name (str) – The resource name. Required.

  • 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. Default value is None.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignment or the result of cls(response)

Return type

ItemPaged[RoleAssignment]

Raises

HttpResponseError –

list_for_resource_group(resource_group_name: str, filter: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

List all role assignments that apply to a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • 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. Default value is None.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignment or the result of cls(response)

Return type

ItemPaged[RoleAssignment]

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

List all role assignments that apply to a scope.

Parameters

  • scope (str) – The scope of the operation or resource. Valid scopes are: subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.

  • 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. Default value is None.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignment or the result of cls(response)

Return type

ItemPaged[RoleAssignment]

Raises

HttpResponseError –

list_for_subscription(filter: Optional[str] = None, tenant_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleAssignment][source]

List all role assignments that apply to a subscription.

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. Default value is None.

  • tenant_id (str) – Tenant ID for cross-tenant request. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleAssignment or the result of cls(response)

Return type

ItemPaged[RoleAssignment]

Raises

HttpResponseError –

validate(scope: str, role_assignment_name: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidationResponse[source]
validate(scope: str, role_assignment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidationResponse

Validate a role assignment create or update operation by scope and name.

Parameters

  • scope (str) – The scope of the operation or resource. Valid scopes are: subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.

  • role_assignment_name (str) – The name of the role assignment. It can be any valid GUID. Required.

  • parameters (RoleAssignmentCreateParameters or IO) – Parameters for the role assignment. Is either a RoleAssignmentCreateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ValidationResponse or the result of cls(response)

Return type

ValidationResponse

Raises

HttpResponseError –

validate_by_id(role_assignment_id: str, parameters: _models.RoleAssignmentCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidationResponse[source]
validate_by_id(role_assignment_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidationResponse

Validate a role assignment create or update operation by ID.

Parameters

  • role_assignment_id (str) – The fully qualified ID of the role assignment including scope, resource name, and resource type. Format: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}. Example: /subscriptions/<SUB_ID>/resourcegroups/<RESOURCE_GROUP>/providers/Microsoft.Authorization/roleAssignments/<ROLE_ASSIGNMENT_NAME>. Required.

  • parameters (RoleAssignmentCreateParameters or IO) – Parameters for the role assignment. Is either a RoleAssignmentCreateParameters type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ValidationResponse or the result of cls(response)

Return type

ValidationResponse

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleEligibilityScheduleInstancesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_eligibility_schedule_instances attribute.

get(scope: str, role_eligibility_schedule_instance_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilityScheduleInstance[source]

Gets the specified role eligibility schedule instance.

Parameters

  • scope (str) – The scope of the role eligibility schedules. Required.

  • role_eligibility_schedule_instance_name (str) – The name (hash of schedule name + time) of the role eligibility schedule to get. Required.

Keyword Arguments

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

Returns

RoleEligibilityScheduleInstance or the result of cls(response)

Return type

RoleEligibilityScheduleInstance

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilityScheduleInstance][source]

Gets role eligibility schedule instances of a role eligibility schedule.

Parameters

  • scope (str) – The scope of the role eligibility schedule. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo(‘{userId}’) to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleEligibilityScheduleInstance or the result of cls(response)

Return type

ItemPaged[RoleEligibilityScheduleInstance]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleEligibilityScheduleRequestsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_eligibility_schedule_requests attribute.

cancel(scope: str, role_eligibility_schedule_request_name: str, **kwargs: Any) → None[source]

Cancels a pending role eligibility schedule request.

Parameters

  • scope (str) – The scope of the role eligibility request to cancel. Required.

  • role_eligibility_schedule_request_name (str) – The name of the role eligibility request to cancel. Required.

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

HttpResponseError –

create(scope: str, role_eligibility_schedule_request_name: str, parameters: _models.RoleEligibilityScheduleRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleEligibilityScheduleRequest[source]
create(scope: str, role_eligibility_schedule_request_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleEligibilityScheduleRequest

Creates a role eligibility schedule request.

Parameters

  • scope (str) – The scope of the role eligibility schedule request to create. The scope can be any REST resource instance. For example, use ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/’ for a subscription, ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}’ for a resource group, and ‘/providers/Microsoft.Subscription/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}’ for a resource. Required.

  • role_eligibility_schedule_request_name (str) – The name of the role eligibility to create. It can be any valid GUID. Required.

  • parameters (RoleEligibilityScheduleRequest or IO) – Parameters for the role eligibility schedule request. Is either a RoleEligibilityScheduleRequest type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleEligibilityScheduleRequest or the result of cls(response)

Return type

RoleEligibilityScheduleRequest

Raises

HttpResponseError –

get(scope: str, role_eligibility_schedule_request_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilityScheduleRequest[source]

Get the specified role eligibility schedule request.

Parameters

  • scope (str) – The scope of the role eligibility schedule request. Required.

  • role_eligibility_schedule_request_name (str) – The name (guid) of the role eligibility schedule request to get. Required.

Keyword Arguments

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

Returns

RoleEligibilityScheduleRequest or the result of cls(response)

Return type

RoleEligibilityScheduleRequest

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilityScheduleRequest][source]

Gets role eligibility schedule requests for a scope.

Parameters

  • scope (str) – The scope of the role eligibility schedule requests. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedule requests at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedule requests at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedule requests requested by the current user. Use $filter=asTarget() to return all role eligibility schedule requests created for the current user. Use $filter=asApprover() to return all role eligibility schedule requests where the current user is an approver. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleEligibilityScheduleRequest or the result of cls(response)

Return type

ItemPaged[RoleEligibilityScheduleRequest]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleEligibilitySchedulesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_eligibility_schedules attribute.

get(scope: str, role_eligibility_schedule_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilitySchedule[source]

Get the specified role eligibility schedule for a resource scope.

Parameters

  • scope (str) – The scope of the role eligibility schedule. Required.

  • role_eligibility_schedule_name (str) – The name (guid) of the role eligibility schedule to get. Required.

Keyword Arguments

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

Returns

RoleEligibilitySchedule or the result of cls(response)

Return type

RoleEligibilitySchedule

Raises

HttpResponseError –

list_for_scope(scope: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleEligibilitySchedule][source]

Gets role eligibility schedules for a resource scope.

Parameters

  • scope (str) – The scope of the role eligibility schedules. Required.

  • filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=assignedTo(‘{userId}’) to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user. Default value is None.

Keyword Arguments

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

Returns

An iterator like instance of either RoleEligibilitySchedule or the result of cls(response)

Return type

ItemPaged[RoleEligibilitySchedule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleManagementPoliciesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_management_policies attribute.

delete(scope: str, role_management_policy_name: str, **kwargs: Any) → None[source]

Delete a role management policy.

Parameters

  • scope (str) – The scope of the role management policy to upsert. Required.

  • role_management_policy_name (str) – The name (guid) of the role management policy to upsert. Required.

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

HttpResponseError –

get(scope: str, role_management_policy_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleManagementPolicy[source]

Get the specified role management policy for a resource scope.

Parameters

  • scope (str) – The scope of the role management policy. Required.

  • role_management_policy_name (str) – The name (guid) of the role management policy to get. Required.

Keyword Arguments

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

Returns

RoleManagementPolicy or the result of cls(response)

Return type

RoleManagementPolicy

Raises

HttpResponseError –

list_for_scope(scope: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleManagementPolicy][source]

Gets role management policies for a resource scope.

Parameters

scope (str) – The scope of the role management policy. Required.

Keyword Arguments

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

Returns

An iterator like instance of either RoleManagementPolicy or the result of cls(response)

Return type

ItemPaged[RoleManagementPolicy]

Raises

HttpResponseError –

update(scope: str, role_management_policy_name: str, parameters: _models.RoleManagementPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleManagementPolicy[source]
update(scope: str, role_management_policy_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleManagementPolicy

Update a role management policy.

Parameters

  • scope (str) – The scope of the role management policy to upsert. Required.

  • role_management_policy_name (str) – The name (guid) of the role management policy to upsert. Required.

  • parameters (RoleManagementPolicy or IO) – Parameters for the role management policy. Is either a RoleManagementPolicy type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleManagementPolicy or the result of cls(response)

Return type

RoleManagementPolicy

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>
class azure.mgmt.authorization.v2020_10_01_preview.operations.RoleManagementPolicyAssignmentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AuthorizationManagementClient’s role_management_policy_assignments attribute.

create(scope: str, role_management_policy_assignment_name: str, parameters: _models.RoleManagementPolicyAssignment, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleManagementPolicyAssignment[source]
create(scope: str, role_management_policy_assignment_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleManagementPolicyAssignment

Create a role management policy assignment.

Parameters

  • scope (str) – The scope of the role management policy assignment to upsert. Required.

  • role_management_policy_assignment_name (str) – The name of format {guid_guid} the role management policy assignment to upsert. Required.

  • parameters (RoleManagementPolicyAssignment or IO) – Parameters for the role management policy assignment. Is either a RoleManagementPolicyAssignment type or a IO type. Required.

Keyword Arguments

  • content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

RoleManagementPolicyAssignment or the result of cls(response)

Return type

RoleManagementPolicyAssignment

Raises

HttpResponseError –

delete(scope: str, role_management_policy_assignment_name: str, **kwargs: Any) → None[source]

Delete a role management policy assignment.

Parameters

  • scope (str) – The scope of the role management policy assignment to delete. Required.

  • role_management_policy_assignment_name (str) – The name of format {guid_guid} the role management policy assignment to delete. Required.

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

HttpResponseError –

get(scope: str, role_management_policy_assignment_name: str, **kwargs: Any) → azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleManagementPolicyAssignment[source]

Get the specified role management policy assignment for a resource scope.

Parameters

  • scope (str) – The scope of the role management policy. Required.

  • role_management_policy_assignment_name (str) – The name of format {guid_guid} the role management policy assignment to get. Required.

Keyword Arguments

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

Returns

RoleManagementPolicyAssignment or the result of cls(response)

Return type

RoleManagementPolicyAssignment

Raises

HttpResponseError –

list_for_scope(scope: str, **kwargs: Any) → Iterable[azure.mgmt.authorization.v2020_10_01_preview.models._models_py3.RoleManagementPolicyAssignment][source]

Gets role management assignment policies for a resource scope.

Parameters

scope (str) – The scope of the role management policy. Required.

Keyword Arguments

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

Returns

An iterator like instance of either RoleManagementPolicyAssignment or the result of cls(response)

Return type

ItemPaged[RoleManagementPolicyAssignment]

Raises

HttpResponseError –

models = <module 'azure.mgmt.authorization.v2020_10_01_preview.models' from '/mnt/vss/_work/1/s/sdk/authorization/azure-mgmt-authorization/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/authorization/v2020_10_01_preview/models/__init__.py'>