ManagedInstances interface
Interface representing a ManagedInstances.
Methods
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
The options parameters.
Returns
Promise<@azure/core-lro.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.
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.
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
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.
Returns
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.
The options parameters.