azure.mgmt.authorization.v2022_04_01.operations module¶
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sdeny_assignmentsattribute.Get the specified deny assignment.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DenyAssignment or the result of cls(response)
- Return type
- Raises
Gets a deny assignment by ID.
- Parameters
deny_assignment_id (str) – The fully qualified deny assignment ID. For example, use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} for subscription level deny assignments, or /providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} for tenant level deny assignments. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
DenyAssignment or the result of cls(response)
- Return type
- Raises
Gets all deny assignments for the subscription.
- Parameters
filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName eq ‘{name}’ to search deny assignments by name at specified scope. Use $filter=principalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned. 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 DenyAssignment or the result of cls(response)
- Return type
- Raises
Gets deny assignments for 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.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type of the resource. Required.
resource_name (str) – The name of the resource to get deny assignments for. Required.
filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName eq ‘{name}’ to search deny assignments by name at specified scope. Use $filter=principalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned. 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 DenyAssignment or the result of cls(response)
- Return type
- Raises
Gets deny assignments for 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 deny assignments at or above the scope. Use $filter=denyAssignmentName eq ‘{name}’ to search deny assignments by name at specified scope. Use $filter=principalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned. 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 DenyAssignment or the result of cls(response)
- Return type
- Raises
Gets deny assignments for a scope.
- Parameters
scope (str) – The scope of the deny assignments. Required.
filter (str) – The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName eq ‘{name}’ to search deny assignments by name at specified scope. Use $filter=principalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq ‘{id}’ to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned. 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 DenyAssignment or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’spermissionsattribute.Gets all permissions the caller has for 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.
parent_resource_path (str) – The parent resource identity. Required.
resource_type (str) – The resource type of the resource. Required.
resource_name (str) – The name of the resource to get the permissions for. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Permission or the result of cls(response)
- Return type
- Raises
Gets all permissions the caller has for a resource group.
- Parameters
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either Permission or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’sprovider_operations_metadataattribute.Gets provider operations metadata for the specified resource provider.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
ProviderOperationsMetadata or the result of cls(response)
- Return type
- Raises
Gets provider operations metadata for all resource providers.
- Parameters
expand (str) – Specifies whether to expand the values. Default value is “resourceTypes”.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either ProviderOperationsMetadata or the result of cls(response)
- Return type
- Raises
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’srole_assignmentsattribute.-
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
- Returns
RoleAssignment or the result of cls(response)
- Return type
- Raises
-
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
- Returns
RoleAssignment or the result of cls(response)
- Return type
- Raises
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
- Raises
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
- Raises
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
- Raises
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
- Raises
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
- Raises
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
- Raises
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.
skip_token (str) – The skipToken to apply on the operation. Use $skipToken={skiptoken} to return paged role assignments following the skipToken passed. Only supported on provider level calls. 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
- Raises
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
- Raises
-
Bases:
objectWarning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
AuthorizationManagementClient’srole_definitionsattribute.-
create_or_update(scope: str, role_definition_id: str, role_definition: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.RoleDefinition Creates or updates a role definition.
- Parameters
scope (str) – The scope of the role definition. Required.
role_definition_id (str) – The ID of the role definition. Required.
role_definition (RoleDefinition or IO) – The values for the role definition. Is either a RoleDefinition type or a IO type. Required.
- Keyword Arguments
- Returns
RoleDefinition or the result of cls(response)
- Return type
- Raises
Deletes a role definition.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
RoleDefinition or None or the result of cls(response)
- Return type
- Raises
Get role definition by name (GUID).
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
RoleDefinition or the result of cls(response)
- Return type
- Raises
Gets a role definition by ID.
- Parameters
role_id (str) – The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions. Required.
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
RoleDefinition or the result of cls(response)
- Return type
- Raises
Get all role definitions that are applicable at scope and above.
- Parameters
- Keyword Arguments
cls (callable) – A custom type or function that will be passed the direct response
- Returns
An iterator like instance of either RoleDefinition or the result of cls(response)
- Return type
- Raises
-