ManagedInstances interface

Package:

@azure/arm-sql

Interface representing a ManagedInstances.

Methods

beginCreateOrUpdate(string, string, ManagedInstance, ManagedInstancesCreateOrUpdateOptionalParams)	Creates or updates a managed instance.
beginCreateOrUpdateAndWait(string, string, ManagedInstance, ManagedInstancesCreateOrUpdateOptionalParams)	Creates or updates a managed instance.
beginDelete(string, string, ManagedInstancesDeleteOptionalParams)	Deletes a managed instance.
beginDeleteAndWait(string, string, ManagedInstancesDeleteOptionalParams)	Deletes a managed instance.
beginFailover(string, string, ManagedInstancesFailoverOptionalParams)	Failovers a managed instance.
beginFailoverAndWait(string, string, ManagedInstancesFailoverOptionalParams)	Failovers a managed instance.
beginStart(string, string, ManagedInstancesStartOptionalParams)	Starts the managed instance.
beginStartAndWait(string, string, ManagedInstancesStartOptionalParams)	Starts the managed instance.
beginStop(string, string, ManagedInstancesStopOptionalParams)	Stops the managed instance.
beginStopAndWait(string, string, ManagedInstancesStopOptionalParams)	Stops the managed instance.
beginUpdate(string, string, ManagedInstanceUpdate, ManagedInstancesUpdateOptionalParams)	Updates a managed instance.
beginUpdateAndWait(string, string, ManagedInstanceUpdate, ManagedInstancesUpdateOptionalParams)	Updates a managed instance.
get(string, string, ManagedInstancesGetOptionalParams)	Gets a managed instance.
list(ManagedInstancesListOptionalParams)	Gets a list of all managed instances in the subscription.
listByInstancePool(string, string, ManagedInstancesListByInstancePoolOptionalParams)	Gets a list of all managed instances in an instance pool.
listByManagedInstance(string, string, ManagedInstancesListByManagedInstanceOptionalParams)	Get top resource consuming queries of a managed instance.
listByResourceGroup(string, ManagedInstancesListByResourceGroupOptionalParams)	Gets a list of managed instances in a resource group.
listOutboundNetworkDependenciesByManagedInstance(string, string, ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams)	Gets the collection of outbound network dependencies for the given managed instance.

Method Details

beginCreateOrUpdate(string, string, ManagedInstance, ManagedInstancesCreateOrUpdateOptionalParams)

Creates or updates a managed instance.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

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.

parameters

ManagedInstance

The requested managed instance resource state.

options

ManagedInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

beginCreateOrUpdateAndWait(string, string, ManagedInstance, ManagedInstancesCreateOrUpdateOptionalParams)

Creates or updates a managed instance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams): Promise<ManagedInstance>

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.

parameters

ManagedInstance

The requested managed instance resource state.

options

ManagedInstancesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedInstance>

beginDelete(string, string, ManagedInstancesDeleteOptionalParams)

Deletes a managed instance.

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

options

ManagedInstancesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, ManagedInstancesDeleteOptionalParams)

Deletes a managed instance.

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

options

ManagedInstancesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, ManagedInstancesFailoverOptionalParams)

Failovers a managed instance.

function beginFailover(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams): 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 to failover.

options

ManagedInstancesFailoverOptionalParams

The options parameters.

Returns

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

beginFailoverAndWait(string, string, ManagedInstancesFailoverOptionalParams)

Failovers a managed instance.

function beginFailoverAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams): 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 to failover.

options

ManagedInstancesFailoverOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ManagedInstancesStartOptionalParams)

Starts the managed instance.

function beginStart(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams): 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.

options

ManagedInstancesStartOptionalParams

The options parameters.

Returns

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

beginStartAndWait(string, string, ManagedInstancesStartOptionalParams)

Starts the managed instance.

function beginStartAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams): 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.

options

ManagedInstancesStartOptionalParams

The options parameters.

Returns

Promise<void>

beginStop(string, string, ManagedInstancesStopOptionalParams)

Stops the managed instance.

function beginStop(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams): 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.

options

ManagedInstancesStopOptionalParams

The options parameters.

Returns

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

beginStopAndWait(string, string, ManagedInstancesStopOptionalParams)

Stops the managed instance.

function beginStopAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams): 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.

options

ManagedInstancesStopOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, ManagedInstanceUpdate, ManagedInstancesUpdateOptionalParams)

Updates a managed instance.

function beginUpdate(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

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.

parameters

ManagedInstanceUpdate

The requested managed instance resource state.

options

ManagedInstancesUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

beginUpdateAndWait(string, string, ManagedInstanceUpdate, ManagedInstancesUpdateOptionalParams)

Updates a managed instance.

function beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams): Promise<ManagedInstance>

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.

parameters

ManagedInstanceUpdate

The requested managed instance resource state.

options

ManagedInstancesUpdateOptionalParams

The options parameters.

Returns

Promise<ManagedInstance>

get(string, string, ManagedInstancesGetOptionalParams)

Gets a managed instance.

function get(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesGetOptionalParams): Promise<ManagedInstance>

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

ManagedInstancesGetOptionalParams

The options parameters.

Returns

Promise<ManagedInstance>

list(ManagedInstancesListOptionalParams)

Gets a list of all managed instances in the subscription.

function list(options?: ManagedInstancesListOptionalParams): PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

Parameters

options

ManagedInstancesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

listByInstancePool(string, string, ManagedInstancesListByInstancePoolOptionalParams)

Gets a list of all managed instances in an instance pool.

function listByInstancePool(resourceGroupName: string, instancePoolName: string, options?: ManagedInstancesListByInstancePoolOptionalParams): PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], 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.

instancePoolName

string

The instance pool name.

options

ManagedInstancesListByInstancePoolOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

listByManagedInstance(string, string, ManagedInstancesListByManagedInstanceOptionalParams)

Get top resource consuming queries of a managed instance.

function listByManagedInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListByManagedInstanceOptionalParams): PagedAsyncIterableIterator<TopQueries, TopQueries[], 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

ManagedInstancesListByManagedInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TopQueries, TopQueries[], PageSettings>

listByResourceGroup(string, ManagedInstancesListByResourceGroupOptionalParams)

Gets a list of managed instances in a resource group.

function listByResourceGroup(resourceGroupName: string, options?: ManagedInstancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], 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.

options

ManagedInstancesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

listOutboundNetworkDependenciesByManagedInstance(string, string, ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams)

Gets the collection of outbound network dependencies for the given managed instance.

function listOutboundNetworkDependenciesByManagedInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], 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

ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>