azure.mgmt.cloudhealth.models module
- class azure.mgmt.cloudhealth.models.ActionType(*values)[source]
-
Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.
- INTERNAL = 'Internal'
Actions are for internal-only APIs.
- class azure.mgmt.cloudhealth.models.AlertConfiguration(*args: Any, **kwargs: Any)[source]
Bases:
Model
Alert configuration details.
- Variables:
severity (str or AlertSeverity) – The severity of triggered alert. Required. Known values are: “Sev0”, “Sev1”, “Sev2”, “Sev3”, and “Sev4”.
description (str) – The alert rule description.
action_group_ids (list[str]) – Optional list of action group resource IDs to be notified when the alert is triggered.
- class azure.mgmt.cloudhealth.models.AlertSeverity(*values)[source]
-
Severity of an alert.
- SEV0 = 'Sev0'
Critical
- SEV1 = 'Sev1'
Error
- SEV2 = 'Sev2'
Warning
- SEV3 = 'Sev3'
Informational
- SEV4 = 'Sev4'
Verbose
- class azure.mgmt.cloudhealth.models.AuthenticationKind(*values)[source]
-
Supported kinds of authentication settings as discriminator.
- MANAGED_IDENTITY = 'ManagedIdentity'
- class azure.mgmt.cloudhealth.models.AuthenticationSetting(*args: Any, **kwargs: Any)[source]
Bases:
ProxyResource
An authentication setting in a health model.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (AuthenticationSettingProperties) – The resource-specific properties for this resource.
- properties: _models.AuthenticationSettingProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.AuthenticationSettingProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
Authentication setting properties.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ManagedIdentityAuthenticationSettingProperties
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
authentication_kind (str or AuthenticationKind) – Kind of the authentication setting. Required. “ManagedIdentity”
- class azure.mgmt.cloudhealth.models.AzureMonitorWorkspaceSignalGroup(*args: Any, **kwargs: Any)[source]
Bases:
Model
A grouping of signal assignments for a Azure Monitor Workspace.
- Variables:
signal_assignments (list[SignalAssignment]) – Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
authentication_setting (str) – Reference to the name of the authentication setting which is used for querying the data source. Required.
azure_monitor_workspace_resource_id (str) – Azure Monitor workspace resource ID. Required.
- authentication_setting: str
Reference to the name of the authentication setting which is used for querying the data source. Required.
- signal_assignments: List[_models.SignalAssignment] | None
Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
- class azure.mgmt.cloudhealth.models.AzureResourceSignalGroup(*args: Any, **kwargs: Any)[source]
Bases:
Model
A grouping of signal assignments for an Azure resource.
- Variables:
signal_assignments (list[SignalAssignment]) – Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
authentication_setting (str) – Reference to the name of the authentication setting which is used for querying the data source. Required.
azure_resource_id (str) – Azure resource ID. Required.
- authentication_setting: str
Reference to the name of the authentication setting which is used for querying the data source. Required.
- signal_assignments: List[_models.SignalAssignment] | None
Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
- class azure.mgmt.cloudhealth.models.CreatedByType(*values)[source]
-
The kind of entity that created the resource.
- APPLICATION = 'Application'
The entity was created by an application.
- KEY = 'Key'
The entity was created by a key.
- MANAGED_IDENTITY = 'ManagedIdentity'
The entity was created by a managed identity.
- USER = 'User'
The entity was created by a user.
- class azure.mgmt.cloudhealth.models.DependenciesAggregationType(*values)[source]
-
Aggregation type for child dependencies.
- THRESHOLDS = 'Thresholds'
Based on configurable thresholds.
- WORST_OF = 'WorstOf'
Worst child health state is propagated.
- Type:
Default behavior
- class azure.mgmt.cloudhealth.models.DependenciesSignalGroup(*args: Any, **kwargs: Any)[source]
Bases:
Model
Properties for dependent entities, i.e. child entities.
- Variables:
aggregation_type (str or DependenciesAggregationType) – Aggregation type for child dependencies. Required. Known values are: “WorstOf” and “Thresholds”.
degraded_threshold (str) – Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is ‘Thresholds’.
unhealthy_threshold (str) – Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is ‘Thresholds’.
- aggregation_type: str | _models.DependenciesAggregationType
“WorstOf” and “Thresholds”.
- Type:
Aggregation type for child dependencies. Required. Known values are
- degraded_threshold: str | None
Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is ‘Thresholds’.
- unhealthy_threshold: str | None
Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is ‘Thresholds’.
- class azure.mgmt.cloudhealth.models.DiscoveryRule(*args: Any, **kwargs: Any)[source]
Bases:
ProxyResource
A discovery rule which automatically finds entities and relationships in a health model based on an Azure Resource Graph query.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (DiscoveryRuleProperties) – The resource-specific properties for this resource.
- properties: _models.DiscoveryRuleProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.DiscoveryRuleProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
Discovery rule properties.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
resource_graph_query (str) – Azure Resource Graph query text in KQL syntax. The query must return at least a column named ‘id’ which contains the resource ID of the discovered resources. Required.
authentication_setting (str) – Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. Required.
discover_relationships (str or DiscoveryRuleRelationshipDiscoveryBehavior) – Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. Required. Known values are: “Enabled” and “Disabled”.
add_recommended_signals (str or DiscoveryRuleRecommendedSignalsBehavior) – Whether to add all recommended signals to the discovered entities. Required. Known values are: “Enabled” and “Disabled”.
deletion_date (datetime) – Date when the discovery rule was (soft-)deleted.
error_message (str) – Error message if the last discovery operation failed.
number_of_discovered_entities (int) – Number of discovered entities in the last discovery operation.
entity_name (str) – Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. Required.
- add_recommended_signals: str | _models.DiscoveryRuleRecommendedSignalsBehavior
Whether to add all recommended signals to the discovered entities. Required. Known values are: “Enabled” and “Disabled”.
- authentication_setting: str
Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. Required.
- discover_relationships: str | _models.DiscoveryRuleRelationshipDiscoveryBehavior
Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. Required. Known values are: “Enabled” and “Disabled”.
- entity_name: str
It might take a few minutes after creating the discovery rule until the entity is created. Required.
- Type:
Name of the entity which represents the discovery rule. Note
- number_of_discovered_entities: int | None
Number of discovered entities in the last discovery operation.
- class azure.mgmt.cloudhealth.models.DiscoveryRuleRecommendedSignalsBehavior(*values)[source]
-
Discovery rule recommended signal behavior.
- DISABLED = 'Disabled'
Do not automatically add recommended signals
- ENABLED = 'Enabled'
Automatically add recommended signals
- class azure.mgmt.cloudhealth.models.DiscoveryRuleRelationshipDiscoveryBehavior(*values)[source]
-
Discovery rule relationship discovery behavior.
- DISABLED = 'Disabled'
Do not automatically attempt to discover relationships
- ENABLED = 'Enabled'
Automatically attempt to discover relationships
- class azure.mgmt.cloudhealth.models.DynamicDetectionRule(*args: Any, **kwargs: Any)[source]
Bases:
Model
ML-based evaluation rule for a signal definition.
- Variables:
dynamic_threshold_model (str or DynamicThresholdModel) – ML model to use for dynamic thresholds. Required. “AnomalyDetection”
model_sensitivity (float) – ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5. Required.
dynamic_threshold_direction (str or DynamicThresholdDirection) – Threshold direction. Required. Known values are: “LowerThan”, “GreaterThan”, and “GreaterOrLowerThan”.
training_start_time (datetime) – Start time of the training in UTC.
- dynamic_threshold_direction: str | _models.DynamicThresholdDirection
“LowerThan”, “GreaterThan”, and “GreaterOrLowerThan”.
- Type:
Threshold direction. Required. Known values are
- dynamic_threshold_model: str | _models.DynamicThresholdModel
ML model to use for dynamic thresholds. Required. “AnomalyDetection”
- class azure.mgmt.cloudhealth.models.DynamicThresholdDirection(*values)[source]
-
Threshold direction for dynamic thresholds.
- GREATER_OR_LOWER_THAN = 'GreaterOrLowerThan'
Greater or Lower Than
- GREATER_THAN = 'GreaterThan'
Greater than
- LOWER_THAN = 'LowerThan'
Lower than
- class azure.mgmt.cloudhealth.models.DynamicThresholdModel(*values)[source]
-
ML-based model variants.
- ANOMALY_DETECTION = 'AnomalyDetection'
Anomaly detection model
- class azure.mgmt.cloudhealth.models.Entity(*args: Any, **kwargs: Any)[source]
Bases:
ProxyResource
An entity (aka node) of a health model.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (EntityProperties) – The resource-specific properties for this resource.
- properties: _models.EntityProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.EntityAlerts(*args: Any, **kwargs: Any)[source]
Bases:
Model
Alert configuration for an entity.
- Variables:
unhealthy (AlertConfiguration) – Alert to be triggered on state change to unhealthy.
degraded (AlertConfiguration) – Alert to be triggered on state change to degraded.
- degraded: _models.AlertConfiguration | None
Alert to be triggered on state change to degraded.
- unhealthy: _models.AlertConfiguration | None
Alert to be triggered on state change to unhealthy.
- class azure.mgmt.cloudhealth.models.EntityCoordinates(*args: Any, **kwargs: Any)[source]
Bases:
Model
Visual position of the entity.
- class azure.mgmt.cloudhealth.models.EntityImpact(*values)[source]
-
Type of impact an entity has on health state propagation.
- LIMITED = 'Limited'
Limited impact
- STANDARD = 'Standard'
Standard impact
- SUPPRESSED = 'Suppressed'
Suppressed impact
- class azure.mgmt.cloudhealth.models.EntityProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
Properties which are common across all kinds of entities.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
kind (str) – Entity kind.
canvas_position (EntityCoordinates) – Positioning of the entity on the model canvas.
icon (IconDefinition) – Visual icon definition. If not set, a default icon is used.
health_objective (float) – Health objective as a percentage of time the entity should be healthy.
impact (str or EntityImpact) – Impact of the entity in health state propagation. Known values are: “Standard”, “Limited”, and “Suppressed”.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
signals (SignalGroup) – Signal groups which are assigned to this entity.
discovered_by (str) – Discovered by which discovery rule. If set, the entity cannot be deleted manually.
deletion_date (datetime) – Date when the entity was (soft-)deleted.
health_state (str or HealthState) – Health state of this entity. Known values are: “Healthy”, “Degraded”, “Error”, “Unknown”, and “Deleted”.
alerts (EntityAlerts) – Alert configuration for this entity.
- alerts: _models.EntityAlerts | None
Alert configuration for this entity.
- canvas_position: _models.EntityCoordinates | None
Positioning of the entity on the model canvas.
- discovered_by: str | None
Discovered by which discovery rule. If set, the entity cannot be deleted manually.
- health_objective: float | None
Health objective as a percentage of time the entity should be healthy.
- health_state: str | _models.HealthState | None
“Healthy”, “Degraded”, “Error”, “Unknown”, and “Deleted”.
- Type:
Health state of this entity. Known values are
- icon: _models.IconDefinition | None
Visual icon definition. If not set, a default icon is used.
- impact: str | _models.EntityImpact | None
“Standard”, “Limited”, and “Suppressed”.
- Type:
Impact of the entity in health state propagation. Known values are
- provisioning_state: str | _models.HealthModelProvisioningState | None
“Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
- Type:
The status of the last operation. Known values are
- signals: _models.SignalGroup | None
Signal groups which are assigned to this entity.
- class azure.mgmt.cloudhealth.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]
Bases:
Model
The resource management error additional info.
- Variables:
type (str) – The additional info type.
info (any) – The additional info.
- class azure.mgmt.cloudhealth.models.ErrorDetail(*args: Any, **kwargs: Any)[source]
Bases:
Model
The error detail.
- Variables:
code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.
- additional_info: List[_models.ErrorAdditionalInfo] | None
The error additional info.
- details: List[_models.ErrorDetail] | None
The error details.
- class azure.mgmt.cloudhealth.models.ErrorResponse(*args: Any, **kwargs: Any)[source]
Bases:
Model
Error response.
- Variables:
error (ErrorDetail) – The error object.
- error: _models.ErrorDetail | None
The error object.
- class azure.mgmt.cloudhealth.models.EvaluationRule(*args: Any, **kwargs: Any)[source]
Bases:
Model
Evaluation rule for a signal definition.
- Variables:
dynamic_detection_rule (DynamicDetectionRule) – Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set.
degraded_rule (ThresholdRule) – Degraded rule with static threshold. When used, dynamicDetectionRule must not be set.
unhealthy_rule (ThresholdRule) – Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set.
- degraded_rule: _models.ThresholdRule | None
Degraded rule with static threshold. When used, dynamicDetectionRule must not be set.
- dynamic_detection_rule: _models.DynamicDetectionRule | None
Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set.
- unhealthy_rule: _models.ThresholdRule | None
Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set.
- class azure.mgmt.cloudhealth.models.HealthModel(*args: Any, **kwargs: Any)[source]
Bases:
TrackedResource
A HealthModel resource.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – The geo-location where the resource lives. Required.
properties (HealthModelProperties) – The resource-specific properties for this resource.
identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.
- identity: _models.ManagedServiceIdentity | None
The managed service identities assigned to this resource.
- properties: _models.HealthModelProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.HealthModelProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
HealthModel properties.
- Variables:
dataplane_endpoint (str) – The data plane endpoint for interacting with health data.
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
discovery (ModelDiscoverySettings) – Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model.
- discovery: _models.ModelDiscoverySettings | None
Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model.
- class azure.mgmt.cloudhealth.models.HealthModelProvisioningState(*values)[source]
-
Health Model provisioning states.
- CANCELED = 'Canceled'
Resource creation was canceled.
- CREATING = 'Creating'
- DELETING = 'Deleting'
- FAILED = 'Failed'
Resource creation failed.
- SUCCEEDED = 'Succeeded'
Resource has been created.
- class azure.mgmt.cloudhealth.models.HealthModelUpdate(*args: Any, **kwargs: Any)[source]
Bases:
Model
The type used for update operations of the HealthModel.
- Variables:
identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.
properties (HealthModelUpdateProperties) – The resource-specific properties for this resource.
- identity: _models.ManagedServiceIdentity | None
The managed service identities assigned to this resource.
- properties: _models.HealthModelUpdateProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.HealthModelUpdateProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
The updatable properties of the HealthModel.
- Variables:
discovery (ModelDiscoverySettings) – Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model.
- discovery: _models.ModelDiscoverySettings | None
Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model.
- class azure.mgmt.cloudhealth.models.HealthState(*values)[source]
-
Health state of an entity.
- DEGRADED = 'Degraded'
Degraded status
- DELETED = 'Deleted'
Deleted status
- ERROR = 'Error'
Error status (Unhealthy)
- HEALTHY = 'Healthy'
Healthy status
- UNKNOWN = 'Unknown'
Unknown status
- class azure.mgmt.cloudhealth.models.IconDefinition(*args: Any, **kwargs: Any)[source]
Bases:
Model
Visual icon definition of an entity.
- Variables:
- class azure.mgmt.cloudhealth.models.LogAnalyticsQuerySignalDefinitionProperties(*args: Any, **kwargs: Any)[source]
Bases:
SignalDefinitionProperties
Log Analytics Query Signal Definition properties.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
refresh_interval (str or RefreshInterval) – Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). Known values are: “PT1M”, “PT5M”, “PT10M”, “PT30M”, “PT1H”, and “PT2H”.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
data_unit (str) – Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)).
evaluation_rules (EvaluationRule) – Evaluation rules for the signal definition. Required.
deletion_date (datetime) – Date when the signal definition was (soft-)deleted.
signal_kind (str or LOG_ANALYTICS_QUERY) – Kind of the signal definition. Required.
query_text (str) – Query text in KQL syntax. Required.
time_grain (str) – Time range of signal. ISO duration format like PT10M. If not specified, the KQL query must define a time range.
value_column_name (str) – Name of the column in the result set to evaluate against the thresholds. Defaults to the first column in the result set if not specified. The column must be numeric.
- class azure.mgmt.cloudhealth.models.LogAnalyticsSignalGroup(*args: Any, **kwargs: Any)[source]
Bases:
Model
A grouping of signal assignments for a Log Analytics Workspace.
- Variables:
signal_assignments (list[SignalAssignment]) – Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
authentication_setting (str) – Reference to the name of the authentication setting which is used for querying the data source. Required.
log_analytics_workspace_resource_id (str) – Log Analytics Workspace resource ID. Required.
- authentication_setting: str
Reference to the name of the authentication setting which is used for querying the data source. Required.
- signal_assignments: List[_models.SignalAssignment] | None
Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator.
- class azure.mgmt.cloudhealth.models.ManagedIdentityAuthenticationSettingProperties(*args: Any, **kwargs: Any)[source]
Bases:
AuthenticationSettingProperties
Authentication setting properties for Azure Managed Identity.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
authentication_kind (str or MANAGED_IDENTITY) – Kind of the authentication setting. Required.
managed_identity_name (str) – Name of the managed identity to use. Either ‘SystemAssigned’ or the resourceId of a user-assigned identity. Required.
- class azure.mgmt.cloudhealth.models.ManagedServiceIdentity(*args: Any, **kwargs: Any)[source]
Bases:
Model
Managed service identity (system assigned and/or user assigned identities).
- Variables:
principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.
- principal_id: str | None
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
- tenant_id: str | None
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
- type: str | _models.ManagedServiceIdentityType
“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
- Type:
The type of managed identity assigned to this resource. Required. Known values are
- user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None
The identities assigned to this resource by the user.
- class azure.mgmt.cloudhealth.models.ManagedServiceIdentityType(*values)[source]
-
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
- NONE = 'None'
No managed identity.
- SYSTEM_ASSIGNED = 'SystemAssigned'
System assigned managed identity.
- SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned'
System and user assigned managed identity.
- USER_ASSIGNED = 'UserAssigned'
User assigned managed identity.
- class azure.mgmt.cloudhealth.models.MetricAggregationType(*values)[source]
-
Metric aggregation type.
- AVERAGE = 'Average'
- COUNT = 'Count'
- MAXIMUM = 'Maximum'
- MINIMUM = 'Minimum'
- NONE = 'None'
- TOTAL = 'Total'
- class azure.mgmt.cloudhealth.models.ModelDiscoverySettings(*args: Any, **kwargs: Any)[source]
Bases:
Model
Settings for automatically discovering entities for the health model.
- Variables:
scope (str) – The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. Required.
add_recommended_signals (str or DiscoveryRuleRecommendedSignalsBehavior) – Whether to add all recommended signals to the discovered entities. Required. Known values are: “Enabled” and “Disabled”.
identity (str) – Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to ‘SystemAssigned’ or to the resource id of a user-assigned managed identity which is linked to the health model.
- add_recommended_signals: str | _models.DiscoveryRuleRecommendedSignalsBehavior
Whether to add all recommended signals to the discovered entities. Required. Known values are: “Enabled” and “Disabled”.
- class azure.mgmt.cloudhealth.models.Operation(*args: Any, **kwargs: Any)[source]
Bases:
Model
REST API Operation.
- Variables:
name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”
- action_type: str | _models.ActionType | None
Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”
- display: _models.OperationDisplay | None
Localized display information for this particular operation.
- is_data_action: bool | None
Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
- class azure.mgmt.cloudhealth.models.OperationDisplay(*args: Any, **kwargs: Any)[source]
Bases:
Model
Localized display information for and operation.
- Variables:
provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.
- description: str | None
The short, localized friendly description of the operation; suitable for tool tips and detailed views.
- operation: str | None
The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
- class azure.mgmt.cloudhealth.models.Origin(*values)[source]
-
The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.
- SYSTEM = 'system'
Indicates the operation is initiated by a system.
- USER = 'user'
Indicates the operation is initiated by a user.
- USER_SYSTEM = 'user,system'
Indicates the operation is initiated by a user or system.
- class azure.mgmt.cloudhealth.models.PrometheusMetricsSignalDefinitionProperties(*args: Any, **kwargs: Any)[source]
Bases:
SignalDefinitionProperties
Prometheus Metrics Signal Definition properties.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
refresh_interval (str or RefreshInterval) – Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). Known values are: “PT1M”, “PT5M”, “PT10M”, “PT30M”, “PT1H”, and “PT2H”.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
data_unit (str) – Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)).
evaluation_rules (EvaluationRule) – Evaluation rules for the signal definition. Required.
deletion_date (datetime) – Date when the signal definition was (soft-)deleted.
signal_kind (str or PROMETHEUS_METRICS_QUERY) – Kind of the signal definition. Required.
query_text (str) – Query text in PromQL syntax. Required.
time_grain (str) – Time range of signal. ISO duration format like PT10M.
- class azure.mgmt.cloudhealth.models.ProxyResource(*args: Any, **kwargs: Any)[source]
Bases:
Resource
Proxy Resource.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
- class azure.mgmt.cloudhealth.models.RefreshInterval(*values)[source]
-
Refresh interval in ISO duration format.
- PT10M = 'PT10M'
Ten Minutes
- PT1H = 'PT1H'
One Hour
- PT1M = 'PT1M'
One Minute
- PT2H = 'PT2H'
Two Hours
- PT30M = 'PT30M'
Thirty Minutes
- PT5M = 'PT5M'
Five Minutes
- class azure.mgmt.cloudhealth.models.Relationship(*args: Any, **kwargs: Any)[source]
Bases:
ProxyResource
A relationship (aka edge) between two entities in a health model.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (RelationshipProperties) – The resource-specific properties for this resource.
- properties: _models.RelationshipProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.RelationshipProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
Relationship properties.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
parent_entity_name (str) – Resource name of the parent entity. Required.
child_entity_name (str) – Resource name of the child entity. Required.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
discovered_by (str) – Discovered by which discovery rule. If set, the relationship cannot be deleted manually.
deletion_date (datetime) – Date when the relationship was (soft-)deleted.
- class azure.mgmt.cloudhealth.models.Resource(*args: Any, **kwargs: Any)[source]
Bases:
Model
Resource.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
- id: str | None
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- system_data: _models.SystemData | None
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- class azure.mgmt.cloudhealth.models.ResourceMetricSignalDefinitionProperties(*args: Any, **kwargs: Any)[source]
Bases:
SignalDefinitionProperties
Azure Resource Metric Signal Definition properties.
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
refresh_interval (str or RefreshInterval) – Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). Known values are: “PT1M”, “PT5M”, “PT10M”, “PT30M”, “PT1H”, and “PT2H”.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
data_unit (str) – Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)).
evaluation_rules (EvaluationRule) – Evaluation rules for the signal definition. Required.
deletion_date (datetime) – Date when the signal definition was (soft-)deleted.
signal_kind (str or AZURE_RESOURCE_METRIC) – Kind of the signal definition. Required.
metric_namespace (str) – Metric namespace. Required.
metric_name (str) – Name of the metric. Required.
time_grain (str) – Time range of signal. ISO duration format like PT10M. Required.
aggregation_type (str or MetricAggregationType) – Type of aggregation to apply to the metric. Required. Known values are: “None”, “Average”, “Count”, “Minimum”, “Maximum”, and “Total”.
dimension (str) – Optional: Dimension to split by.
dimension_filter (str) – Optional: Dimension filter to apply to the dimension. Must only be set if also Dimension is set.
- aggregation_type: str | _models.MetricAggregationType
“None”, “Average”, “Count”, “Minimum”, “Maximum”, and “Total”.
- Type:
Type of aggregation to apply to the metric. Required. Known values are
- class azure.mgmt.cloudhealth.models.SignalAssignment(*args: Any, **kwargs: Any)[source]
Bases:
Model
Group of signal definition assignments.
- class azure.mgmt.cloudhealth.models.SignalDefinition(*args: Any, **kwargs: Any)[source]
Bases:
ProxyResource
A signal definition in a health model.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (SignalDefinitionProperties) – The resource-specific properties for this resource.
- properties: _models.SignalDefinitionProperties | None
The resource-specific properties for this resource.
- class azure.mgmt.cloudhealth.models.SignalDefinitionProperties(*args: Any, **kwargs: Any)[source]
Bases:
Model
SignalDefinition properties.
You probably want to use the sub-classes and not this class directly. Known sub-classes are: ResourceMetricSignalDefinitionProperties, LogAnalyticsQuerySignalDefinitionProperties, PrometheusMetricsSignalDefinitionProperties
- Variables:
provisioning_state (str or HealthModelProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
display_name (str) – Display name.
signal_kind (str or SignalKind) – Kind of the signal definition. Required. Known values are: “AzureResourceMetric”, “LogAnalyticsQuery”, and “PrometheusMetricsQuery”.
refresh_interval (str or RefreshInterval) – Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). Known values are: “PT1M”, “PT5M”, “PT10M”, “PT30M”, “PT1H”, and “PT2H”.
labels (dict[str, str]) – Optional set of labels (key-value pairs).
data_unit (str) – Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)).
evaluation_rules (EvaluationRule) – Evaluation rules for the signal definition. Required.
deletion_date (datetime) – Date when the signal definition was (soft-)deleted.
- evaluation_rules: _models.EvaluationRule
Evaluation rules for the signal definition. Required.
- provisioning_state: str | _models.HealthModelProvisioningState | None
“Succeeded”, “Failed”, “Canceled”, “Creating”, and “Deleting”.
- Type:
The status of the last operation. Known values are
- class azure.mgmt.cloudhealth.models.SignalGroup(*args: Any, **kwargs: Any)[source]
Bases:
Model
Contains various signal groups that can be assigned to an entity.
- Variables:
azure_resource (AzureResourceSignalGroup) – Azure Resource Signal Group.
azure_log_analytics (LogAnalyticsSignalGroup) – Log Analytics Signal Group.
azure_monitor_workspace (AzureMonitorWorkspaceSignalGroup) – Azure Monitor Workspace Signal Group.
dependencies (DependenciesSignalGroup) – Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity.
- azure_log_analytics: _models.LogAnalyticsSignalGroup | None
Log Analytics Signal Group.
- azure_monitor_workspace: _models.AzureMonitorWorkspaceSignalGroup | None
Azure Monitor Workspace Signal Group.
- azure_resource: _models.AzureResourceSignalGroup | None
Azure Resource Signal Group.
- dependencies: _models.DependenciesSignalGroup | None
Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity.
- class azure.mgmt.cloudhealth.models.SignalKind(*values)[source]
-
Supported signal kinds as discriminator.
- AZURE_RESOURCE_METRIC = 'AzureResourceMetric'
- LOG_ANALYTICS_QUERY = 'LogAnalyticsQuery'
- PROMETHEUS_METRICS_QUERY = 'PrometheusMetricsQuery'
- class azure.mgmt.cloudhealth.models.SignalOperator(*values)[source]
-
Signal operator.
- EQUALS = 'Equals'
Equal to
- GREATER_OR_EQUALS = 'GreaterOrEquals'
Greater than or equal to
- GREATER_THAN = 'GreaterThan'
Greater than
- LOWER_OR_EQUALS = 'LowerOrEquals'
Lower than or equal to
- LOWER_THAN = 'LowerThan'
Lower than
- class azure.mgmt.cloudhealth.models.SystemData(*args: Any, **kwargs: Any)[source]
Bases:
Model
Metadata pertaining to creation and last modification of the resource.
- Variables:
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- class azure.mgmt.cloudhealth.models.ThresholdRule(*args: Any, **kwargs: Any)[source]
Bases:
Model
Threshold-based evaluation rule for a signal definition.
- Variables:
operator (str or SignalOperator) – Operator how to compare the signal value with the threshold. Required. Known values are: “LowerThan”, “LowerOrEquals”, “GreaterThan”, “GreaterOrEquals”, and “Equals”.
threshold (str) – Threshold value. Required.
- class azure.mgmt.cloudhealth.models.TrackedResource(*args: Any, **kwargs: Any)[source]
Bases:
Resource
Tracked Resource.
- Variables:
id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
location (str) – The geo-location where the resource lives. Required.