Share via

DscNodeOperations interface

  • Reference
Package:
@azure/arm-automation

Interface representing a DscNodeOperations.

Methods

delete(string, string, string, DscNodeDeleteOptionalParams)

Delete the dsc node identified by node id.
get(string, string, string, DscNodeGetOptionalParams)

Retrieve the dsc node identified by node id.
listByAutomationAccount(string, string, DscNodeListByAutomationAccountOptionalParams)

Retrieve a list of dsc nodes.
update(string, string, string, DscNodeUpdateParameters, DscNodeUpdateOptionalParams)

Update the dsc node.

Method Details

delete(string, string, string, DscNodeDeleteOptionalParams)

Delete the dsc node identified by node id.

function delete(resourceGroupName: string, automationAccountName: string, nodeId: string, options?: DscNodeDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

nodeId

string

The node id.

options
DscNodeDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, DscNodeGetOptionalParams)

Retrieve the dsc node identified by node id.

function get(resourceGroupName: string, automationAccountName: string, nodeId: string, options?: DscNodeGetOptionalParams): Promise<DscNode>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

nodeId

string

The node id.

options
DscNodeGetOptionalParams

The options parameters.

Returns

Promise<DscNode>

listByAutomationAccount(string, string, DscNodeListByAutomationAccountOptionalParams)

Retrieve a list of dsc nodes.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: DscNodeListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<DscNode, DscNode[], PageSettings>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
DscNodeListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DscNode, DscNode[], PageSettings>

update(string, string, string, DscNodeUpdateParameters, DscNodeUpdateOptionalParams)

Update the dsc node.

function update(resourceGroupName: string, automationAccountName: string, nodeId: string, dscNodeUpdateParameters: DscNodeUpdateParameters, options?: DscNodeUpdateOptionalParams): Promise<DscNode>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

nodeId

string

Parameters supplied to the update dsc node.

dscNodeUpdateParameters
DscNodeUpdateParameters

Parameters supplied to the update dsc node.

options
DscNodeUpdateOptionalParams

The options parameters.

Returns

Promise<DscNode>