PrivateEndpointConnectionsOperations interface

Package:

@azure/arm-search

Interface representing a PrivateEndpointConnections operations.

Properties

delete	Disconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with the deleted connection details on successful deletion, or 404 (Not Found) if the connection does not exist. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.
get	Gets the details of the private endpoint connection to the search service in the given resource group.
listByService	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.

Property Details

delete

Disconnects the private endpoint connection and deletes it from the search service. Returns 200 (OK) with the deleted connection details on successful deletion, or 404 (Not Found) if the connection does not exist. NOTE: The behavior of returning 404 is inconsistent with ARM guidelines. Clients should expect a 204 response in future versions and avoid new dependencies on the 404 response.

delete: (resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<void | PrivateEndpointConnection>

Property Value

(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams) => Promise<void | PrivateEndpointConnection>

get

Gets the details of the private endpoint connection to the search service in the given resource group.

get: (resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams) => Promise<PrivateEndpointConnection>

listByService

Gets a list of all private endpoint connections in the given service.

listByService: (resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

Property Value

(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams) => PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>

update

Updates a private endpoint connection to the search service in the given resource group.

update: (resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams) => Promise<PrivateEndpointConnection>

Property Value

(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams) => Promise<PrivateEndpointConnection>