Share via

DscConfigurationOperations interface

  • Reference
Package:
@azure/arm-automation

Interface representing a DscConfigurationOperations.

Methods

createOrUpdate([string, string, string, "text/plain; charset=utf-8", string, Object] | [string, string, string, "application/json", DscConfigurationCreateOrUpdateParameters, Object])

Create the configuration identified by configuration name.
delete(string, string, string, DscConfigurationDeleteOptionalParams)

Delete the dsc configuration identified by configuration name.
get(string, string, string, DscConfigurationGetOptionalParams)

Retrieve the configuration identified by configuration name.
getContent(string, string, string, DscConfigurationGetContentOptionalParams)

Retrieve the configuration script identified by configuration name.
listByAutomationAccount(string, string, DscConfigurationListByAutomationAccountOptionalParams)

Retrieve a list of configurations.
update([string, string, string, "text/plain; charset=utf-8", Object] | [string, string, string, "application/json", Object])

Create the configuration identified by configuration name.

Method Details

createOrUpdate([string, string, string, "text/plain; charset=utf-8", string, Object] | [string, string, string, "application/json", DscConfigurationCreateOrUpdateParameters, Object])

Create the configuration identified by configuration name.

function createOrUpdate(args: [string, string, string, "text/plain; charset=utf-8", string, Object] | [string, string, string, "application/json", DscConfigurationCreateOrUpdateParameters, Object]): Promise<DscConfiguration>

Parameters

args

[string, string, string, "text/plain; charset=utf-8", string, Object] | [string, string, string, "application/json", DscConfigurationCreateOrUpdateParameters, Object]

Includes all the parameters for this operation.

Returns

Promise<DscConfiguration>

delete(string, string, string, DscConfigurationDeleteOptionalParams)

Delete the dsc configuration identified by configuration name.

function delete(resourceGroupName: string, automationAccountName: string, configurationName: string, options?: DscConfigurationDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

configurationName

string

The configuration name.

options
DscConfigurationDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, DscConfigurationGetOptionalParams)

Retrieve the configuration identified by configuration name.

function get(resourceGroupName: string, automationAccountName: string, configurationName: string, options?: DscConfigurationGetOptionalParams): Promise<DscConfiguration>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

configurationName

string

The configuration name.

options
DscConfigurationGetOptionalParams

The options parameters.

Returns

Promise<DscConfiguration>

getContent(string, string, string, DscConfigurationGetContentOptionalParams)

Retrieve the configuration script identified by configuration name.

function getContent(resourceGroupName: string, automationAccountName: string, configurationName: string, options?: DscConfigurationGetContentOptionalParams): Promise<DscConfigurationGetContentResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

configurationName

string

The configuration name.

options
DscConfigurationGetContentOptionalParams

The options parameters.

Returns

Promise<DscConfigurationGetContentResponse>

listByAutomationAccount(string, string, DscConfigurationListByAutomationAccountOptionalParams)

Retrieve a list of configurations.

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

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
DscConfigurationListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DscConfiguration, DscConfiguration[], PageSettings>

update([string, string, string, "text/plain; charset=utf-8", Object] | [string, string, string, "application/json", Object])

Create the configuration identified by configuration name.

function update(args: [string, string, string, "text/plain; charset=utf-8", Object] | [string, string, string, "application/json", Object]): Promise<DscConfiguration>

Parameters

args

[string, string, string, "text/plain; charset=utf-8", Object] | [string, string, string, "application/json", Object]

Includes all the parameters for this operation.

Returns

Promise<DscConfiguration>