Policy.PolicyDefinitionsList Method

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.Policy

Assembly:

Az.Policy.private.dll

This operation retrieves a list of all the policy definitions in a given subscription that match the optional given $filter. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, the unfiltered list includes all policy definitions associated with the subscription, including those that apply directly or from management groups that contain the given subscription. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.

public System.Threading.Tasks.Task PolicyDefinitionsList (string subscriptionId, string Filter, int? Top, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyDefinitionListResult>,System.Threading.Tasks.Task> onOk, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.ICloudError>,System.Threading.Tasks.Task> onDefault, Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.ISendAsync sender);

member this.PolicyDefinitionsList : string * string * Nullable<int> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicyDefinitionListResult>, System.Threading.Tasks.Task> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.ICloudError>, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.ISendAsync -> System.Threading.Tasks.Task

Public Function PolicyDefinitionsList (subscriptionId As String, Filter As String, Top As Nullable(Of Integer), onOk As Func(Of HttpResponseMessage, Task(Of IPolicyDefinitionListResult), Task), onDefault As Func(Of HttpResponseMessage, Task(Of ICloudError), Task), eventListener As IEventListener, sender As ISendAsync) As Task

Parameters

subscriptionId

String

The ID of the target subscription. The value must be an UUID.

Filter

String

The filter to apply on the operation. Valid values for $filter are: 'atExactScope()', 'policyType -eq {value}' or 'category eq '{value}''. If $filter is not provided, no filtering is performed. If $filter=atExactScope() is provided, the returned list only includes all policy definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn, Custom, and Static. If $filter='category -eq {value}' is provided, the returned list only includes all policy definitions whose category match the {value}.

Top

Nullable<Int32>

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

onOk

Func<HttpResponseMessage,Task<IPolicyDefinitionListResult>,Task>

a delegate that is called when the remote service returns 200 (OK).

onDefault

Func<HttpResponseMessage,Task<ICloudError>,Task>

a delegate that is called when the remote service returns default (any response code not handled elsewhere).

eventListener

IEventListener

an IEventListener instance that will receive events.

sender

ISendAsync

an instance of an Microsoft.Azure.PowerShell.Cmdlets.Policy.Runtime.ISendAsync pipeline to use to make the request.

Returns

Task

A Task that will be complete when handling of the response is completed.