Package version:

Interface ManagedInstances

Interface representing a ManagedInstances.

Hierarchy

ManagedInstances

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginFailover beginFailoverAndWait beginStart beginStartAndWait beginStop beginStopAndWait beginUpdate beginUpdateAndWait get list listByInstancePool listByManagedInstance listByResourceGroup listOutboundNetworkDependenciesByManagedInstance

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>
Creates or updates a managed instance.
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.
- Optional options: ManagedInstancesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>
- Defined in operationsInterfaces/managedInstances.ts:109

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstance, options?: ManagedInstancesCreateOrUpdateOptionalParams): Promise<ManagedInstance>
Creates or updates a managed instance.
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.
- Optional options: ManagedInstancesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:128

beginDelete

beginDelete(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a managed instance.
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.
- Optional options: ManagedInstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedInstances.ts:141

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesDeleteOptionalParams): Promise<void>
Deletes a managed instance.
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.
- Optional options: ManagedInstancesDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedInstances.ts:153

beginFailover

beginFailover(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Failovers a managed instance.
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.
- Optional options: ManagedInstancesFailoverOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedInstances.ts:198

beginFailoverAndWait

beginFailoverAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesFailoverOptionalParams): Promise<void>
Failovers a managed instance.
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.
- Optional options: ManagedInstancesFailoverOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedInstances.ts:210

beginStart

beginStart(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Starts the managed instance.
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.
- Optional options: ManagedInstancesStartOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedInstances.ts:222

beginStartAndWait

beginStartAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStartOptionalParams): Promise<void>
Starts the managed instance.
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.
- Optional options: ManagedInstancesStartOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedInstances.ts:234

beginStop

beginStop(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Stops the managed instance.
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.
- Optional options: ManagedInstancesStopOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedInstances.ts:246

beginStopAndWait

beginStopAndWait(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesStopOptionalParams): Promise<void>
Stops the managed instance.
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.
- Optional options: ManagedInstancesStopOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedInstances.ts:258

beginUpdate

beginUpdate(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>
Updates a managed instance.
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.
- Optional options: ManagedInstancesUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedInstance>, ManagedInstance>>
- Defined in operationsInterfaces/managedInstances.ts:166

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, parameters: ManagedInstanceUpdate, options?: ManagedInstancesUpdateOptionalParams): Promise<ManagedInstance>
Updates a managed instance.
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.
- Optional options: ManagedInstancesUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:185

get

get(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesGetOptionalParams): Promise<ManagedInstance>
Gets a managed instance.
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.
- Optional options: ManagedInstancesGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:96

list

list(options?: ManagedInstancesListOptionalParams): PagedAsyncIterableIterator<ManagedInstance>
Gets a list of all managed instances in the subscription.
Parameters
- Optional options: ManagedInstancesListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:40

listByInstancePool

listByInstancePool(resourceGroupName: string, instancePoolName: string, options?: ManagedInstancesListByInstancePoolOptionalParams): PagedAsyncIterableIterator<ManagedInstance>
Gets a list of all managed instances in an instance pool.
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.
- Optional options: ManagedInstancesListByInstancePoolOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:50

listByManagedInstance

listByManagedInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListByManagedInstanceOptionalParams): PagedAsyncIterableIterator<TopQueries>
Get top resource consuming queries of a managed instance.
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.
- Optional options: ManagedInstancesListByManagedInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TopQueries>
- Defined in operationsInterfaces/managedInstances.ts:84

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ManagedInstancesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ManagedInstance>
Gets a list of managed instances in a resource group.
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.
- Optional options: ManagedInstancesListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstance>
- Defined in operationsInterfaces/managedInstances.ts:61

listOutboundNetworkDependenciesByManagedInstance

listOutboundNetworkDependenciesByManagedInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>
Gets the collection of outbound network dependencies for the given managed instance.
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.
- Optional options: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<OutboundEnvironmentEndpoint>
- Defined in operationsInterfaces/managedInstances.ts:72

Interface ManagedInstances

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

parameters: ManagedInstance

Optional options: ManagedInstancesCreateOrUpdateOptionalParams

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

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

parameters: ManagedInstance

Optional options: ManagedInstancesCreateOrUpdateOptionalParams

Returns Promise<ManagedInstance>

beginDelete

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesDeleteOptionalParams

Returns Promise<void>

beginFailover

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesFailoverOptionalParams

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

beginFailoverAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesFailoverOptionalParams

Returns Promise<void>

beginStart

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesStartOptionalParams

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

beginStartAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesStartOptionalParams

Returns Promise<void>

beginStop

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesStopOptionalParams

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

beginStopAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstancesStopOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

parameters: ManagedInstanceUpdate

Optional options: ManagedInstancesUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

parameters: ManagedInstanceUpdate

Optional options: ManagedInstancesUpdateOptionalParams

`Optional` options: ManagedInstancesCreateOrUpdateOptionalParams

`Optional` options: ManagedInstancesCreateOrUpdateOptionalParams

`Optional` options: ManagedInstancesDeleteOptionalParams

`Optional` options: ManagedInstancesDeleteOptionalParams

`Optional` options: ManagedInstancesFailoverOptionalParams

`Optional` options: ManagedInstancesFailoverOptionalParams

`Optional` options: ManagedInstancesStartOptionalParams

`Optional` options: ManagedInstancesStartOptionalParams

`Optional` options: ManagedInstancesStopOptionalParams

`Optional` options: ManagedInstancesStopOptionalParams

`Optional` options: ManagedInstancesUpdateOptionalParams

`Optional` options: ManagedInstancesUpdateOptionalParams

`Optional` options: ManagedInstancesGetOptionalParams

`Optional` options: ManagedInstancesListOptionalParams

`Optional` options: ManagedInstancesListByInstancePoolOptionalParams

`Optional` options: ManagedInstancesListByManagedInstanceOptionalParams

`Optional` options: ManagedInstancesListByResourceGroupOptionalParams

`Optional` options: ManagedInstancesListOutboundNetworkDependenciesByManagedInstanceOptionalParams