-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.yml
208 lines (206 loc) · 9.01 KB
/
azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
### YamlMime:PythonClass
uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations
name: PolicySetDefinitionsOperations
fullName: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations
module: azure.mgmt.resource.policy.v2017_06_01_preview.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
\ you should access the following operations through\n>\n> <xref:azure.mgmt.resource.policy.v2017_06_01_preview.PolicyClient>'s\n\
>\n> <xref:policy_set_definitions> attribute.\n>"
constructor:
syntax: PolicySetDefinitionsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.create_or_update
name: create_or_update
summary: Creates or updates a policy set definition.
signature: 'create_or_update(policy_set_definition_name: str, parameters: _models.PolicySetDefinition,
*, content_type: str = ''application/json'', **kwargs: Any) -> _models.PolicySetDefinition'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to create. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'The policy set definition properties. Is either a PolicySetDefinition
type
or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
- <xref:typing.IO>[<xref:bytes>]
return:
description: PolicySetDefinition or the result of cls(response)
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.create_or_update_at_management_group
name: create_or_update_at_management_group
summary: Creates or updates a policy set definition at management group level.
signature: 'create_or_update_at_management_group(policy_set_definition_name: str,
management_group_id: str, parameters: _models.PolicySetDefinition, *, content_type:
str = ''application/json'', **kwargs: Any) -> _models.PolicySetDefinition'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to create. Required.
isRequired: true
types:
- <xref:str>
- name: management_group_id
description: The ID of the management group. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'The policy set definition properties. Is either a PolicySetDefinition
type
or a IO[bytes] type. Required.'
isRequired: true
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
- <xref:typing.IO>[<xref:bytes>]
return:
description: PolicySetDefinition or the result of cls(response)
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.delete
name: delete
summary: Deletes a policy set definition.
signature: 'delete(policy_set_definition_name: str, **kwargs: Any) -> None'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to delete. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.delete_at_management_group
name: delete_at_management_group
summary: Deletes a policy set definition at management group level.
signature: 'delete_at_management_group(policy_set_definition_name: str, management_group_id:
str, **kwargs: Any) -> None'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to delete. Required.
isRequired: true
types:
- <xref:str>
- name: management_group_id
description: The ID of the management group. Required.
isRequired: true
types:
- <xref:str>
return:
description: None or the result of cls(response)
types:
- <xref:None>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.get
name: get
summary: Gets the policy set definition.
signature: 'get(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to get. Required.
isRequired: true
types:
- <xref:str>
return:
description: PolicySetDefinition or the result of cls(response)
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.get_at_management_group
name: get_at_management_group
summary: Gets the policy set definition at management group level.
signature: 'get_at_management_group(policy_set_definition_name: str, management_group_id:
str, **kwargs: Any) -> PolicySetDefinition'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to get. Required.
isRequired: true
types:
- <xref:str>
- name: management_group_id
description: The ID of the management group. Required.
isRequired: true
types:
- <xref:str>
return:
description: PolicySetDefinition or the result of cls(response)
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.get_built_in
name: get_built_in
summary: Gets the built in policy set definition.
signature: 'get_built_in(policy_set_definition_name: str, **kwargs: Any) -> PolicySetDefinition'
parameters:
- name: policy_set_definition_name
description: The name of the policy set definition to get. Required.
isRequired: true
types:
- <xref:str>
return:
description: PolicySetDefinition or the result of cls(response)
types:
- <xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.list
name: list
summary: Gets all the policy set definitions for a subscription.
signature: 'list(**kwargs: Any) -> Iterable[PolicySetDefinition]'
return:
description: An iterator like instance of either PolicySetDefinition or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.list_built_in
name: list_built_in
summary: Gets all the built in policy set definitions.
signature: 'list_built_in(**kwargs: Any) -> Iterable[PolicySetDefinition]'
return:
description: An iterator like instance of either PolicySetDefinition or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.list_by_management_group
name: list_by_management_group
summary: Gets all the policy set definitions for a subscription at management group.
signature: 'list_by_management_group(management_group_id: str, **kwargs: Any) ->
Iterable[PolicySetDefinition]'
parameters:
- name: management_group_id
description: The ID of the management group. Required.
isRequired: true
types:
- <xref:str>
return:
description: An iterator like instance of either PolicySetDefinition or the result
of cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.resource.policy.v2017_06_01_preview.models.PolicySetDefinition>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.resource.policy.v2017_06_01_preview.operations.PolicySetDefinitionsOperations.models
name: models
signature: models = <module 'azure.mgmt.resource.policy.v2017_06_01_preview.models'
from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\policy\\v2017_06_01_preview\\models\\__init__.py'>