-
Notifications
You must be signed in to change notification settings - Fork 246
/
azure.mgmt.securitydevops.operations.GitHubOwnerOperations.yml
236 lines (214 loc) · 7.71 KB
/
azure.mgmt.securitydevops.operations.GitHubOwnerOperations.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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
### YamlMime:PythonClass
uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations
name: GitHubOwnerOperations
fullName: azure.mgmt.securitydevops.operations.GitHubOwnerOperations
module: azure.mgmt.securitydevops.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.securitydevops.MicrosoftSecurityDevOps>'s\n\
>\n> <xref:git_hub_owner> attribute.\n>"
constructor:
syntax: GitHubOwnerOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations.begin_create_or_update
name: begin_create_or_update
summary: 'Create or update a monitored GitHub owner.
Create or update a monitored GitHub owner.'
signature: 'begin_create_or_update(resource_group_name: str, git_hub_connector_name:
str, git_hub_owner_name: str, git_hub_owner: _models.GitHubOwner, *, content_type:
str = ''application/json'', **kwargs: Any) -> LROPoller[_models.GitHubOwner]'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: git_hub_connector_name
description: Name of the GitHub Connector. Required.
isRequired: true
types:
- <xref:str>
- name: git_hub_owner_name
description: Name of the GitHub Owner. Required.
isRequired: true
types:
- <xref:str>
- name: git_hub_owner
description: Github owner. Is either a model type or a IO type. Required.
isRequired: true
types:
- <xref:azure.mgmt.securitydevops.models.GitHubOwner>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- name: continuation_token
description: A continuation token to restart a poller from a saved state.
types:
- <xref:str>
- name: polling
description: 'By default, your polling method will be ARMPolling. Pass in False
for this
operation to not poll, or pass in your own initialized polling object for a
personal polling
strategy.'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
description: 'Default waiting time between two polls for LRO operations if no
Retry-After header is present.'
types:
- <xref:int>
return:
description: 'An instance of LROPoller that returns either GitHubOwner or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.securitydevops.models.GitHubOwner>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations.begin_update
name: begin_update
summary: 'Update a monitored GitHub repository.
Update a monitored GitHub repository.'
signature: 'begin_update(resource_group_name: str, git_hub_connector_name: str,
git_hub_owner_name: str, git_hub_owner: _models.GitHubOwner | None = None, *,
content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.GitHubOwner]'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: git_hub_connector_name
description: Name of the GitHub Connector. Required.
isRequired: true
types:
- <xref:str>
- name: git_hub_owner_name
description: Name of the GitHub Owner. Required.
isRequired: true
types:
- <xref:str>
- name: git_hub_owner
description: Github owner. Is either a model type or a IO type. Default value
is None.
isRequired: true
types:
- <xref:azure.mgmt.securitydevops.models.GitHubOwner>
- <xref:typing.IO>
keywordOnlyParameters:
- name: content_type
description: 'Body Parameter content-type. Known values are: ''application/json''.
Default value is None.'
types:
- <xref:str>
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
- name: continuation_token
description: A continuation token to restart a poller from a saved state.
types:
- <xref:str>
- name: polling
description: 'By default, your polling method will be ARMPolling. Pass in False
for this
operation to not poll, or pass in your own initialized polling object for a
personal polling
strategy.'
types:
- <xref:bool>
- <xref:azure.core.polling.PollingMethod>
- name: polling_interval
description: 'Default waiting time between two polls for LRO operations if no
Retry-After header is present.'
types:
- <xref:int>
return:
description: 'An instance of LROPoller that returns either GitHubOwner or the
result of
cls(response)'
types:
- <xref:azure.core.polling.LROPoller>[<xref:azure.mgmt.securitydevops.models.GitHubOwner>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations.get
name: get
summary: 'Returns a monitored GitHub repository.
Returns a monitored GitHub repository.'
signature: 'get(resource_group_name: str, git_hub_connector_name: str, git_hub_owner_name:
str, **kwargs: Any) -> GitHubOwner'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: git_hub_connector_name
description: Name of the GitHub Connector. Required.
isRequired: true
types:
- <xref:str>
- name: git_hub_owner_name
description: Name of the GitHub Owner. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: GitHubOwner or the result of cls(response)
types:
- <xref:azure.mgmt.securitydevops.models.GitHubOwner>
exceptions:
- type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations.list
name: list
summary: 'Returns a list of monitored GitHub owners.
Returns a list of monitored GitHub owners.'
signature: 'list(resource_group_name: str, git_hub_connector_name: str, **kwargs:
Any) -> Iterable[GitHubOwner]'
parameters:
- name: resource_group_name
description: 'The name of the resource group. The name is case insensitive.
Required.'
isRequired: true
types:
- <xref:str>
- name: git_hub_connector_name
description: Name of the GitHub Connector. Required.
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: cls
description: A custom type or function that will be passed the direct response
types:
- <xref:callable>
return:
description: An iterator like instance of either GitHubOwner or the result of
cls(response)
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.securitydevops.models.GitHubOwner>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.securitydevops.operations.GitHubOwnerOperations.models
name: models
signature: models = <module 'azure.mgmt.securitydevops.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\securitydevops\\models\\__init__.py'>