PrivateEndpointConnectionsOperations Class
PrivateEndpointConnectionsOperations async operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectPrivateEndpointConnectionsOperations
Constructor
PrivateEndpointConnectionsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| delete |
Disconnects the private endpoint connection and deletes it from the search service. |
| get |
Gets the details of the private endpoint connection to the search service in the given resource group. |
| list_by_service |
Gets a list of all private endpoint connections in the given service. |
| update |
Updates a Private Endpoint connection to the search service in the given resource group. |
delete
Disconnects the private endpoint connection and deletes it from the search service.
async delete(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> Optional[azure.mgmt.search.models._models_py3.PrivateEndpointConnection]Parameters
- resource_group_name
- str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search_service_name
- str
The name of the Azure Cognitive Search service associated with the specified resource group.
- private_endpoint_connection_name
- str
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- search_management_request_options
- SearchManagementRequestOptions
Parameter group.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateEndpointConnection, or the result of cls(response)
Return type
Exceptions
get
Gets the details of the private endpoint connection to the search service in the given resource group.
async get(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.PrivateEndpointConnectionParameters
- resource_group_name
- str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search_service_name
- str
The name of the Azure Cognitive Search service associated with the specified resource group.
- private_endpoint_connection_name
- str
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- search_management_request_options
- SearchManagementRequestOptions
Parameter group.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateEndpointConnection, or the result of cls(response)
Return type
Exceptions
list_by_service
Gets a list of all private endpoint connections in the given service.
list_by_service(resource_group_name: str, search_service_name: str, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> AsyncIterable[azure.mgmt.search.models._models_py3.PrivateEndpointConnectionListResult]Parameters
- resource_group_name
- str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search_service_name
- str
The name of the Azure Cognitive Search service associated with the specified resource group.
- search_management_request_options
- SearchManagementRequestOptions
Parameter group.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)
Return type
Exceptions
update
Updates a Private Endpoint connection to the search service in the given resource group.
async update(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, private_endpoint_connection: azure.mgmt.search.models._models_py3.PrivateEndpointConnection, search_management_request_options: Optional[azure.mgmt.search.models._models_py3.SearchManagementRequestOptions] = None, **kwargs) -> azure.mgmt.search.models._models_py3.PrivateEndpointConnectionParameters
- resource_group_name
- str
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- search_service_name
- str
The name of the Azure Cognitive Search service associated with the specified resource group.
- private_endpoint_connection_name
- str
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- private_endpoint_connection
- PrivateEndpointConnection
The definition of the private endpoint connection to update.
- search_management_request_options
- SearchManagementRequestOptions
Parameter group.
- cls
- callable
A custom type or function that will be passed the direct response
Returns
PrivateEndpointConnection, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>Feedback
Submit and view feedback for