-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.yml
194 lines (187 loc) · 7.6 KB
/
azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.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
### YamlMime:PythonClass
uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations
name: PrivateEndpointConnectionsOperations
fullName: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations
module: azure.mgmt.eventhub.v2021_01_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.eventhub.v2021_01_01_preview.EventHubManagementClient>'s\n\
>\n> <xref:private_endpoint_connections> attribute.\n>"
constructor:
syntax: PrivateEndpointConnectionsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.begin_delete
name: begin_delete
summary: 'Deletes an existing namespace. This operation also removes all associated
resources under the
namespace.'
signature: 'begin_delete(resource_group_name: str, namespace_name: str, private_endpoint_connection_name:
str, **kwargs: Any) -> LROPoller[None]'
parameters:
- name: resource_group_name
description: Name of the resource group within the azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The Namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: private_endpoint_connection_name
description: The PrivateEndpointConnection name. 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>
- 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 None or the result of
cls(response)
types:
- <xref:azure.core.polling.LROPoller>[<xref:None>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639389.aspx)\
\ \n"
- uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.create_or_update
name: create_or_update
summary: Creates or updates PrivateEndpointConnections of service namespace.
signature: 'create_or_update(resource_group_name: str, namespace_name: str, private_endpoint_connection_name:
str, parameters: _models.PrivateEndpointConnection, *, content_type: str = ''application/json'',
**kwargs: Any) -> _models.PrivateEndpointConnection'
parameters:
- name: resource_group_name
description: Name of the resource group within the azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The Namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: private_endpoint_connection_name
description: The PrivateEndpointConnection name. Required.
isRequired: true
types:
- <xref:str>
- name: parameters
description: 'Parameters supplied to update Status of PrivateEndPoint Connection
to
namespace resource. Is either a PrivateEndpointConnection type or a IO type.
Required.'
isRequired: true
types:
- <xref:azure.mgmt.eventhub.v2021_01_01_preview.models.PrivateEndpointConnection>
- <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>
return:
description: PrivateEndpointConnection or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2021_01_01_preview.models.PrivateEndpointConnection>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639408.aspx)\
\ \n"
- uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.get
name: get
summary: Gets a description for the specified Private Endpoint Connection name.
signature: 'get(resource_group_name: str, namespace_name: str, private_endpoint_connection_name:
str, **kwargs: Any) -> PrivateEndpointConnection'
parameters:
- name: resource_group_name
description: Name of the resource group within the azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The Namespace name. Required.
isRequired: true
types:
- <xref:str>
- name: private_endpoint_connection_name
description: The PrivateEndpointConnection name. 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: PrivateEndpointConnection or the result of cls(response)
types:
- <xref:azure.mgmt.eventhub.v2021_01_01_preview.models.PrivateEndpointConnection>
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639379.aspx)\
\ \n"
- uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.list
name: list
summary: Gets the available PrivateEndpointConnections within a namespace.
signature: 'list(resource_group_name: str, namespace_name: str, **kwargs: Any) ->
Iterable[PrivateEndpointConnection]'
parameters:
- name: resource_group_name
description: Name of the resource group within the azure subscription. Required.
isRequired: true
types:
- <xref:str>
- name: namespace_name
description: The Namespace name. 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 PrivateEndpointConnection or
the result of
cls(response)'
types:
- <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.eventhub.v2021_01_01_preview.models.PrivateEndpointConnection>]
exceptions:
- type: azure.core.exceptions.HttpResponseError
seeAlsoContent: "\n\n * [https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx](https://msdn.microsoft.com/en-us/library/azure/mt639412.aspx)\
\ \n"
attributes:
- uid: azure.mgmt.eventhub.v2021_01_01_preview.operations.PrivateEndpointConnectionsOperations.models
name: models
signature: models = <module 'azure.mgmt.eventhub.v2021_01_01_preview.models' from
'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\eventhub\\v2021_01_01_preview\\models\\__init__.py'>