Policy.PolicySetDefinitionsList Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This operation retrieves a list of all the policy set 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 set 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 set definitions that at the given subscription. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set definitions whose type match the {value}. Possible policyType values are NotSpecified, BuiltIn and Custom. If $filter='category -eq {value}' is provided, the returned list only includes all policy set definitions whose category match the {value}.
public System.Threading.Tasks.Task PolicySetDefinitionsList (string subscriptionId, string Filter, int? Top, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicySetDefinitionListResult>,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.PolicySetDefinitionsList : string * string * Nullable<int> * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task<Microsoft.Azure.PowerShell.Cmdlets.Policy.Models.IPolicySetDefinitionListResult>, 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.TaskPublic Function PolicySetDefinitionsList (subscriptionId As String, Filter As String, Top As Nullable(Of Integer), onOk As Func(Of HttpResponseMessage, Task(Of IPolicySetDefinitionListResult), Task), onDefault As Func(Of HttpResponseMessage, Task(Of ICloudError), Task), eventListener As IEventListener, sender As ISendAsync) As TaskParameters
- 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 set definitions that at the given scope. If $filter='policyType -eq {value}' is provided, the returned list only includes all policy set 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 set definitions whose category match the {value}.
Maximum number of records to return. When the $top filter is not provided, it will return 500 records.
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
A Task that will be complete when handling of the response is completed.