Package com.azure.resourcemanager.synapse.fluent

Interface KeysClient

public interface KeysClient
An instance of this class provides access to all the operations defined in KeysClient.

  • Method Details

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<KeyInner> listByWorkspace(String resourceGroupName, String workspaceName)
      Returns a list of keys in a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      Returns:
      list of keys as paginated response with PagedIterable.
      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.

    • listByWorkspace

      com.azure.core.http.rest.PagedIterable<KeyInner> listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)
      Returns a list of keys in a workspace.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      context - The context to associate with this operation.
      Returns:
      list of keys as paginated response with PagedIterable.
      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<KeyInner> getWithResponse(String resourceGroupName, String workspaceName, String keyName, com.azure.core.util.Context context)
      Gets a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      context - The context to associate with this operation.
      Returns:
      a workspace key along with Response.
      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

      KeyInner get(String resourceGroupName, String workspaceName, String keyName)
      Gets a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      Returns:
      a workspace key.
      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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<KeyInner> createOrUpdateWithResponse(String resourceGroupName, String workspaceName, String keyName, KeyInner keyProperties, com.azure.core.util.Context context)
      Creates or updates a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      keyProperties - Key put request properties.
      context - The context to associate with this operation.
      Returns:
      a workspace key along with Response.
      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

      KeyInner createOrUpdate(String resourceGroupName, String workspaceName, String keyName, KeyInner keyProperties)
      Creates or updates a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      keyProperties - Key put request properties.
      Returns:
      a workspace key.
      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<KeyInner> deleteWithResponse(String resourceGroupName, String workspaceName, String keyName, com.azure.core.util.Context context)
      Deletes a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      context - The context to associate with this operation.
      Returns:
      a workspace key along with Response.
      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

      KeyInner delete(String resourceGroupName, String workspaceName, String keyName)
      Deletes a workspace key.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      workspaceName - The name of the workspace.
      keyName - The name of the workspace key.
      Returns:
      a workspace key.
      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.