Configurations interface

  • Reference
Package:
@azure/arm-advisor

Interface representing a Configurations.

Methods

createInResourceGroup(string, string, ConfigData, ConfigurationsCreateInResourceGroupOptionalParams)

Create/Overwrite Azure Advisor configuration.
createInSubscription(string, ConfigData, ConfigurationsCreateInSubscriptionOptionalParams)

Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.
listByResourceGroup(string, ConfigurationsListByResourceGroupOptionalParams)

Retrieve Azure Advisor configurations.
listBySubscription(ConfigurationsListBySubscriptionOptionalParams)

Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.

Method Details

createInResourceGroup(string, string, ConfigData, ConfigurationsCreateInResourceGroupOptionalParams)

Create/Overwrite Azure Advisor configuration.

function createInResourceGroup(configurationName: string, resourceGroup: string, configContract: ConfigData, options?: ConfigurationsCreateInResourceGroupOptionalParams): Promise<ConfigData>

Parameters

configurationName

string

Advisor configuration name. Value must be 'default'

resourceGroup

string

The name of the Azure resource group.

configContract
ConfigData

The Azure Advisor configuration data structure.

options
ConfigurationsCreateInResourceGroupOptionalParams

The options parameters.

Returns

Promise<ConfigData>

createInSubscription(string, ConfigData, ConfigurationsCreateInSubscriptionOptionalParams)

Create/Overwrite Azure Advisor configuration and also delete all configurations of contained resource groups.

function createInSubscription(configurationName: string, configContract: ConfigData, options?: ConfigurationsCreateInSubscriptionOptionalParams): Promise<ConfigData>

Parameters

configurationName

string

Advisor configuration name. Value must be 'default'

configContract
ConfigData

The Azure Advisor configuration data structure.

options
ConfigurationsCreateInSubscriptionOptionalParams

The options parameters.

Returns

Promise<ConfigData>

listByResourceGroup(string, ConfigurationsListByResourceGroupOptionalParams)

Retrieve Azure Advisor configurations.

function listByResourceGroup(resourceGroup: string, options?: ConfigurationsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConfigData, ConfigData[], PageSettings>

Parameters

resourceGroup

string

The name of the Azure resource group.

options
ConfigurationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConfigData, ConfigData[], PageSettings>

listBySubscription(ConfigurationsListBySubscriptionOptionalParams)

Retrieve Azure Advisor configurations and also retrieve configurations of contained resource groups.

function listBySubscription(options?: ConfigurationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ConfigData, ConfigData[], PageSettings>

Parameters

options
ConfigurationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConfigData, ConfigData[], PageSettings>