PolicyAssignmentsClient Interface

Package:

com.azure.resourcemanager.resources.fluent

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.45.0

Implements

InnerSupportsDelete<PolicyAssignmentInner> InnerSupportsListing<PolicyAssignmentInner>

public interface PolicyAssignmentsClient
extends InnerSupportsListing<PolicyAssignmentInner>, InnerSupportsDelete<PolicyAssignmentInner>

An instance of this class provides access to all the operations defined in PolicyAssignmentsClient.

Method Summary

Modifier and Type	Method and Description
abstract PolicyAssignmentInner	create(String scope, String policyAssignmentName, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract Mono<PolicyAssignmentInner>	createAsync(String scope, String policyAssignmentName, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract PolicyAssignmentInner	createById(String policyAssignmentId, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract Mono<PolicyAssignmentInner>	createByIdAsync(String policyAssignmentId, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract Response<PolicyAssignmentInner>	createByIdWithResponse(String policyAssignmentId, PolicyAssignmentInner parameters, Context context) Creates or updates a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	createByIdWithResponseAsync(String policyAssignmentId, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract Response<PolicyAssignmentInner>	createWithResponse(String scope, String policyAssignmentName, PolicyAssignmentInner parameters, Context context) Creates or updates a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	createWithResponseAsync(String scope, String policyAssignmentName, PolicyAssignmentInner parameters) Creates or updates a policy assignment.
abstract PolicyAssignmentInner	delete(String scope, String policyAssignmentName) Deletes a policy assignment.
abstract Mono<PolicyAssignmentInner>	deleteAsync(String scope, String policyAssignmentName) Deletes a policy assignment.
abstract PolicyAssignmentInner	deleteById(String policyAssignmentId) Deletes a policy assignment.
abstract Mono<PolicyAssignmentInner>	deleteByIdAsync(String policyAssignmentId) Deletes a policy assignment.
abstract Response<PolicyAssignmentInner>	deleteByIdWithResponse(String policyAssignmentId, Context context) Deletes a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	deleteByIdWithResponseAsync(String policyAssignmentId) Deletes a policy assignment.
abstract Response<PolicyAssignmentInner>	deleteWithResponse(String scope, String policyAssignmentName, Context context) Deletes a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	deleteWithResponseAsync(String scope, String policyAssignmentName) Deletes a policy assignment.
abstract PolicyAssignmentInner	get(String scope, String policyAssignmentName) Retrieves a policy assignment.
abstract Mono<PolicyAssignmentInner>	getAsync(String scope, String policyAssignmentName) Retrieves a policy assignment.
abstract PolicyAssignmentInner	getById(String policyAssignmentId) Retrieves the policy assignment with the given ID.
abstract Mono<PolicyAssignmentInner>	getByIdAsync(String policyAssignmentId) Retrieves the policy assignment with the given ID.
abstract Response<PolicyAssignmentInner>	getByIdWithResponse(String policyAssignmentId, Context context) Retrieves the policy assignment with the given ID.
abstract Mono<Response<PolicyAssignmentInner>>	getByIdWithResponseAsync(String policyAssignmentId) Retrieves the policy assignment with the given ID.
abstract Response<PolicyAssignmentInner>	getWithResponse(String scope, String policyAssignmentName, Context context) Retrieves a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	getWithResponseAsync(String scope, String policyAssignmentName) Retrieves a policy assignment.
abstract PagedIterable<PolicyAssignmentInner>	list() Retrieves all policy assignments that apply to a subscription.
abstract PagedIterable<PolicyAssignmentInner>	list(String filter, Integer top, Context context) Retrieves all policy assignments that apply to a subscription.
abstract PagedFlux<PolicyAssignmentInner>	listAsync() Retrieves all policy assignments that apply to a subscription.
abstract PagedFlux<PolicyAssignmentInner>	listAsync(String filter, Integer top) Retrieves all policy assignments that apply to a subscription.
abstract PagedIterable<PolicyAssignmentInner>	listByResourceGroup(String resourceGroupName) Retrieves all policy assignments that apply to a resource group.
abstract PagedIterable<PolicyAssignmentInner>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) Retrieves all policy assignments that apply to a resource group.
abstract PagedFlux<PolicyAssignmentInner>	listByResourceGroupAsync(String resourceGroupName) Retrieves all policy assignments that apply to a resource group.
abstract PagedFlux<PolicyAssignmentInner>	listByResourceGroupAsync(String resourceGroupName, String filter, Integer top) Retrieves all policy assignments that apply to a resource group.
abstract PagedIterable<PolicyAssignmentInner>	listForManagementGroup(String managementGroupId) Retrieves all policy assignments that apply to a management group.
abstract PagedIterable<PolicyAssignmentInner>	listForManagementGroup(String managementGroupId, String filter, Integer top, Context context) Retrieves all policy assignments that apply to a management group.
abstract PagedFlux<PolicyAssignmentInner>	listForManagementGroupAsync(String managementGroupId) Retrieves all policy assignments that apply to a management group.
abstract PagedFlux<PolicyAssignmentInner>	listForManagementGroupAsync(String managementGroupId, String filter, Integer top) Retrieves all policy assignments that apply to a management group.
abstract PagedIterable<PolicyAssignmentInner>	listForResource(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName) Retrieves all policy assignments that apply to a resource.
abstract PagedIterable<PolicyAssignmentInner>	listForResource(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String filter, Integer top, Context context) Retrieves all policy assignments that apply to a resource.
abstract PagedFlux<PolicyAssignmentInner>	listForResourceAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName) Retrieves all policy assignments that apply to a resource.
abstract PagedFlux<PolicyAssignmentInner>	listForResourceAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String filter, Integer top) Retrieves all policy assignments that apply to a resource.
abstract PolicyAssignmentInner	update(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters) Updates a policy assignment.
abstract Mono<PolicyAssignmentInner>	updateAsync(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters) Updates a policy assignment.
abstract PolicyAssignmentInner	updateById(String policyAssignmentId, PolicyAssignmentUpdate parameters) Updates a policy assignment.
abstract Mono<PolicyAssignmentInner>	updateByIdAsync(String policyAssignmentId, PolicyAssignmentUpdate parameters) Updates a policy assignment.
abstract Response<PolicyAssignmentInner>	updateByIdWithResponse(String policyAssignmentId, PolicyAssignmentUpdate parameters, Context context) Updates a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	updateByIdWithResponseAsync(String policyAssignmentId, PolicyAssignmentUpdate parameters) Updates a policy assignment.
abstract Response<PolicyAssignmentInner>	updateWithResponse(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters, Context context) Updates a policy assignment.
abstract Mono<Response<PolicyAssignmentInner>>	updateWithResponseAsync(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters) Updates a policy assignment.

Method Details

create

public abstract PolicyAssignmentInner create(String scope, String policyAssignmentName, PolicyAssignmentInner parameters)

Creates or updates a policy assignment. This operation creates or 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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for the policy assignment.

Returns:

the policy assignment.

createAsync

public abstract Mono createAsync(String scope, String policyAssignmentName, PolicyAssignmentInner parameters)

Creates or updates a policy assignment. This operation creates or 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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for the policy assignment.

Returns:

the policy assignment on successful completion of Mono.

createById

public abstract PolicyAssignmentInner createById(String policyAssignmentId, PolicyAssignmentInner parameters)

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:

policyAssignmentId - The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment.

Returns:

the policy assignment.

createByIdAsync

public abstract Mono createByIdAsync(String policyAssignmentId, PolicyAssignmentInner parameters)

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:

policyAssignmentId - The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment.

Returns:

the policy assignment on successful completion of Mono.

createByIdWithResponse

public abstract Response createByIdWithResponse(String policyAssignmentId, PolicyAssignmentInner parameters, Context context)

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:

policyAssignmentId - The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

createByIdWithResponseAsync

public abstract Mono> createByIdWithResponseAsync(String policyAssignmentId, PolicyAssignmentInner parameters)

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:

policyAssignmentId - The ID of the policy assignment to create. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

createWithResponse

public abstract Response createWithResponse(String scope, String policyAssignmentName, PolicyAssignmentInner parameters, Context context)

Creates or updates a policy assignment. This operation creates or 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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for the policy assignment.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

createWithResponseAsync

public abstract Mono> createWithResponseAsync(String scope, String policyAssignmentName, PolicyAssignmentInner parameters)

Creates or updates a policy assignment. This operation creates or 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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for the policy assignment.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

delete

public abstract PolicyAssignmentInner delete(String scope, String policyAssignmentName)

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 - 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}'.

policyAssignmentName - The name of the policy assignment to delete.

Returns:

the policy assignment.

deleteAsync

public abstract Mono deleteAsync(String scope, String policyAssignmentName)

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 - 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}'.

