Package com.azure.resourcemanager.synapse.models

Interface Keys

public interface Keys

Resource collection API of Keys.

Method Summary

Modifier and Type	Method	Description
Key.DefinitionStages.Blank	define(String name)	Begins definition for a new Key resource.
Key	delete(String resourceGroupName, String workspaceName, String keyName)	Deletes a workspace key.
Key	deleteById(String id)	Deletes a workspace key.
com.azure.core.http.rest.Response<Key>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Deletes a workspace key.
com.azure.core.http.rest.Response<Key>	deleteWithResponse(String resourceGroupName, String workspaceName, String keyName, com.azure.core.util.Context context)	Deletes a workspace key.
Key	get(String resourceGroupName, String workspaceName, String keyName)	Gets a workspace key.
Key	getById(String id)	Gets a workspace key.
com.azure.core.http.rest.Response<Key>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets a workspace key.
com.azure.core.http.rest.Response<Key>	getWithResponse(String resourceGroupName, String workspaceName, String keyName, com.azure.core.util.Context context)	Gets a workspace key.
com.azure.core.http.rest.PagedIterable<Key>	listByWorkspace(String resourceGroupName, String workspaceName)	Returns a list of keys in a workspace.
com.azure.core.http.rest.PagedIterable<Key>	listByWorkspace(String resourceGroupName, String workspaceName, com.azure.core.util.Context context)	Returns a list of keys in a workspace.

Method Detail

listByWorkspace

com.azure.core.http.rest.PagedIterable<Key> 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<Key> 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.

get

Key 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.

getWithResponse

com.azure.core.http.rest.Response<Key> 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.

delete

Key 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.

deleteWithResponse

com.azure.core.http.rest.Response<Key> 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.

getById

Key getById(String id)

Gets a workspace key.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<Key> getByIdWithResponse(String id,
                                                           com.azure.core.util.Context context)

Gets a workspace key.

Parameters:

id - the resource ID.

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.

deleteById

Key deleteById(String id)

Deletes a workspace key.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Key> deleteByIdWithResponse(String id,
                                                              com.azure.core.util.Context context)

Deletes a workspace key.

Parameters:

id - the resource ID.

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.

define

Key.DefinitionStages.Blank define(String name)

Begins definition for a new Key resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Key definition.