Interface PrivateEndpointConnectionsClient


  • public interface PrivateEndpointConnectionsClient
    An instance of this class provides access to all the operations defined in PrivateEndpointConnectionsClient.
    • Method Detail

      • updateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<PrivateEndpointConnectionInner>> updateWithResponseAsync​(String resourceGroupName,
                                                                                                        String searchServiceName,
                                                                                                        String privateEndpointConnectionName,
                                                                                                        UUID clientRequestId,
                                                                                                        PrivateEndpointConnectionProperties properties)
        Updates a Private Endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAsync

        Mono<PrivateEndpointConnectionInner> updateAsync​(String resourceGroupName,
                                                         String searchServiceName,
                                                         String privateEndpointConnectionName,
                                                         UUID clientRequestId,
                                                         PrivateEndpointConnectionProperties properties)
        Updates a Private Endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateAsync

        Mono<PrivateEndpointConnectionInner> updateAsync​(String resourceGroupName,
                                                         String searchServiceName,
                                                         String privateEndpointConnectionName)
        Updates a Private Endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • update

        PrivateEndpointConnectionInner update​(String resourceGroupName,
                                              String searchServiceName,
                                              String privateEndpointConnectionName)
        Updates a Private Endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • updateWithResponse

        com.azure.core.http.rest.Response<PrivateEndpointConnectionInner> updateWithResponse​(String resourceGroupName,
                                                                                             String searchServiceName,
                                                                                             String privateEndpointConnectionName,
                                                                                             UUID clientRequestId,
                                                                                             PrivateEndpointConnectionProperties properties,
                                                                                             com.azure.core.util.Context context)
        Updates a Private Endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        properties - Describes the properties of an existing Private Endpoint connection to the Azure Cognitive Search service.
        context - The context to associate with this operation.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponseAsync

        Mono<com.azure.core.http.rest.Response<PrivateEndpointConnectionInner>> getWithResponseAsync​(String resourceGroupName,
                                                                                                     String searchServiceName,
                                                                                                     String privateEndpointConnectionName,
                                                                                                     UUID clientRequestId)
        Gets the details of the private endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        Returns:
        the details of the private endpoint connection to the search service in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAsync

        Mono<PrivateEndpointConnectionInner> getAsync​(String resourceGroupName,
                                                      String searchServiceName,
                                                      String privateEndpointConnectionName,
                                                      UUID clientRequestId)
        Gets the details of the private endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        Returns:
        the details of the private endpoint connection to the search service in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getAsync

        Mono<PrivateEndpointConnectionInner> getAsync​(String resourceGroupName,
                                                      String searchServiceName,
                                                      String privateEndpointConnectionName)
        Gets the details of the private endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        the details of the private endpoint connection to the search service in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • get

        PrivateEndpointConnectionInner get​(String resourceGroupName,
                                           String searchServiceName,
                                           String privateEndpointConnectionName)
        Gets the details of the private endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        the details of the private endpoint connection to the search service in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • getWithResponse

        com.azure.core.http.rest.Response<PrivateEndpointConnectionInner> getWithResponse​(String resourceGroupName,
                                                                                          String searchServiceName,
                                                                                          String privateEndpointConnectionName,
                                                                                          UUID clientRequestId,
                                                                                          com.azure.core.util.Context context)
        Gets the details of the private endpoint connection to the search service in the given resource group.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        context - The context to associate with this operation.
        Returns:
        the details of the private endpoint connection to the search service in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponseAsync

        Mono<com.azure.core.http.rest.Response<PrivateEndpointConnectionInner>> deleteWithResponseAsync​(String resourceGroupName,
                                                                                                        String searchServiceName,
                                                                                                        String privateEndpointConnectionName,
                                                                                                        UUID clientRequestId)
        Disconnects the private endpoint connection and deletes it from the search service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteAsync

        Mono<PrivateEndpointConnectionInner> deleteAsync​(String resourceGroupName,
                                                         String searchServiceName,
                                                         String privateEndpointConnectionName,
                                                         UUID clientRequestId)
        Disconnects the private endpoint connection and deletes it from the search service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteAsync

        Mono<PrivateEndpointConnectionInner> deleteAsync​(String resourceGroupName,
                                                         String searchServiceName,
                                                         String privateEndpointConnectionName)
        Disconnects the private endpoint connection and deletes it from the search service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • delete

        PrivateEndpointConnectionInner delete​(String resourceGroupName,
                                              String searchServiceName,
                                              String privateEndpointConnectionName)
        Disconnects the private endpoint connection and deletes it from the search service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • deleteWithResponse

        com.azure.core.http.rest.Response<PrivateEndpointConnectionInner> deleteWithResponse​(String resourceGroupName,
                                                                                             String searchServiceName,
                                                                                             String privateEndpointConnectionName,
                                                                                             UUID clientRequestId,
                                                                                             com.azure.core.util.Context context)
        Disconnects the private endpoint connection and deletes it from the search service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        privateEndpointConnectionName - The name of the private endpoint connection to the Azure Cognitive Search service with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        context - The context to associate with this operation.
        Returns:
        describes an existing Private Endpoint connection to the Azure Cognitive Search service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByServiceAsync

        com.azure.core.http.rest.PagedFlux<PrivateEndpointConnectionInner> listByServiceAsync​(String resourceGroupName,
                                                                                              String searchServiceName,
                                                                                              UUID clientRequestId)
        Gets a list of all private endpoint connections in the given service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        Returns:
        a list of all private endpoint connections in the given service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByServiceAsync

        com.azure.core.http.rest.PagedFlux<PrivateEndpointConnectionInner> listByServiceAsync​(String resourceGroupName,
                                                                                              String searchServiceName)
        Gets a list of all private endpoint connections in the given service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        Returns:
        a list of all private endpoint connections in the given service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByService

        com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByService​(String resourceGroupName,
                                                                                             String searchServiceName)
        Gets a list of all private endpoint connections in the given service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        Returns:
        a list of all private endpoint connections in the given service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
      • listByService

        com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByService​(String resourceGroupName,
                                                                                             String searchServiceName,
                                                                                             UUID clientRequestId,
                                                                                             com.azure.core.util.Context context)
        Gets a list of all private endpoint connections in the given service.
        Parameters:
        resourceGroupName - 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 - The name of the Azure Cognitive Search service associated with the specified resource group.
        clientRequestId - A client-generated GUID value that identifies this request. If specified, this will be included in response information as a way to track the request.
        context - The context to associate with this operation.
        Returns:
        a list of all private endpoint connections in the given service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.