Set-AzAdvisorConfiguration

Reference

Module:: Az.Advisor

Updates or creates the Azure Advisor Configuration.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Set-AzAdvisorConfiguration
   [-Exclude]
   [[-ResourceGroupName] <String>]
   [[-InputObject] <PsAzureAdvisorConfigurationData>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzAdvisorConfiguration
   [-Exclude]
   [-LowCpuThreshold] <Int32>
   [[-InputObject] <PsAzureAdvisorConfigurationData>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Used to update the configuration of the Azure Advisor. Two types of Configuration are present: Subscription level configuration and ResourceGroup level configuration.

Subscription level configuration: There can be only one Configuration for this type for a subscription. LowCpuThreshold and Exclude properties can be updated using this cmdlet. ResourceGroup level configuration: There can be only one configuration for each ResourceGroup. Only Exclude property can be updated using this cmdlet.

Examples

Example 1

PS C:\> Set-AzAdvisorConfiguration -LowCpuThreshold 10
Id         : /subscriptions/{user_subscription}/resourceGroups/resourceGroupName1/providers/Microsoft.Advisor/configurations/{user_subscription}
Name       : {user_subscription}
Properties : additionalProperties : null
             exclude :  False
             lowCpuThreshold : 10

Type       : Microsoft.Advisor/Configurations

Updates the configuration(lowCpuThreshold) for subscription level Configuration.

Example 2

PS C:\> Set-AzAdvisorConfiguration -LowCpuThreshold 15 -Exclude 
Id         : /subscriptions/{user_subscription}/resourceGroups/resourceGroupName1/providers/Microsoft.Advisor/configurations/{user_subscription}
Name       : {user_subscription}
Properties : additionalProperties : null
             exclude :  True
             lowCpuThreshold : 15

Type       : Microsoft.Advisor/Configurations

Updates the configuration(lowCpuThreshold, exclude) for subscription level Configuration and excludes from the recommendation generation.

Example 3

PS C:\> Set-AzAdvisorConfiguration -ResourceGroupName resourceGroupName1 -Exclude

Id         : /subscriptions/{user_subscription}/resourceGroups/resourceGroupName1/providers/Microsoft.Advisor/configurations/{user_subscription}-resourceGroupName1
Name       : {user_subscription}-resourceGroupName1
Properties : additionalProperties : null
             exclude :  True
             lowCpuThreshold : null

Type       : Microsoft.Advisor/Configurations

Updates the configuration(exclude) for resourceGroupName1 to be excluded in the recommendation generation.

Example 4

PS C:\> Get-AzAdvisorConfiguration | Set-AzAdvisorConfiguration -LowCpuThreshold 20
Id         : /subscriptions/{user_subscription}/resourceGroups/resourceGroupName1/providers/Microsoft.Advisor/configurations/{user_subscription}
Name       : {user_subscription}
Properties : additionalProperties : null
             exclude :  False
             lowCpuThreshold : 20

Type       : Microsoft.Advisor/Configurations

Updates the configuration for the given recommendation passed on from the pipeline.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Exclude

Exclude from the recommendation generation. If not specified exclude property will be set to false.

Type:	SwitchParameter
Position:	2
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

The powershell object type PsAzureAdvisorConfigurationData returned by Get-AzAdvisorConfiguration call.

Type:	PsAzureAdvisorConfigurationData
Position:	1
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-LowCpuThreshold

Value for Low Cpu threshold.

Type:	Int32
Accepted values:	0, 5, 10, 15, 20
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group name for the configuration.

Type:	String
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PsAzureAdvisorConfigurationData

Outputs