ManagedInstancesOperations interface

Package:
@azure/arm-sql

Interface representing a ManagedInstances operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginFailover
beginFailoverAndWait
beginReevaluateInaccessibleDatabaseState
beginReevaluateInaccessibleDatabaseStateAndWait
beginRefreshStatus
beginRefreshStatusAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
beginValidateAzureKeyVaultEncryptionKey
beginValidateAzureKeyVaultEncryptionKeyAndWait
createOrUpdate

Creates or updates a managed instance.
delete

Deletes a managed instance.
failover

Failovers a managed instance.
get

Gets a managed instance.
list

Gets a list of all managed instances in the subscription.
listByInstancePool

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

Get top resource consuming queries of a managed instance.
listByResourceGroup

Gets a list of managed instances in a resource group.
listOutboundNetworkDependenciesByManagedInstance

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

Reevaluates the inaccessibility state of all managed databases.
refreshStatus

Refresh external governance enablement status.
start

Starts the managed instance.
stop

Stops the managed instance.
update

Updates a managed instance.
validateAzureKeyVaultEncryptionKey

Validates customer managed key.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => Promise<void>

beginFailover

Warning

This API is now deprecated.

use failover instead

beginFailover: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

beginFailoverAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => Promise<void>

beginReevaluateInaccessibleDatabaseState

Warning

This API is now deprecated.

use reevaluateInaccessibleDatabaseState instead

beginReevaluateInaccessibleDatabaseState: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginReevaluateInaccessibleDatabaseStateAndWait

Warning

This API is now deprecated.

use reevaluateInaccessibleDatabaseState instead

beginReevaluateInaccessibleDatabaseStateAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => Promise<void>

beginRefreshStatus

Warning

This API is now deprecated.

use refreshStatus instead

beginRefreshStatus: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResultMI>, RefreshExternalGovernanceStatusOperationResultMI>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResultMI>, RefreshExternalGovernanceStatusOperationResultMI>>

beginRefreshStatusAndWait

Warning

This API is now deprecated.

use refreshStatus instead

beginRefreshStatusAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => Promise<RefreshExternalGovernanceStatusOperationResultMI>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => Promise<RefreshExternalGovernanceStatusOperationResultMI>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => Promise<ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => Promise<ManagedInstance>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => Promise<ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => Promise<ManagedInstance>

beginUpdate

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

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

Property Value

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

beginValidateAzureKeyVaultEncryptionKey

Warning

This API is now deprecated.

use validateAzureKeyVaultEncryptionKey instead

beginValidateAzureKeyVaultEncryptionKey: (resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginValidateAzureKeyVaultEncryptionKeyAndWait

Warning

This API is now deprecated.

use validateAzureKeyVaultEncryptionKey instead

beginValidateAzureKeyVaultEncryptionKeyAndWait: (resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => Promise<void>

createOrUpdate

Creates or updates a managed instance.

createOrUpdate: (resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

delete

Deletes a managed instance.

delete: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

failover

Failovers a managed instance.

failover: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a managed instance.

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

Property Value

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

list

Gets a list of all managed instances in the subscription.

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

Property Value

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

listByInstancePool

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

listByInstancePool: (resourceGroupName: string, instancePoolName: string, options?: ManagedInstancesListByInstancePoolOptionalParams) => PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

Property Value

(resourceGroupName: string, instancePoolName: string, options?: ManagedInstancesListByInstancePoolOptionalParams) => PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

listByManagedInstance

Get top resource consuming queries of a managed instance.

listByManagedInstance: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListByManagedInstanceOptionalParams) => PagedAsyncIterableIterator<TopQueries, TopQueries[], PageSettings>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListByManagedInstanceOptionalParams) => PagedAsyncIterableIterator<TopQueries, TopQueries[], PageSettings>

listByResourceGroup

Gets a list of managed instances in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ManagedInstancesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

Property Value

(resourceGroupName: string, options?: ManagedInstancesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ManagedInstance, ManagedInstance[], PageSettings>

listOutboundNetworkDependenciesByManagedInstance

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

listOutboundNetworkDependenciesByManagedInstance: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams) => PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>

reevaluateInaccessibleDatabaseState

Reevaluates the inaccessibility state of all managed databases.

reevaluateInaccessibleDatabaseState: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesReevaluateInaccessibleDatabaseStateOptionalParams) => PollerLike<OperationState<void>, void>

refreshStatus

Refresh external governance enablement status.

refreshStatus: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => PollerLike<OperationState<RefreshExternalGovernanceStatusOperationResultMI>, RefreshExternalGovernanceStatusOperationResultMI>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesRefreshStatusOptionalParams) => PollerLike<OperationState<RefreshExternalGovernanceStatusOperationResultMI>, RefreshExternalGovernanceStatusOperationResultMI>

start

Starts the managed instance.

start: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

stop

Stops the managed instance.

stop: (resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

update

Updates a managed instance.

update: (resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

Property Value

(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams) => PollerLike<OperationState<ManagedInstance>, ManagedInstance>

validateAzureKeyVaultEncryptionKey

Validates customer managed key.

validateAzureKeyVaultEncryptionKey: (resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceValidateAzureKeyVaultEncryptionKeyRequest, options?: ManagedInstancesValidateAzureKeyVaultEncryptionKeyOptionalParams) => PollerLike<OperationState<void>, void>