PrivateEndpointConnections interface
Interface representing a PrivateEndpointConnections.
Methods
| delete(string, string, string, Private |
Disconnects the private endpoint connection and deletes it from the search service. |
| get(string, string, string, Private |
Gets the details of the private endpoint connection to the search service in the given resource group. |
| list |
Gets a list of all private endpoint connections in the given service. |
| update(string, string, string, Private |
Updates a Private Endpoint connection to the search service in the given resource group. |
Method Details
delete(string, string, string, PrivateEndpointConnectionsDeleteOptionalParams)
Disconnects the private endpoint connection and deletes it from the search service.
function delete(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
get(string, string, string, PrivateEndpointConnectionsGetOptionalParams)
Gets the details of the private endpoint connection to the search service in the given resource group.
function get(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
The options parameters.
Returns
Promise<PrivateEndpointConnection>
listByService(string, string, PrivateEndpointConnectionsListByServiceOptionalParams)
Gets a list of all private endpoint connections in the given service.
function listByService(resourceGroupName: string, searchServiceName: string, options?: PrivateEndpointConnectionsListByServiceOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection, PrivateEndpointConnection[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
The options parameters.
Returns
update(string, string, string, PrivateEndpointConnection, PrivateEndpointConnectionsUpdateOptionalParams)
Updates a Private Endpoint connection to the search service in the given resource group.
function update(resourceGroupName: string, searchServiceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsUpdateOptionalParams): Promise<PrivateEndpointConnection>Parameters
- resourceGroupName
-
string
The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.
- searchServiceName
-
string
The name of the Azure Cognitive Search service associated with the specified resource group.
- privateEndpointConnectionName
-
string
The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
- privateEndpointConnection
- PrivateEndpointConnection
The definition of the private endpoint connection to update.
The options parameters.
Returns
Promise<PrivateEndpointConnection>