TuningConfiguration interface

Package:

@azure/arm-postgresql-flexible

Interface representing a TuningConfiguration.

Methods

beginDisable(string, string, string, TuningConfigurationDisableOptionalParams)	Disables the config tuning.
beginDisableAndWait(string, string, string, TuningConfigurationDisableOptionalParams)	Disables the config tuning.
beginEnable(string, string, string, TuningConfigurationEnableOptionalParams)	Enables the config tuning.
beginEnableAndWait(string, string, string, TuningConfigurationEnableOptionalParams)	Enables the config tuning.
beginStartSession(string, string, string, ConfigTuningRequestParameter, TuningConfigurationStartSessionOptionalParams)	Starts up the config tuning session.
beginStartSessionAndWait(string, string, string, ConfigTuningRequestParameter, TuningConfigurationStartSessionOptionalParams)	Starts up the config tuning session.
beginStopSession(string, string, string, TuningConfigurationStopSessionOptionalParams)	Stops the config tuning session.
beginStopSessionAndWait(string, string, string, TuningConfigurationStopSessionOptionalParams)	Stops the config tuning session.
listSessionDetails(string, string, string, string, TuningConfigurationListSessionDetailsOptionalParams)	Gets the session details of a config tuning session.
listSessions(string, string, string, TuningConfigurationListSessionsOptionalParams)	Gets up the config tuning session status.

Method Details

beginDisable(string, string, string, TuningConfigurationDisableOptionalParams)

Disables the config tuning.

function beginDisable(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationDisableOptionalParams): Promise<SimplePollerLike<OperationState<TuningConfigurationDisableHeaders>, TuningConfigurationDisableHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationDisableOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TuningConfigurationDisableHeaders>, TuningConfigurationDisableHeaders>>

beginDisableAndWait(string, string, string, TuningConfigurationDisableOptionalParams)

Disables the config tuning.

function beginDisableAndWait(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationDisableOptionalParams): Promise<TuningConfigurationDisableHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationDisableOptionalParams

The options parameters.

Returns

Promise<TuningConfigurationDisableHeaders>

beginEnable(string, string, string, TuningConfigurationEnableOptionalParams)

Enables the config tuning.

function beginEnable(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationEnableOptionalParams): Promise<SimplePollerLike<OperationState<TuningConfigurationEnableHeaders>, TuningConfigurationEnableHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationEnableOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TuningConfigurationEnableHeaders>, TuningConfigurationEnableHeaders>>

beginEnableAndWait(string, string, string, TuningConfigurationEnableOptionalParams)

Enables the config tuning.

function beginEnableAndWait(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationEnableOptionalParams): Promise<TuningConfigurationEnableHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationEnableOptionalParams

The options parameters.

Returns

Promise<TuningConfigurationEnableHeaders>

beginStartSession(string, string, string, ConfigTuningRequestParameter, TuningConfigurationStartSessionOptionalParams)

Starts up the config tuning session.

function beginStartSession(resourceGroupName: string, serverName: string, tuningOption: string, configTuningRequest: ConfigTuningRequestParameter, options?: TuningConfigurationStartSessionOptionalParams): Promise<SimplePollerLike<OperationState<TuningConfigurationStartSessionHeaders>, TuningConfigurationStartSessionHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

configTuningRequest

ConfigTuningRequestParameter

The parameters for tuning request.

options

TuningConfigurationStartSessionOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TuningConfigurationStartSessionHeaders>, TuningConfigurationStartSessionHeaders>>

beginStartSessionAndWait(string, string, string, ConfigTuningRequestParameter, TuningConfigurationStartSessionOptionalParams)

Starts up the config tuning session.

function beginStartSessionAndWait(resourceGroupName: string, serverName: string, tuningOption: string, configTuningRequest: ConfigTuningRequestParameter, options?: TuningConfigurationStartSessionOptionalParams): Promise<TuningConfigurationStartSessionHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

configTuningRequest

ConfigTuningRequestParameter

The parameters for tuning request.

options

TuningConfigurationStartSessionOptionalParams

The options parameters.

Returns

Promise<TuningConfigurationStartSessionHeaders>

beginStopSession(string, string, string, TuningConfigurationStopSessionOptionalParams)

Stops the config tuning session.

function beginStopSession(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationStopSessionOptionalParams): Promise<SimplePollerLike<OperationState<TuningConfigurationStopSessionHeaders>, TuningConfigurationStopSessionHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationStopSessionOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<TuningConfigurationStopSessionHeaders>, TuningConfigurationStopSessionHeaders>>

beginStopSessionAndWait(string, string, string, TuningConfigurationStopSessionOptionalParams)

Stops the config tuning session.

function beginStopSessionAndWait(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationStopSessionOptionalParams): Promise<TuningConfigurationStopSessionHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationStopSessionOptionalParams

The options parameters.

Returns

Promise<TuningConfigurationStopSessionHeaders>

listSessionDetails(string, string, string, string, TuningConfigurationListSessionDetailsOptionalParams)

Gets the session details of a config tuning session.

function listSessionDetails(resourceGroupName: string, serverName: string, tuningOption: string, sessionId: string, options?: TuningConfigurationListSessionDetailsOptionalParams): PagedAsyncIterableIterator<SessionDetailsResource, SessionDetailsResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

sessionId

string

Guid of the objectId for the session.

options

TuningConfigurationListSessionDetailsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SessionDetailsResource, SessionDetailsResource[], PageSettings>

listSessions(string, string, string, TuningConfigurationListSessionsOptionalParams)

Gets up the config tuning session status.

function listSessions(resourceGroupName: string, serverName: string, tuningOption: string, options?: TuningConfigurationListSessionsOptionalParams): PagedAsyncIterableIterator<SessionResource, SessionResource[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serverName

string

The name of the server.

tuningOption

string

The name of the tuning option.

options

TuningConfigurationListSessionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SessionResource, SessionResource[], PageSettings>