ManagedInstanceKeys interface

Package:

@azure/arm-sql

Interface representing a ManagedInstanceKeys.

Methods

beginCreateOrUpdate(string, string, string, ManagedInstanceKey, ManagedInstanceKeysCreateOrUpdateOptionalParams)	Creates or updates a managed instance key.
beginCreateOrUpdateAndWait(string, string, string, ManagedInstanceKey, ManagedInstanceKeysCreateOrUpdateOptionalParams)	Creates or updates a managed instance key.
beginDelete(string, string, string, ManagedInstanceKeysDeleteOptionalParams)	Deletes the managed instance key with the given name.
beginDeleteAndWait(string, string, string, ManagedInstanceKeysDeleteOptionalParams)	Deletes the managed instance key with the given name.
get(string, string, string, ManagedInstanceKeysGetOptionalParams)	Gets a managed instance key.
listByInstance(string, string, ManagedInstanceKeysListByInstanceOptionalParams)	Gets a list of managed instance keys.

Method Details

beginCreateOrUpdate(string, string, string, ManagedInstanceKey, ManagedInstanceKeysCreateOrUpdateOptionalParams)

Creates or updates a managed instance key.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, keyName: string, parameters: ManagedInstanceKey, options?: ManagedInstanceKeysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstanceKey>, ManagedInstanceKey>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

keyName

string

The name of the managed instance key to be operated on (updated or created).

parameters

ManagedInstanceKey

The requested managed instance key resource state.

options

ManagedInstanceKeysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ManagedInstanceKey>, ManagedInstanceKey>>

beginCreateOrUpdateAndWait(string, string, string, ManagedInstanceKey, ManagedInstanceKeysCreateOrUpdateOptionalParams)

Creates or updates a managed instance key.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, keyName: string, parameters: ManagedInstanceKey, options?: ManagedInstanceKeysCreateOrUpdateOptionalParams): Promise<ManagedInstanceKey>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

keyName

string

The name of the managed instance key to be operated on (updated or created).

parameters

ManagedInstanceKey

The requested managed instance key resource state.

options

ManagedInstanceKeysCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceKey>

beginDelete(string, string, string, ManagedInstanceKeysDeleteOptionalParams)

Deletes the managed instance key with the given name.

function beginDelete(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

keyName

string

The name of the managed instance key to be deleted.

options

ManagedInstanceKeysDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ManagedInstanceKeysDeleteOptionalParams)

Deletes the managed instance key with the given name.

function beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

keyName

string

The name of the managed instance key to be deleted.

options

ManagedInstanceKeysDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ManagedInstanceKeysGetOptionalParams)

Gets a managed instance key.

function get(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysGetOptionalParams): Promise<ManagedInstanceKey>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

keyName

string

The name of the managed instance key to be retrieved.

options

ManagedInstanceKeysGetOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceKey>

listByInstance(string, string, ManagedInstanceKeysListByInstanceOptionalParams)

Gets a list of managed instance keys.

function listByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstanceKeysListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceKey, ManagedInstanceKey[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

options

ManagedInstanceKeysListByInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceKey, ManagedInstanceKey[], PageSettings>