azure.mgmt.advisor.models module

class azure.mgmt.advisor.models.ARMErrorResponseBody(*, message: Optional[str] = None, code: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

ARM error response body.

Variables

  • message (str) – Gets or sets the string that describes the error in detail and provides debugging information.

  • code (str) – Gets or sets the string that can be used to programmatically identify the error.

Keyword Arguments

  • message (str) – Gets or sets the string that describes the error in detail and provides debugging information.

  • code (str) – Gets or sets the string that can be used to programmatically identify the error.

class azure.mgmt.advisor.models.ArmErrorResponse(*, error: Optional[_models.ARMErrorResponseBody] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

ArmErrorResponse.

Variables

error (ARMErrorResponseBody) – ARM error response body.

Keyword Arguments

error (ARMErrorResponseBody) – ARM error response body.

class azure.mgmt.advisor.models.Category(value)[source]

Bases: str, enum.Enum

Category.

COST = 'Cost'
HIGH_AVAILABILITY = 'HighAvailability'
OPERATIONAL_EXCELLENCE = 'OperationalExcellence'
PERFORMANCE = 'Performance'
SECURITY = 'Security'
class azure.mgmt.advisor.models.ConfigData(*, exclude: Optional[bool] = None, low_cpu_threshold: Optional[Union[str, _models.CpuThreshold]] = None, digests: Optional[List[_models.DigestConfig]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor.models._models_py3.Resource

The Advisor configuration data structure.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • exclude (bool) – Exclude the resource from Advisor evaluations. Valid values: False (default) or True.

  • low_cpu_threshold (str or CpuThreshold) – Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. Known values are: “5”, “10”, “15”, and “20”.

  • digests (list[DigestConfig]) – Advisor digest configuration. Valid only for subscriptions.

Keyword Arguments

  • exclude (bool) – Exclude the resource from Advisor evaluations. Valid values: False (default) or True.

  • low_cpu_threshold (str or CpuThreshold) – Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20. Known values are: “5”, “10”, “15”, and “20”.

  • digests (list[DigestConfig]) – Advisor digest configuration. Valid only for subscriptions.

class azure.mgmt.advisor.models.ConfigurationListResult(*, value: Optional[List[_models.ConfigData]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The list of Advisor configurations.

Variables

  • value (list[ConfigData]) – The list of configurations.

  • next_link (str) – The link used to get the next page of configurations.

Keyword Arguments

  • value (list[ConfigData]) – The list of configurations.

  • next_link (str) – The link used to get the next page of configurations.

class azure.mgmt.advisor.models.ConfigurationName(value)[source]

Bases: str, enum.Enum

ConfigurationName.

DEFAULT = 'default'
class azure.mgmt.advisor.models.CpuThreshold(value)[source]

Bases: str, enum.Enum

Minimum percentage threshold for Advisor low CPU utilization evaluation. Valid only for subscriptions. Valid values: 5 (default), 10, 15 or 20.

FIFTEEN = '15'
FIVE = '5'
TEN = '10'
TWENTY = '20'
class azure.mgmt.advisor.models.DigestConfig(*, name: Optional[str] = None, action_group_resource_id: Optional[str] = None, frequency: Optional[int] = None, categories: Optional[List[Union[str, _models.Category]]] = None, language: Optional[str] = None, state: Optional[Union[str, _models.DigestConfigState]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

Advisor Digest configuration entity.

Variables

  • name (str) – Name of digest configuration. Value is case-insensitive and must be unique within a subscription.

  • action_group_resource_id (str) – Action group resource id used by digest.

  • frequency (int) – Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive.

  • categories (list[str or Category]) – Categories to send digest for. If categories are not provided, then digest will be sent for all categories.

  • language (str) – Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en).

  • state (str or DigestConfigState) – State of digest configuration. Known values are: “Active” and “Disabled”.

Keyword Arguments

  • name (str) – Name of digest configuration. Value is case-insensitive and must be unique within a subscription.

  • action_group_resource_id (str) – Action group resource id used by digest.

  • frequency (int) – Frequency that digest will be triggered, in days. Value must be between 7 and 30 days inclusive.

  • categories (list[str or Category]) – Categories to send digest for. If categories are not provided, then digest will be sent for all categories.

  • language (str) – Language for digest content body. Value must be ISO 639-1 code for one of Azure portal supported languages. Otherwise, it will be converted into one. Default value is English (en).

  • state (str or DigestConfigState) – State of digest configuration. Known values are: “Active” and “Disabled”.

class azure.mgmt.advisor.models.DigestConfigState(value)[source]

Bases: str, enum.Enum

State of digest configuration.

ACTIVE = 'Active'
DISABLED = 'Disabled'
class azure.mgmt.advisor.models.Impact(value)[source]

Bases: str, enum.Enum

The business impact of the recommendation.

HIGH = 'High'
LOW = 'Low'
MEDIUM = 'Medium'
class azure.mgmt.advisor.models.MetadataEntity(*, id: Optional[str] = None, type: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, depends_on: Optional[List[str]] = None, applicable_scenarios: Optional[List[Union[str, _models.Scenario]]] = None, supported_values: Optional[List[_models.MetadataSupportedValueDetail]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The metadata entity contract.

Variables

  • id (str) – The resource Id of the metadata entity.

  • type (str) – The type of the metadata entity.

  • name (str) – The name of the metadata entity.

  • display_name (str) – The display name.

  • depends_on (list[str]) – The list of keys on which this entity depends on.

  • applicable_scenarios (list[str or Scenario]) – The list of scenarios applicable to this metadata entity.

  • supported_values (list[MetadataSupportedValueDetail]) – The list of supported values.

Keyword Arguments

  • id (str) – The resource Id of the metadata entity.

  • type (str) – The type of the metadata entity.

  • name (str) – The name of the metadata entity.

  • display_name (str) – The display name.

  • depends_on (list[str]) – The list of keys on which this entity depends on.

  • applicable_scenarios (list[str or Scenario]) – The list of scenarios applicable to this metadata entity.

  • supported_values (list[MetadataSupportedValueDetail]) – The list of supported values.

class azure.mgmt.advisor.models.MetadataEntityListResult(*, value: Optional[List[_models.MetadataEntity]] = None, next_link: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The list of metadata entities.

Variables

  • value (list[MetadataEntity]) – The list of metadata entities.

  • next_link (str) – The link used to get the next page of metadata.

Keyword Arguments

  • value (list[MetadataEntity]) – The list of metadata entities.

  • next_link (str) – The link used to get the next page of metadata.

class azure.mgmt.advisor.models.MetadataSupportedValueDetail(*, id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The metadata supported value detail.

Variables

  • id (str) – The id.

  • display_name (str) – The display name.

Keyword Arguments

  • id (str) – The id.

  • display_name (str) – The display name.

class azure.mgmt.advisor.models.OperationDisplayInfo(*, description: Optional[str] = None, operation: Optional[str] = None, provider: Optional[str] = None, resource: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The operation supported by Advisor.

Variables

  • description (str) – The description of the operation.

  • operation (str) – The action that users can perform, based on their permission level.

  • provider (str) – Service provider: Microsoft Advisor.

  • resource (str) – Resource on which the operation is performed.

Keyword Arguments

  • description (str) – The description of the operation.

  • operation (str) – The action that users can perform, based on their permission level.

  • provider (str) – Service provider: Microsoft Advisor.

  • resource (str) – Resource on which the operation is performed.

class azure.mgmt.advisor.models.OperationEntity(*, name: Optional[str] = None, display: Optional[_models.OperationDisplayInfo] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The operation supported by Advisor.

Variables

  • name (str) – Operation name: {provider}/{resource}/{operation}.

  • display (OperationDisplayInfo) – The operation supported by Advisor.

Keyword Arguments

  • name (str) – Operation name: {provider}/{resource}/{operation}.

  • display (OperationDisplayInfo) – The operation supported by Advisor.

class azure.mgmt.advisor.models.OperationEntityListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.OperationEntity]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The list of Advisor operations.

Variables

  • next_link (str) – The link used to get the next page of operations.

  • value (list[OperationEntity]) – The list of operations.

Keyword Arguments

  • next_link (str) – The link used to get the next page of operations.

  • value (list[OperationEntity]) – The list of operations.

class azure.mgmt.advisor.models.Resource(**kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

An Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

class azure.mgmt.advisor.models.ResourceMetadata(*, resource_id: Optional[str] = None, source: Optional[str] = None, action: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, singular: Optional[str] = None, plural: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

Recommendation resource metadata.

Variables

  • resource_id (str) – Azure resource Id of the assessed resource.

  • source (str) – Source from which recommendation is generated.

  • action (dict[str, JSON]) – The action to view resource.

  • singular (str) – The singular user friendly name of resource type. eg: virtual machine.

  • plural (str) – The plural user friendly name of resource type. eg: virtual machines.

Keyword Arguments

  • resource_id (str) – Azure resource Id of the assessed resource.

  • source (str) – Source from which recommendation is generated.

  • action (dict[str, JSON]) – The action to view resource.

  • singular (str) – The singular user friendly name of resource type. eg: virtual machine.

  • plural (str) – The plural user friendly name of resource type. eg: virtual machines.

class azure.mgmt.advisor.models.ResourceRecommendationBase(*, category: Optional[Union[str, _models.Category]] = None, impact: Optional[Union[str, _models.Impact]] = None, impacted_field: Optional[str] = None, impacted_value: Optional[str] = None, last_updated: Optional[datetime.datetime] = None, metadata: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, recommendation_type_id: Optional[str] = None, short_description: Optional[_models.ShortDescription] = None, suppression_ids: Optional[List[str]] = None, extended_properties: Optional[Dict[str, str]] = None, resource_metadata: Optional[_models.ResourceMetadata] = None, description: Optional[str] = None, label: Optional[str] = None, learn_more_link: Optional[str] = None, potential_benefits: Optional[str] = None, actions: Optional[List[Dict[str, collections.abc.MutableMapping[str, Any]]]] = None, remediation: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, exposed_metadata_properties: Optional[Dict[str, collections.abc.MutableMapping[str, Any]]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor.models._models_py3.Resource

Advisor Recommendation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • category (str or Category) – The category of the recommendation. Known values are: “HighAvailability”, “Security”, “Performance”, “Cost”, and “OperationalExcellence”.

  • impact (str or Impact) – The business impact of the recommendation. Known values are: “High”, “Medium”, and “Low”.

  • impacted_field (str) – The resource type identified by Advisor.

  • impacted_value (str) – The resource identified by Advisor.

  • last_updated (datetime) – The most recent time that Advisor checked the validity of the recommendation.

  • metadata (dict[str, JSON]) – The recommendation metadata.

  • recommendation_type_id (str) – The recommendation-type GUID.

  • short_description (ShortDescription) – A summary of the recommendation.

  • suppression_ids (list[str]) – The list of snoozed and dismissed rules for the recommendation.

  • extended_properties (dict[str, str]) – Extended properties.

  • resource_metadata (ResourceMetadata) – Metadata of resource that was assessed.

  • description (str) – The detailed description of recommendation.

  • label (str) – The label of recommendation.

  • learn_more_link (str) – The link to learn more about recommendation and generation logic.

  • potential_benefits (str) – The potential benefit of implementing recommendation.

  • actions (list[dict[str, JSON]]) – The list of recommended actions to implement recommendation.

  • remediation (dict[str, JSON]) – The automated way to apply recommendation.

  • exposed_metadata_properties (dict[str, JSON]) – The recommendation metadata properties exposed to customer to provide additional information.

Keyword Arguments

  • category (str or Category) – The category of the recommendation. Known values are: “HighAvailability”, “Security”, “Performance”, “Cost”, and “OperationalExcellence”.

  • impact (str or Impact) – The business impact of the recommendation. Known values are: “High”, “Medium”, and “Low”.

  • impacted_field (str) – The resource type identified by Advisor.

  • impacted_value (str) – The resource identified by Advisor.

  • last_updated (datetime) – The most recent time that Advisor checked the validity of the recommendation.

  • metadata (dict[str, JSON]) – The recommendation metadata.

  • recommendation_type_id (str) – The recommendation-type GUID.

  • short_description (ShortDescription) – A summary of the recommendation.

  • suppression_ids (list[str]) – The list of snoozed and dismissed rules for the recommendation.

  • extended_properties (dict[str, str]) – Extended properties.

  • resource_metadata (ResourceMetadata) – Metadata of resource that was assessed.

  • description (str) – The detailed description of recommendation.

  • label (str) – The label of recommendation.

  • learn_more_link (str) – The link to learn more about recommendation and generation logic.

  • potential_benefits (str) – The potential benefit of implementing recommendation.

  • actions (list[dict[str, JSON]]) – The list of recommended actions to implement recommendation.

  • remediation (dict[str, JSON]) – The automated way to apply recommendation.

  • exposed_metadata_properties (dict[str, JSON]) – The recommendation metadata properties exposed to customer to provide additional information.

class azure.mgmt.advisor.models.ResourceRecommendationBaseListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.ResourceRecommendationBase]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The list of Advisor recommendations.

Variables
Keyword Arguments
class azure.mgmt.advisor.models.Scenario(value)[source]

Bases: str, enum.Enum

Scenario.

ALERTS = 'Alerts'
class azure.mgmt.advisor.models.ShortDescription(*, problem: Optional[str] = None, solution: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

A summary of the recommendation.

Variables

  • problem (str) – The issue or opportunity identified by the recommendation and proposed solution.

  • solution (str) – The issue or opportunity identified by the recommendation and proposed solution.

Keyword Arguments

  • problem (str) – The issue or opportunity identified by the recommendation and proposed solution.

  • solution (str) – The issue or opportunity identified by the recommendation and proposed solution.

class azure.mgmt.advisor.models.SuppressionContract(*, suppression_id: Optional[str] = None, ttl: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.advisor.models._models_py3.Resource

The details of the snoozed or dismissed rule; for example, the duration, name, and GUID associated with the rule.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – The resource ID.

  • name (str) – The name of the resource.

  • type (str) – The type of the resource.

  • suppression_id (str) – The GUID of the suppression.

  • ttl (str) – The duration for which the suppression is valid.

  • expiration_time_stamp (datetime) – Gets or sets the expiration time stamp.

Keyword Arguments

  • suppression_id (str) – The GUID of the suppression.

  • ttl (str) – The duration for which the suppression is valid.

class azure.mgmt.advisor.models.SuppressionContractListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.SuppressionContract]] = None, **kwargs)[source]

Bases: azure.mgmt.advisor._serialization.Model

The list of Advisor suppressions.

Variables

  • next_link (str) – The link used to get the next page of suppressions.

  • value (list[SuppressionContract]) – The list of suppressions.

Keyword Arguments

  • next_link (str) – The link used to get the next page of suppressions.

  • value (list[SuppressionContract]) – The list of suppressions.