/
PolicyAssignmentsListForResourceOptionalParams.yml
121 lines (121 loc) · 4.66 KB
/
PolicyAssignmentsListForResourceOptionalParams.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
### YamlMime:TSType
name: PolicyAssignmentsListForResourceOptionalParams
uid: '@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams'
package: '@azure/arm-policy'
summary: Optional parameters.
fullName: PolicyAssignmentsListForResourceOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
- name: filter
uid: '@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.filter'
package: '@azure/arm-policy'
summary: >-
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}.
fullName: filter
remarks: ''
isDeprecated: false
syntax:
content: 'filter?: string'
return:
description: ''
type: string
- name: top
uid: '@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.top'
package: '@azure/arm-policy'
summary: >-
Maximum number of records to return. When the $top filter is not provided,
it will return 500 records.
fullName: top
remarks: ''
isDeprecated: false
syntax:
content: 'top?: number'
return:
description: ''
type: number
inheritedProperties:
- name: abortSignal
uid: >-
@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.abortSignal
package: '@azure/arm-policy'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
inheritanceDescription: <b>Inherited From</b> coreClient.OperationOptions.abortSignal
- name: onResponse
uid: >-
@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.onResponse
package: '@azure/arm-policy'
summary: |-
A function to be called each time a response is received from the server
while performing the requested operation.
May be called multiple times.
fullName: onResponse
remarks: ''
isDeprecated: false
syntax:
content: 'onResponse?: RawResponseCallback'
return:
description: ''
type: <xref uid="@azure/core-client.RawResponseCallback" />
inheritanceDescription: <b>Inherited From</b> coreClient.OperationOptions.onResponse
- name: requestOptions
uid: >-
@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.requestOptions
package: '@azure/arm-policy'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
description: ''
type: <xref uid="@azure/core-client.OperationRequestOptions" />
inheritanceDescription: <b>Inherited From</b> coreClient.OperationOptions.requestOptions
- name: serializerOptions
uid: >-
@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.serializerOptions
package: '@azure/arm-policy'
summary: Options to override serialization/de-serialization behavior.
fullName: serializerOptions
remarks: ''
isDeprecated: false
syntax:
content: 'serializerOptions?: SerializerOptions'
return:
description: ''
type: <xref uid="@azure/core-client.SerializerOptions" />
inheritanceDescription: <b>Inherited From</b> coreClient.OperationOptions.serializerOptions
- name: tracingOptions
uid: >-
@azure/arm-policy.PolicyAssignmentsListForResourceOptionalParams.tracingOptions
package: '@azure/arm-policy'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: <b>Inherited From</b> coreClient.OperationOptions.tracingOptions
extends: <xref uid="@azure/core-client.OperationOptions" />