policyAssignmentName - The name of the policy assignment to delete.

Returns:

the policy assignment on successful completion of Mono.

deleteById

public abstract PolicyAssignmentInner deleteById(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment.

deleteByIdAsync

public abstract Mono deleteByIdAsync(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment on successful completion of Mono.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String policyAssignmentId, Context context)

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:

policyAssignmentId - The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

deleteByIdWithResponseAsync

public abstract Mono> deleteByIdWithResponseAsync(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to delete. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

deleteWithResponse

public abstract Response deleteWithResponse(String scope, String policyAssignmentName, Context context)

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 - 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}'.

policyAssignmentName - The name of the policy assignment to delete.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

deleteWithResponseAsync

public abstract Mono> deleteWithResponseAsync(String scope, String policyAssignmentName)

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 - 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}'.

policyAssignmentName - The name of the policy assignment to delete.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

get

public abstract PolicyAssignmentInner get(String scope, String policyAssignmentName)

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

Parameters:

scope - 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}'.

policyAssignmentName - The name of the policy assignment to get.

Returns:

the policy assignment.

getAsync

public abstract Mono getAsync(String scope, String policyAssignmentName)

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

Parameters:

scope - 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}'.

policyAssignmentName - The name of the policy assignment to get.

Returns:

the policy assignment on successful completion of Mono.

