Share via

PrivateEndpointConnectionsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SearchManagementClient's

<xref:private_endpoint_connections> attribute.

Inheritance
builtins.object
PrivateEndpointConnectionsOperations

Constructor

PrivateEndpointConnectionsOperations(*args, **kwargs)

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: SearchManagementRequestOptions | None = None, **kwargs: Any) -> PrivateEndpointConnection | None

Parameters

Name Description
resource_group_name
Required
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. Required.
search_service_name
Required
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
PrivateEndpointConnection,
None

PrivateEndpointConnection or None or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

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: SearchManagementRequestOptions | None = None, **kwargs: Any) -> PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
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. Required.
search_service_name
Required
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

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: SearchManagementRequestOptions | None = None, **kwargs: Any) -> AsyncIterable[PrivateEndpointConnection]

Parameters

Name Description
resource_group_name
Required
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. Required.
search_service_name
Required
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncItemPaged[PrivateEndpointConnection]

An iterator like instance of either PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

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: _models.PrivateEndpointConnection, search_management_request_options: _models.SearchManagementRequestOptions | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PrivateEndpointConnection

Parameters

Name Description
resource_group_name
Required
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. Required.
search_service_name
Required
str

The name of the Azure Cognitive Search service associated with the specified resource group. Required.
private_endpoint_connection_name
Required
str

The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group. Required.
private_endpoint_connection
Required
PrivateEndpointConnection or IO

The definition of the private endpoint connection to update. Is either a PrivateEndpointConnection type or a IO type. Required.
search_management_request_options
Required
SearchManagementRequestOptions

Parameter group. Default value is None.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
PrivateEndpointConnection

PrivateEndpointConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError
See also

Attributes

models 

models = <module 'azure.mgmt.search.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\search\\models\\__init__.py'>