MachineGroups interface

Interface representing a MachineGroups.

Methods

create(string, string, MachineGroup, MachineGroupsCreateOptionalParams)

Creates a new machine group.

delete(string, string, string, MachineGroupsDeleteOptionalParams)

Deletes the specified Machine Group.

get(string, string, string, MachineGroupsGetOptionalParams)

Returns the specified machine group as it existed during the specified time interval.

listByWorkspace(string, string, MachineGroupsListByWorkspaceOptionalParams)

Returns all machine groups during the specified time interval.

update(string, string, string, MachineGroup, MachineGroupsUpdateOptionalParams)

Updates a machine group.

Method Details

create(string, string, MachineGroup, MachineGroupsCreateOptionalParams)

Creates a new machine group.

function create(resourceGroupName: string, workspaceName: string, machineGroup: MachineGroup, options?: MachineGroupsCreateOptionalParams): Promise<MachineGroup>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineGroup
MachineGroup

Machine Group resource to create.

options
MachineGroupsCreateOptionalParams

The options parameters.

Returns

Promise<MachineGroup>

delete(string, string, string, MachineGroupsDeleteOptionalParams)

Deletes the specified Machine Group.

function delete(resourceGroupName: string, workspaceName: string, machineGroupName: string, options?: MachineGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineGroupName

string

Machine Group resource name.

options
MachineGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, MachineGroupsGetOptionalParams)

Returns the specified machine group as it existed during the specified time interval.

function get(resourceGroupName: string, workspaceName: string, machineGroupName: string, options?: MachineGroupsGetOptionalParams): Promise<MachineGroup>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineGroupName

string

Machine Group resource name.

options
MachineGroupsGetOptionalParams

The options parameters.

Returns

Promise<MachineGroup>

listByWorkspace(string, string, MachineGroupsListByWorkspaceOptionalParams)

Returns all machine groups during the specified time interval.

function listByWorkspace(resourceGroupName: string, workspaceName: string, options?: MachineGroupsListByWorkspaceOptionalParams): PagedAsyncIterableIterator<MachineGroup, MachineGroup[], PageSettings>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

options
MachineGroupsListByWorkspaceOptionalParams

The options parameters.

Returns

update(string, string, string, MachineGroup, MachineGroupsUpdateOptionalParams)

Updates a machine group.

function update(resourceGroupName: string, workspaceName: string, machineGroupName: string, machineGroup: MachineGroup, options?: MachineGroupsUpdateOptionalParams): Promise<MachineGroup>

Parameters

resourceGroupName

string

Resource group name within the specified subscriptionId.

workspaceName

string

OMS workspace containing the resources of interest.

machineGroupName

string

Machine Group resource name.

machineGroup
MachineGroup

Machine Group resource to update.

options
MachineGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<MachineGroup>