NGroupsOperations interface

Interface representing a NGroups operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

Create or update a NGroups resource.

delete

Deletes the NGroups resource.

get

Get the properties of the specified NGroups resource.

list

Gets a list of all NGroups resources under a subscription.

listByResourceGroup

Gets a list of all NGroups resources under a resource group.

restart

Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.

start

Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.

stop

Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.

update

Update a specified NGroups resource.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<NGroup>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<NGroup>

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => Promise<void>

beginRestart

Warning

This API is now deprecated.

use restart instead

beginRestart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

beginRestartAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<NGroup>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<NGroup>

createOrUpdate

Create or update a NGroups resource.

createOrUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>

delete

Deletes the NGroups resource.

delete: (resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get the properties of the specified NGroups resource.

get: (resourceGroupName: string, ngroupsName: string, options?: NGroupsGetOptionalParams) => Promise<NGroup>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsGetOptionalParams) => Promise<NGroup>

list

Gets a list of all NGroups resources under a subscription.

list: (options?: NGroupsListOptionalParams) => PagedAsyncIterableIterator<NGroup, NGroup[], PageSettings>

Property Value

(options?: NGroupsListOptionalParams) => PagedAsyncIterableIterator<NGroup, NGroup[], PageSettings>

listByResourceGroup

Gets a list of all NGroups resources under a resource group.

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

Property Value

(resourceGroupName: string, options?: NGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NGroup, NGroup[], PageSettings>

restart

Restarts all container groups in the specified NGroups resource in place. If container image has updates, new image will be downloaded.

restart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts all container groups in the specified NGroups resource. Compute resources will be allocated and billing will start.

start: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

Stops all container groups in the specified NGroups resource. Compute resources will be deallocated and billing will stop.

stop: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStopOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, ngroupsName: string, options?: NGroupsStopOptionalParams) => Promise<void>

update

Update a specified NGroups resource.

update: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>

Property Value

(resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>