Keys interface

Package:

@azure/arm-synapse

Interface representing a Keys.

Methods

createOrUpdate(string, string, string, Key, KeysCreateOrUpdateOptionalParams)	Creates or updates a workspace key
delete(string, string, string, KeysDeleteOptionalParams)	Deletes a workspace key
get(string, string, string, KeysGetOptionalParams)	Gets a workspace key
listByWorkspace(string, string, KeysListByWorkspaceOptionalParams)	Returns a list of keys in a workspace

Method Details

createOrUpdate(string, string, string, Key, KeysCreateOrUpdateOptionalParams)

Creates or updates a workspace key

function createOrUpdate(resourceGroupName: string, workspaceName: string, keyName: string, keyProperties: Key, options?: KeysCreateOrUpdateOptionalParams): Promise<Key>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

keyName

string

The name of the workspace key

keyProperties

Key

Key put request properties

options

KeysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Key>

delete(string, string, string, KeysDeleteOptionalParams)

Deletes a workspace key

function delete(resourceGroupName: string, workspaceName: string, keyName: string, options?: KeysDeleteOptionalParams): Promise<Key>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

keyName

string

The name of the workspace key

options

KeysDeleteOptionalParams

The options parameters.

Returns

Promise<Key>

get(string, string, string, KeysGetOptionalParams)

Gets a workspace key

function get(resourceGroupName: string, workspaceName: string, keyName: string, options?: KeysGetOptionalParams): Promise<Key>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

keyName

string

The name of the workspace key

options

KeysGetOptionalParams

The options parameters.

Returns

Promise<Key>

listByWorkspace(string, string, KeysListByWorkspaceOptionalParams)

Returns a list of keys in a workspace

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: KeysListByWorkspaceOptionalParams): PagedAsyncIterableIterator<Key, Key[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

options

KeysListByWorkspaceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Key, Key[], PageSettings>