azure.mgmt.resource.policy.v2022_06_01.operations module

Raises:

create_by_id(policy_assignment_id: str, parameters: _models.PolicyAssignment, *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment[source]

create_by_id(policy_assignment_id: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment

Creates or updates a policy assignment.

This operation creates or updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’.

Parameters:

policy_assignment_id (str) – The ID of the policy assignment to create. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Required.
parameters (PolicyAssignment or IO[bytes]) – Parameters for policy assignment. Is either a PolicyAssignment type or a IO[bytes] type. Required.

Returns:

PolicyAssignment or the result of cls(response)

Return type:

Raises:

delete(scope: str, policy_assignment_name: str, **kwargs: Any) → PolicyAssignment | None[source]

Deletes a policy assignment.

This operation deletes a policy assignment, given its name and the scope it was created in. The scope of a policy assignment is the part of its ID preceding ‘/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’.

Parameters:

scope (str) – The scope of the policy assignment. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.
policy_assignment_name (str) – The name of the policy assignment to delete. Required.

Returns:

PolicyAssignment or None or the result of cls(response)

Return type:

PolicyAssignment or None

Raises:

delete_by_id(policy_assignment_id: str, **kwargs: Any) → PolicyAssignment | None[source]

Deletes a policy assignment.

This operation deletes the policy with the given ID. Policy assignment IDs have this format: ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Valid formats for {scope} are: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’ (management group), ‘/subscriptions/{subscriptionId}’ (subscription), ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’ (resource group), or ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’ (resource).

Parameters:: policy_assignment_id (str) – The ID of the policy assignment to delete. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Required.
Returns:: PolicyAssignment or None or the result of cls(response)
Return type:: PolicyAssignment or None
Raises:: HttpResponseError –

get(scope: str, policy_assignment_name: str, **kwargs: Any) → PolicyAssignment[source]

Retrieves a policy assignment.

This operation retrieves a single policy assignment, given its name and the scope it was created at.

Parameters:

scope (str) – The scope of the policy assignment. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.
policy_assignment_name (str) – The name of the policy assignment to get. Required.

Returns:

PolicyAssignment or the result of cls(response)

Return type:

Raises:

get_by_id(policy_assignment_id: str, **kwargs: Any) → PolicyAssignment[source]

Retrieves the policy assignment with the given ID.

The operation retrieves the policy assignment with the given ID. Policy assignment IDs have this format: ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’.

Parameters:: policy_assignment_id (str) – The ID of the policy assignment to get. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Required.
Returns:: PolicyAssignment or the result of cls(response)
Return type:: PolicyAssignment
Raises:: HttpResponseError –

list(filter: str | None = None, top: int | None = None, **kwargs: Any) → Iterable[PolicyAssignment][source]

Retrieves all policy assignments that apply to a subscription.

This operation retrieves the list of all policy assignments associated with the given subscription that match the optional given $filter. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, the unfiltered list includes all policy assignments associated with the subscription, including those that apply directly or from management groups that contain the given subscription, as well as any applied to objects contained within the subscription. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the subscription, which is everything in the unfiltered list except those applied to objects contained within the subscription. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the subscription. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value}.

Parameters:

filter (str) – The filter to apply on the operation. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. Default value is None.
top (int) – Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns:

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

Return type:

Raises:

list_for_management_group(management_group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) → Iterable[PolicyAssignment][source]

Retrieves all policy assignments that apply to a management group.

This operation retrieves the list of all policy assignments applicable to the management group that match the given $filter. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter=atScope() is provided, the returned list includes all policy assignments that are assigned to the management group or the management group’s ancestors. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the management group. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the management group.

Parameters:

management_group_id (str) – The ID of the management group. Required.
filter (str) – The filter to apply on the operation. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. Default value is None.
top (int) – Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns:

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

Return type:

Raises:

list_for_resource(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) → Iterable[PolicyAssignment][source]

Retrieves all policy assignments that apply to a resource.

This operation retrieves the list of all policy assignments associated with the specified resource in the given resource group and subscription that match the optional given $filter. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource, including those that apply directly or from all containing scopes, as well as any applied to resources contained within the resource. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource, which is everything in the unfiltered list except those applied to resources contained within the resource. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource level. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource. Three parameters plus the resource name are used to identify a specific resource. If the resource is not part of a parent resource (the more common case), the parent resource path should not be provided (or provided as ‘’). For example a web app could be specified as ({resourceProviderNamespace} == ‘Microsoft.Web’, {parentResourcePath} == ‘’, {resourceType} == ‘sites’, {resourceName} == ‘MyWebApp’). If the resource is part of a parent resource, then all parameters should be provided. For example a virtual machine DNS name could be specified as ({resourceProviderNamespace} == ‘Microsoft.Compute’, {parentResourcePath} == ‘virtualMachines/MyVirtualMachine’, {resourceType} == ‘domainNames’, {resourceName} == ‘MyComputerName’). A convenient alternative to providing the namespace and type name separately is to provide both in the {resourceType} parameter, format: ({resourceProviderNamespace} == ‘’, {parentResourcePath} == ‘’, {resourceType} == ‘Microsoft.Web/sites’, {resourceName} == ‘MyWebApp’).

Parameters:

resource_group_name (str) – The name of the resource group containing the resource. Required.
resource_provider_namespace (str) – The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines). Required.
parent_resource_path (str) – The parent resource path. Use empty string if there is none. 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 name of the resource. Required.
filter (str) – The filter to apply on the operation. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. Default value is None.
top (int) – Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns:

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

