Automations interface

Interface representing a Automations.

Methods

createOrUpdate(string, string, Automation, AutomationsCreateOrUpdateOptionalParams)

Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.

delete(string, string, AutomationsDeleteOptionalParams)

Deletes a security automation.

get(string, string, AutomationsGetOptionalParams)

Retrieves information about the model of a security automation.

list(AutomationsListOptionalParams)

Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.

listByResourceGroup(string, AutomationsListByResourceGroupOptionalParams)

Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.

update(string, string, AutomationUpdateModel, AutomationsUpdateOptionalParams)

Updates a security automation

validate(string, string, Automation, AutomationsValidateOptionalParams)

Validates the security automation model before create or update. Any validation errors are returned to the client.

Method Details

createOrUpdate(string, string, Automation, AutomationsCreateOrUpdateOptionalParams)

Creates or updates a security automation. If a security automation is already created and a subsequent request is issued for the same automation id, then it will be updated.

function createOrUpdate(resourceGroupName: string, automationName: string, automation: Automation, options?: AutomationsCreateOrUpdateOptionalParams): Promise<Automation>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

automationName

string

The security automation name.

automation
Automation

The security automation resource

options
AutomationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Automation>

delete(string, string, AutomationsDeleteOptionalParams)

Deletes a security automation.

function delete(resourceGroupName: string, automationName: string, options?: AutomationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

automationName

string

The security automation name.

options
AutomationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, AutomationsGetOptionalParams)

Retrieves information about the model of a security automation.

function get(resourceGroupName: string, automationName: string, options?: AutomationsGetOptionalParams): Promise<Automation>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

automationName

string

The security automation name.

options
AutomationsGetOptionalParams

The options parameters.

Returns

Promise<Automation>

list(AutomationsListOptionalParams)

Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.

function list(options?: AutomationsListOptionalParams): PagedAsyncIterableIterator<Automation, Automation[], PageSettings>

Parameters

options
AutomationsListOptionalParams

The options parameters.

Returns

listByResourceGroup(string, AutomationsListByResourceGroupOptionalParams)

Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: AutomationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Automation, Automation[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options
AutomationsListByResourceGroupOptionalParams

The options parameters.

Returns

update(string, string, AutomationUpdateModel, AutomationsUpdateOptionalParams)

Updates a security automation

function update(resourceGroupName: string, automationName: string, automation: AutomationUpdateModel, options?: AutomationsUpdateOptionalParams): Promise<Automation>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

automationName

string

The security automation name.

automation
AutomationUpdateModel

The update model of security automation resource

options
AutomationsUpdateOptionalParams

The options parameters.

Returns

Promise<Automation>

validate(string, string, Automation, AutomationsValidateOptionalParams)

Validates the security automation model before create or update. Any validation errors are returned to the client.

function validate(resourceGroupName: string, automationName: string, automation: Automation, options?: AutomationsValidateOptionalParams): Promise<AutomationValidationStatus>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

automationName

string

The security automation name.

automation
Automation

The security automation resource

options
AutomationsValidateOptionalParams

The options parameters.

Returns