getById

public abstract PolicyAssignmentInner getById(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment.

getByIdAsync

public abstract Mono getByIdAsync(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment on successful completion of Mono.

getByIdWithResponse

public abstract Response getByIdWithResponse(String policyAssignmentId, Context context)

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:

policyAssignmentId - The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

getByIdWithResponseAsync

public abstract Mono> getByIdWithResponseAsync(String policyAssignmentId)

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:

policyAssignmentId - The ID of the policy assignment to get. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

getWithResponse

public abstract Response getWithResponse(String scope, String policyAssignmentName, Context context)

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

Parameters:

scope - 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}'.

policyAssignmentName - The name of the policy assignment to get.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

getWithResponseAsync

public abstract Mono> getWithResponseAsync(String scope, String policyAssignmentName)

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

Parameters:

scope - 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}'.

policyAssignmentName - The name of the policy assignment to get.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

list

public abstract PagedIterable list()

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}.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(String filter, Integer top, Context context)

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 - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

context - The context to associate with this operation.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listAsync

public abstract PagedFlux listAsync()

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}.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listAsync

public abstract PagedFlux listAsync(String filter, Integer top)

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 - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

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:

resourceGroupName - The name of the resource group that contains policy assignments.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

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:

resourceGroupName - The name of the resource group that contains policy assignments.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

context - The context to associate with this operation.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listByResourceGroupAsync

public abstract PagedFlux listByResourceGroupAsync(String resourceGroupName)

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:

resourceGroupName - The name of the resource group that contains policy assignments.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listByResourceGroupAsync

public abstract PagedFlux listByResourceGroupAsync(String resourceGroupName, String filter, Integer top)

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:

resourceGroupName - The name of the resource group that contains policy assignments.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listForManagementGroup

