Keys | @azure/arm-synapse

Interface representing a Keys.

Hierarchy

Keys

Implemented by

KeysImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/keys.ts:56
Creates or updates a workspace 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
- Optional options: KeysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<KeysCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/keys.ts:70
Deletes a workspace 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
- Optional options: KeysDeleteOptionalParams
  
  The options parameters.
Returns Promise<KeysDeleteResponse>

get

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

- Defined in operationsInterfaces/keys.ts:42
Gets a workspace 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
- Optional options: KeysGetOptionalParams
  
  The options parameters.
Returns Promise<KeysGetResponse>

listByWorkspace

listByWorkspace(resourceGroupName: string, workspaceName: string, options?: KeysListByWorkspaceOptionalParams): PagedAsyncIterableIterator<Key>

- Defined in operationsInterfaces/keys.ts:30
Returns a list of keys in a workspace

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- workspaceName: string
  
  The name of the workspace.
- Optional options: KeysListByWorkspaceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Key>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

workspaceName: string

keyName: string

keyProperties: Key

Optional options: KeysCreateOrUpdateOptionalParams

Returns Promise<KeysCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

workspaceName: string

keyName: string

Optional options: KeysDeleteOptionalParams

Returns Promise<KeysDeleteResponse>

get

Parameters

resourceGroupName: string

workspaceName: string

keyName: string

Optional options: KeysGetOptionalParams

Returns Promise<KeysGetResponse>

listByWorkspace

Parameters

resourceGroupName: string

workspaceName: string

Optional options: KeysListByWorkspaceOptionalParams

Returns PagedAsyncIterableIterator<Key>