Interface PrivateEndpointConnectionsClient


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

      • listByDatabaseAccountAsync

        com.azure.core.http.rest.PagedFlux<PrivateEndpointConnectionInner> listByDatabaseAccountAsync​(String resourceGroupName,
                                                                                                      String accountName)
        List all private endpoint connections on a Cosmos DB account.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        Returns:
        a list of private endpoint connections.
        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.
      • listByDatabaseAccount

        com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByDatabaseAccount​(String resourceGroupName,
                                                                                                     String accountName)
        List all private endpoint connections on a Cosmos DB account.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        Returns:
        a list of private endpoint connections.
        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.
      • listByDatabaseAccount

        com.azure.core.http.rest.PagedIterable<PrivateEndpointConnectionInner> listByDatabaseAccount​(String resourceGroupName,
                                                                                                     String accountName,
                                                                                                     com.azure.core.util.Context context)
        List all private endpoint connections on a Cosmos DB account.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        context - The context to associate with this operation.
        Returns:
        a list of private endpoint connections.
        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 accountName,
                                                                                                     String privateEndpointConnectionName)
        Gets a private endpoint connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        a private endpoint connection.
        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 accountName,
                                                      String privateEndpointConnectionName)
        Gets a private endpoint connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        a private endpoint connection.
        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 accountName,
                                           String privateEndpointConnectionName)
        Gets a private endpoint connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        a private endpoint connection.
        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 accountName,
                                                                                          String privateEndpointConnectionName,
                                                                                          com.azure.core.util.Context context)
        Gets a private endpoint connection.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        a private endpoint connection.
        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.
      • createOrUpdateWithResponseAsync

        Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync​(String resourceGroupName,
                                                                                                  String accountName,
                                                                                                  String privateEndpointConnectionName,
                                                                                                  PrivateEndpointConnectionInner parameters)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        Returns:
        a private endpoint connection.
        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.
      • beginCreateOrUpdateAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<PrivateEndpointConnectionInner>,​PrivateEndpointConnectionInner> beginCreateOrUpdateAsync​(String resourceGroupName,
                                                                                                                                                                                           String accountName,
                                                                                                                                                                                           String privateEndpointConnectionName,
                                                                                                                                                                                           PrivateEndpointConnectionInner parameters)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        Returns:
        a private endpoint connection.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateEndpointConnectionInner>,​PrivateEndpointConnectionInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                      String accountName,
                                                                                                                                                                                      String privateEndpointConnectionName,
                                                                                                                                                                                      PrivateEndpointConnectionInner parameters)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        Returns:
        a private endpoint connection.
        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.
      • beginCreateOrUpdate

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<PrivateEndpointConnectionInner>,​PrivateEndpointConnectionInner> beginCreateOrUpdate​(String resourceGroupName,
                                                                                                                                                                                      String accountName,
                                                                                                                                                                                      String privateEndpointConnectionName,
                                                                                                                                                                                      PrivateEndpointConnectionInner parameters,
                                                                                                                                                                                      com.azure.core.util.Context context)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        a private endpoint connection.
        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.
      • createOrUpdateAsync

        Mono<PrivateEndpointConnectionInner> createOrUpdateAsync​(String resourceGroupName,
                                                                 String accountName,
                                                                 String privateEndpointConnectionName,
                                                                 PrivateEndpointConnectionInner parameters)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        Returns:
        a private endpoint connection.
        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.
      • createOrUpdate

        PrivateEndpointConnectionInner createOrUpdate​(String resourceGroupName,
                                                      String accountName,
                                                      String privateEndpointConnectionName,
                                                      PrivateEndpointConnectionInner parameters)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        Returns:
        a private endpoint connection.
        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.
      • createOrUpdate

        PrivateEndpointConnectionInner createOrUpdate​(String resourceGroupName,
                                                      String accountName,
                                                      String privateEndpointConnectionName,
                                                      PrivateEndpointConnectionInner parameters,
                                                      com.azure.core.util.Context context)
        Approve or reject a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        parameters - A private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        a private endpoint connection.
        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<Flux<ByteBuffer>>> deleteWithResponseAsync​(String resourceGroupName,
                                                                                          String accountName,
                                                                                          String privateEndpointConnectionName)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        the completion.
        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.
      • beginDeleteAsync

        com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,​Void> beginDeleteAsync​(String resourceGroupName,
                                                                                                                               String accountName,
                                                                                                                               String privateEndpointConnectionName)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        the completion.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String accountName,
                                                                                                                          String privateEndpointConnectionName)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        the completion.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String accountName,
                                                                                                                          String privateEndpointConnectionName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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<Void> deleteAsync​(String resourceGroupName,
                               String accountName,
                               String privateEndpointConnectionName)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        the completion.
        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

        void delete​(String resourceGroupName,
                    String accountName,
                    String privateEndpointConnectionName)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        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

        void delete​(String resourceGroupName,
                    String accountName,
                    String privateEndpointConnectionName,
                    com.azure.core.util.Context context)
        Deletes a private endpoint connection with a given name.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        accountName - Cosmos DB database account name.
        privateEndpointConnectionName - The name of the private endpoint connection.
        context - The context to associate with this operation.
        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.