IngestionSettings interface

Package:

@azure/arm-security

Interface representing a IngestionSettings.

Methods

create(string, IngestionSetting, IngestionSettingsCreateOptionalParams)	Create setting for ingesting security data and logs to correlate with resources associated with the subscription.
delete(string, IngestionSettingsDeleteOptionalParams)	Deletes the ingestion settings for this subscription.
get(string, IngestionSettingsGetOptionalParams)	Settings for ingesting security data and logs to correlate with resources associated with the subscription.
list(IngestionSettingsListOptionalParams)	Settings for ingesting security data and logs to correlate with resources associated with the subscription.
listConnectionStrings(string, IngestionSettingsListConnectionStringsOptionalParams)	Connection strings for ingesting security scan logs and data.
listTokens(string, IngestionSettingsListTokensOptionalParams)	Returns the token that is used for correlating ingested telemetry with the resources in the subscription.

Method Details

create(string, IngestionSetting, IngestionSettingsCreateOptionalParams)

Create setting for ingesting security data and logs to correlate with resources associated with the subscription.

function create(ingestionSettingName: string, ingestionSetting: IngestionSetting, options?: IngestionSettingsCreateOptionalParams): Promise<IngestionSetting>

Parameters

ingestionSettingName

string

Name of the ingestion setting

ingestionSetting

IngestionSetting

Ingestion setting object

options

IngestionSettingsCreateOptionalParams

The options parameters.

Returns

Promise<IngestionSetting>

delete(string, IngestionSettingsDeleteOptionalParams)

Deletes the ingestion settings for this subscription.

function delete(ingestionSettingName: string, options?: IngestionSettingsDeleteOptionalParams): Promise<void>

Parameters

ingestionSettingName

string

Name of the ingestion setting

options

IngestionSettingsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, IngestionSettingsGetOptionalParams)

Settings for ingesting security data and logs to correlate with resources associated with the subscription.

function get(ingestionSettingName: string, options?: IngestionSettingsGetOptionalParams): Promise<IngestionSetting>

Parameters

ingestionSettingName

string

Name of the ingestion setting

options

IngestionSettingsGetOptionalParams

The options parameters.

Returns

Promise<IngestionSetting>

list(IngestionSettingsListOptionalParams)

Settings for ingesting security data and logs to correlate with resources associated with the subscription.

function list(options?: IngestionSettingsListOptionalParams): PagedAsyncIterableIterator<IngestionSetting, IngestionSetting[], PageSettings>

Parameters

options

IngestionSettingsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IngestionSetting, IngestionSetting[], PageSettings>

listConnectionStrings(string, IngestionSettingsListConnectionStringsOptionalParams)

Connection strings for ingesting security scan logs and data.

function listConnectionStrings(ingestionSettingName: string, options?: IngestionSettingsListConnectionStringsOptionalParams): Promise<ConnectionStrings>

Parameters

ingestionSettingName

string

Name of the ingestion setting

options

IngestionSettingsListConnectionStringsOptionalParams

The options parameters.

Returns

Promise<ConnectionStrings>

listTokens(string, IngestionSettingsListTokensOptionalParams)

Returns the token that is used for correlating ingested telemetry with the resources in the subscription.

function listTokens(ingestionSettingName: string, options?: IngestionSettingsListTokensOptionalParams): Promise<IngestionSettingToken>

Parameters

ingestionSettingName

string

Name of the ingestion setting

options

IngestionSettingsListTokensOptionalParams

The options parameters.

Returns

Promise<IngestionSettingToken>