Keys Interface

Package:

com.azure.resourcemanager.synapse.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-synapse:1.0.0

public interface Keys

Resource collection API of Keys.

Method Summary

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

Method Details

define

public abstract 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.

delete

public abstract 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.

deleteById

public abstract Key deleteById(String id)

Deletes a workspace key.

Parameters:

id - the resource ID.

Returns:

a workspace key along with Response<T>.

deleteByIdWithResponse

public abstract Response<Key> deleteByIdWithResponse(String id, 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<T>.

deleteWithResponse

public abstract Response<Key> deleteWithResponse(String resourceGroupName, String workspaceName, String keyName, 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<T>.

get

public abstract 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.

getById

public abstract Key getById(String id)

Gets a workspace key.

Parameters:

id - the resource ID.

Returns:

a workspace key along with Response<T>.

getByIdWithResponse

public abstract Response<Key> getByIdWithResponse(String id, 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<T>.

getWithResponse

public abstract Response<Key> getWithResponse(String resourceGroupName, String workspaceName, String keyName, 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<T>.

listByWorkspace

public abstract 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<T>.

listByWorkspace

public abstract PagedIterable<Key> listByWorkspace(String resourceGroupName, String workspaceName, 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<T>.