Return type:

Raises:

list_for_resource_group(resource_group_name: str, filter: str | None = None, top: int | None = None, **kwargs: Any) → Iterable[PolicyAssignment][source]

Retrieves all policy assignments that apply to a resource group.

This operation retrieves the list of all policy assignments associated with the given resource group in the given subscription that match the optional given $filter. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, the unfiltered list includes all policy assignments associated with the resource group, including those that apply directly or apply from containing scopes, as well as any applied to resources contained within the resource group. If $filter=atScope() is provided, the returned list includes all policy assignments that apply to the resource group, which is everything in the unfiltered list except those applied to resources contained within the resource group. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the resource group. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value} that apply to the resource group.

Parameters:

resource_group_name (str) – The name of the resource group that contains policy assignments. Required.
filter (str) – The filter to apply on the operation. Valid values for $filter are: ‘atScope()’, ‘atExactScope()’ or ‘policyDefinitionId eq ‘{value}’’. If $filter is not provided, no filtering is performed. If $filter=atScope() is provided, the returned list only includes all policy assignments that apply to the scope, which is everything in the unfiltered list except those applied to sub scopes contained within the given scope. If $filter=atExactScope() is provided, the returned list only includes all policy assignments that at the given scope. If $filter=policyDefinitionId eq ‘{value}’ is provided, the returned list includes all policy assignments of the policy definition whose id is {value}. Default value is None.
top (int) – Maximum number of records to return. When the $top filter is not provided, it will return 500 records. Default value is None.

Returns:

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

Return type:

Raises:

update(scope: str, policy_assignment_name: str, parameters: _models.PolicyAssignmentUpdate, *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment[source]

update(scope: str, policy_assignment_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment

Updates a policy assignment.

This operation updates a policy assignment with the given scope and name. Policy assignments apply to all resources contained within their scope. For example, when you assign a policy at resource group scope, that policy applies to all resources in the group.

Parameters:

scope (str) – The scope of the policy assignment. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’. Required.
policy_assignment_name (str) – The name of the policy assignment. Required.
parameters (PolicyAssignmentUpdate or IO[bytes]) – Parameters for policy assignment patch request. Is either a PolicyAssignmentUpdate type or a IO[bytes] type. Required.

Returns:

PolicyAssignment or the result of cls(response)

Return type:

Raises:

update_by_id(policy_assignment_id: str, parameters: _models.PolicyAssignmentUpdate, *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment[source]

update_by_id(policy_assignment_id: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.PolicyAssignment

Updates a policy assignment.

This operation updates the policy assignment with the given ID. Policy assignments made on a scope apply to all resources contained in that scope. For example, when you assign a policy to a resource group that policy applies to all resources in the group. Policy assignment IDs have this format: ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Valid scopes are: management group (format: ‘/providers/Microsoft.Management/managementGroups/{managementGroup}’), subscription (format: ‘/subscriptions/{subscriptionId}’), resource group (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}’, or resource (format: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}’.

Parameters:

policy_assignment_id (str) – The ID of the policy assignment to update. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’. Required.
parameters (PolicyAssignmentUpdate or IO[bytes]) – Parameters for policy assignment patch request. Is either a PolicyAssignmentUpdate type or a IO[bytes] type. Required.

Returns:

PolicyAssignment or the result of cls(response)

Return type:

Raises: