Class KeyVaultConnectionsClient

java.lang.Object
com.azure.analytics.purview.scanning.KeyVaultConnectionsClient

public final class KeyVaultConnectionsClient extends Object
Initializes a new instance of the synchronous PurviewScanningClient type.
  • Method Details

    • getWithResponse

      public Response<BinaryData> getWithResponse(String keyVaultName, RequestOptions requestOptions)
      Gets key vault information.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      apiVersionStringYesApi Version

      Response Body Schema

      
       {
           id: String
           name: String
           properties: {
               baseUrl: String
               description: String
           }
       }
       
      Parameters:
      keyVaultName - The keyVaultName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      key vault information along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
    • createWithResponse

      public Response<BinaryData> createWithResponse(String keyVaultName, BinaryData body, RequestOptions requestOptions)
      Creates an instance of a key vault connection.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      apiVersionStringYesApi Version

      Request Body Schema

      
       {
           id: String
           name: String
           properties: {
               baseUrl: String
               description: String
           }
       }
       

      Response Body Schema

      
       {
           id: String
           name: String
           properties: {
               baseUrl: String
               description: String
           }
       }
       
      Parameters:
      keyVaultName - The keyVaultName parameter.
      body - The body parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
    • deleteWithResponse

      public Response<BinaryData> deleteWithResponse(String keyVaultName, RequestOptions requestOptions)
      Deletes the key vault connection associated with the account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      apiVersionStringYesApi Version

      Response Body Schema

      
       {
           id: String
           name: String
           properties: {
               baseUrl: String
               description: String
           }
       }
       
      Parameters:
      keyVaultName - The keyVaultName parameter.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response body along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
    • listAll

      public PagedIterable<BinaryData> listAll(RequestOptions requestOptions)
      List key vault connections in account.

      Query Parameters

      Query Parameters
      NameTypeRequiredDescription
      apiVersionStringYesApi Version

      Response Body Schema

      
       {
           value: [
               {
                   id: String
                   name: String
                   properties: {
                       baseUrl: String
                       description: String
                   }
               }
           ]
           nextLink: String
           count: Long
       }
       
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.