public abstract PagedIterable listForManagementGroup(String managementGroupId)

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:

managementGroupId - The ID of the management group.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listForManagementGroup

public abstract PagedIterable listForManagementGroup(String managementGroupId, String filter, Integer top, Context context)

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:

managementGroupId - The ID of the management group.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

context - The context to associate with this operation.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listForManagementGroupAsync

public abstract PagedFlux listForManagementGroupAsync(String managementGroupId)

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:

managementGroupId - The ID of the management group.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listForManagementGroupAsync

public abstract PagedFlux listForManagementGroupAsync(String managementGroupId, String filter, Integer top)

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:

managementGroupId - The ID of the management group.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listForResource

public abstract PagedIterable listForResource(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName)

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:

resourceGroupName - The name of the resource group containing the resource.

resourceProviderNamespace - The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines).

parentResourcePath - The parent resource path. Use empty string if there is none.

resourceType - The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).

resourceName - The name of the resource.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listForResource

public abstract PagedIterable listForResource(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String filter, Integer top, Context context)

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:

resourceGroupName - The name of the resource group containing the resource.

resourceProviderNamespace - The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines).

parentResourcePath - The parent resource path. Use empty string if there is none.

resourceType - The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).

resourceName - The name of the resource.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

context - The context to associate with this operation.

Returns:

list of policy assignments as paginated response with PagedIterable<T>.

listForResourceAsync

public abstract PagedFlux listForResourceAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName)

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:

resourceGroupName - The name of the resource group containing the resource.

resourceProviderNamespace - The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines).

parentResourcePath - The parent resource path. Use empty string if there is none.

resourceType - The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).

resourceName - The name of the resource.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

listForResourceAsync

public abstract PagedFlux listForResourceAsync(String resourceGroupName, String resourceProviderNamespace, String parentResourcePath, String resourceType, String resourceName, String filter, Integer top)

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:

resourceGroupName - The name of the resource group containing the resource.

resourceProviderNamespace - The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines).

parentResourcePath - The parent resource path. Use empty string if there is none.

resourceType - The resource type name. For example the type name of a web app is 'sites' (from Microsoft.Web/sites).

resourceName - The name of the resource.

filter - 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}.

top - Maximum number of records to return. When the $top filter is not provided, it will return 500 records.

Returns:

list of policy assignments as paginated response with PagedFlux<T>.

update

public abstract PolicyAssignmentInner update(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters)

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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment.

updateAsync

public abstract Mono updateAsync(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters)

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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment on successful completion of Mono.

updateById

public abstract PolicyAssignmentInner updateById(String policyAssignmentId, PolicyAssignmentUpdate parameters)

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:

policyAssignmentId - The ID of the policy assignment to update. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment.

updateByIdAsync

public abstract Mono updateByIdAsync(String policyAssignmentId, PolicyAssignmentUpdate parameters)

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:

policyAssignmentId - The ID of the policy assignment to update. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment on successful completion of Mono.

updateByIdWithResponse

public abstract Response updateByIdWithResponse(String policyAssignmentId, PolicyAssignmentUpdate parameters, Context context)

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:

policyAssignmentId - The ID of the policy assignment to update. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment patch request.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

updateByIdWithResponseAsync

public abstract Mono> updateByIdWithResponseAsync(String policyAssignmentId, PolicyAssignmentUpdate parameters)

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:

policyAssignmentId - The ID of the policy assignment to update. Use the format '{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}'.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.

updateWithResponse

public abstract Response updateWithResponse(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters, Context context)

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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for policy assignment patch request.

context - The context to associate with this operation.

Returns:

the policy assignment along with Response<T>.

updateWithResponseAsync

public abstract Mono> updateWithResponseAsync(String scope, String policyAssignmentName, PolicyAssignmentUpdate parameters)

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 - 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}'.

policyAssignmentName - The name of the policy assignment.

parameters - Parameters for policy assignment patch request.

Returns:

the policy assignment along with Response<T> on successful completion of Mono.