Struct azure_mgmt_resources::package_policy_2021_06::policy_assignments::Client

pub struct Client(_);

Implementations

impl Client

pub fn get( &self, scope: impl Into<String>, policy_assignment_name: impl Into<String> ) -> RequestBuilder

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

Arguments:

• 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}’
• policy_assignment_name: The name of the policy assignment to get.

pub fn create( &self, scope: impl Into<String>, policy_assignment_name: impl Into<String>, parameters: impl Into<PolicyAssignment> ) -> RequestBuilder

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.

Arguments:

• 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}’
• policy_assignment_name: The name of the policy assignment.
• parameters: Parameters for the policy assignment.

pub fn update( &self, scope: impl Into<String>, policy_assignment_name: impl Into<String>, parameters: impl Into<PolicyAssignmentUpdate> ) -> RequestBuilder

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.

Arguments:

• 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}’
• policy_assignment_name: The name of the policy assignment.
• parameters: Parameters for policy assignment patch request.

pub fn delete( &self, scope: impl Into<String>, policy_assignment_name: impl Into<String> ) -> RequestBuilder

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

Arguments:

• 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}’
• policy_assignment_name: The name of the policy assignment to delete.

pub fn list_for_resource_group( &self, resource_group_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder

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.

Arguments:

• resource_group_name: The name of the resource group that contains policy assignments.
• subscription_id: The ID of the target subscription.

pub fn list_for_resource( &self, resource_group_name: impl Into<String>, resource_provider_namespace: impl Into<String>, parent_resource_path: impl Into<String>, resource_type: impl Into<String>, resource_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder

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’).

Arguments:

• resource_group_name: The name of the resource group containing the resource.
• resource_provider_namespace: The namespace of the resource provider. For example, the namespace of a virtual machine is Microsoft.Compute (from Microsoft.Compute/virtualMachines)
• parent_resource_path: The parent resource path. Use empty string if there is none.
• resource_type: The resource type name. For example the type name of a web app is ‘sites’ (from Microsoft.Web/sites).
• resource_name: The name of the resource.
• subscription_id: The ID of the target subscription.

pub fn list_for_management_group( &self, management_group_id: impl Into<String> ) -> RequestBuilder

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.

Arguments:

• management_group_id: The ID of the management group.

pub fn list(&self, subscription_id: impl Into<String>) -> RequestBuilder

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

Arguments:

• subscription_id: The ID of the target subscription.

pub fn get_by_id( &self, policy_assignment_id: impl Into<String> ) -> RequestBuilder

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

Arguments:

• policy_assignment_id: The ID of the policy assignment to get. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’.

pub fn create_by_id( &self, policy_assignment_id: impl Into<String>, parameters: impl Into<PolicyAssignment> ) -> RequestBuilder

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

Arguments:

• policy_assignment_id: The ID of the policy assignment to create. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’.
• parameters: Parameters for policy assignment.

pub fn update_by_id( &self, policy_assignment_id: impl Into<String>, parameters: impl Into<PolicyAssignmentUpdate> ) -> RequestBuilder

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

Arguments:

• policy_assignment_id: The ID of the policy assignment to update. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’.
• parameters: Parameters for policy assignment patch request.

pub fn delete_by_id( &self, policy_assignment_id: impl Into<String> ) -> RequestBuilder

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

Arguments:

• policy_assignment_id: The ID of the policy assignment to delete. Use the format ‘{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}’.