ManagedInstanceAdministrators interface

Package:

@azure/arm-sql

Interface representing a ManagedInstanceAdministrators.

Methods

beginCreateOrUpdate(string, string, string, ManagedInstanceAdministrator, ManagedInstanceAdministratorsCreateOrUpdateOptionalParams)	Creates or updates a managed instance administrator.
beginCreateOrUpdateAndWait(string, string, string, ManagedInstanceAdministrator, ManagedInstanceAdministratorsCreateOrUpdateOptionalParams)	Creates or updates a managed instance administrator.
beginDelete(string, string, string, ManagedInstanceAdministratorsDeleteOptionalParams)	Deletes a managed instance administrator.
beginDeleteAndWait(string, string, string, ManagedInstanceAdministratorsDeleteOptionalParams)	Deletes a managed instance administrator.
get(string, string, string, ManagedInstanceAdministratorsGetOptionalParams)	Gets a managed instance administrator.
listByInstance(string, string, ManagedInstanceAdministratorsListByInstanceOptionalParams)	Gets a list of managed instance administrators.

Method Details

beginCreateOrUpdate(string, string, string, ManagedInstanceAdministrator, ManagedInstanceAdministratorsCreateOrUpdateOptionalParams)

Creates or updates a managed instance administrator.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, administratorName: string, parameters: ManagedInstanceAdministrator, options?: ManagedInstanceAdministratorsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstanceAdministrator>, ManagedInstanceAdministrator>>

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.

administratorName

string

parameters

ManagedInstanceAdministrator

The requested administrator parameters.

options

ManagedInstanceAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ManagedInstanceAdministrator>, ManagedInstanceAdministrator>>

beginCreateOrUpdateAndWait(string, string, string, ManagedInstanceAdministrator, ManagedInstanceAdministratorsCreateOrUpdateOptionalParams)

Creates or updates a managed instance administrator.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, administratorName: string, parameters: ManagedInstanceAdministrator, options?: ManagedInstanceAdministratorsCreateOrUpdateOptionalParams): Promise<ManagedInstanceAdministrator>

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.

administratorName

string

parameters

ManagedInstanceAdministrator

The requested administrator parameters.

options

ManagedInstanceAdministratorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceAdministrator>

beginDelete(string, string, string, ManagedInstanceAdministratorsDeleteOptionalParams)

Deletes a managed instance administrator.

function beginDelete(resourceGroupName: string, managedInstanceName: string, administratorName: string, options?: ManagedInstanceAdministratorsDeleteOptionalParams): 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.

administratorName

string

options

ManagedInstanceAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, ManagedInstanceAdministratorsDeleteOptionalParams)

Deletes a managed instance administrator.

function beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, administratorName: string, options?: ManagedInstanceAdministratorsDeleteOptionalParams): 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.

administratorName

string

options

ManagedInstanceAdministratorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ManagedInstanceAdministratorsGetOptionalParams)

Gets a managed instance administrator.

function get(resourceGroupName: string, managedInstanceName: string, administratorName: string, options?: ManagedInstanceAdministratorsGetOptionalParams): Promise<ManagedInstanceAdministrator>

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.

administratorName

string

options

ManagedInstanceAdministratorsGetOptionalParams

The options parameters.

Returns

Promise<ManagedInstanceAdministrator>

listByInstance(string, string, ManagedInstanceAdministratorsListByInstanceOptionalParams)

Gets a list of managed instance administrators.

function listByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstanceAdministratorsListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceAdministrator, ManagedInstanceAdministrator[], 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

ManagedInstanceAdministratorsListByInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstanceAdministrator, ManagedInstanceAdministrator[], PageSettings>