@azure/arm-cloudhealth 1.0.0-alpha.20250619.1

package/review/arm-cloudhealth-models.api.md

@@ -0,0 +1,535 @@
+## API Report File for "@azure/arm-cloudhealth"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface AlertConfiguration {
+    actionGroupIds?: string[];
+    description?: string;
+    severity: AlertSeverity;
+}
+
+// @public
+export type AlertSeverity = string;
+
+// @public
+export type AuthenticationKind = string;
+
+// @public
+export interface AuthenticationSetting extends ProxyResource {
+    properties?: AuthenticationSettingPropertiesUnion;
+}
+
+// @public
+export interface AuthenticationSettingProperties {
+    authenticationKind: AuthenticationKind;
+    displayName?: string;
+    readonly provisioningState?: HealthModelProvisioningState;
+}
+
+// @public
+export type AuthenticationSettingPropertiesUnion = ManagedIdentityAuthenticationSettingProperties | AuthenticationSettingProperties;
+
+// @public
+export interface AzureMonitorWorkspaceSignalGroup {
+    authenticationSetting: string;
+    azureMonitorWorkspaceResourceId: string;
+    signalAssignments?: SignalAssignment[];
+}
+
+// @public
+export interface AzureResourceSignalGroup {
+    authenticationSetting: string;
+    azureResourceId: string;
+    signalAssignments?: SignalAssignment[];
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export type DependenciesAggregationType = string;
+
+// @public
+export interface DependenciesSignalGroup {
+    aggregationType: DependenciesAggregationType;
+    degradedThreshold?: string;
+    unhealthyThreshold?: string;
+}
+
+// @public
+export interface DiscoveryRule extends ProxyResource {
+    properties?: DiscoveryRuleProperties;
+}
+
+// @public
+export interface DiscoveryRuleProperties {
+    addRecommendedSignals: DiscoveryRuleRecommendedSignalsBehavior;
+    authenticationSetting: string;
+    readonly deletionDate?: Date;
+    discoverRelationships: DiscoveryRuleRelationshipDiscoveryBehavior;
+    displayName?: string;
+    readonly entityName: string;
+    readonly errorMessage?: string;
+    readonly numberOfDiscoveredEntities?: number;
+    readonly provisioningState?: HealthModelProvisioningState;
+    resourceGraphQuery: string;
+}
+
+// @public
+export type DiscoveryRuleRecommendedSignalsBehavior = string;
+
+// @public
+export type DiscoveryRuleRelationshipDiscoveryBehavior = string;
+
+// @public
+export interface DynamicDetectionRule {
+    dynamicThresholdDirection: DynamicThresholdDirection;
+    dynamicThresholdModel: DynamicThresholdModel;
+    modelSensitivity: number;
+    trainingStartTime?: Date;
+}
+
+// @public
+export type DynamicThresholdDirection = string;
+
+// @public
+export type DynamicThresholdModel = string;
+
+// @public
+export interface Entity extends ProxyResource {
+    properties?: EntityProperties;
+}
+
+// @public
+export interface EntityAlerts {
+    degraded?: AlertConfiguration;
+    unhealthy?: AlertConfiguration;
+}
+
+// @public
+export interface EntityCoordinates {
+    x: number;
+    y: number;
+}
+
+// @public
+export type EntityImpact = string;
+
+// @public
+export interface EntityProperties {
+    alerts?: EntityAlerts;
+    canvasPosition?: EntityCoordinates;
+    readonly deletionDate?: Date;
+    readonly discoveredBy?: string;
+    displayName?: string;
+    healthObjective?: number;
+    readonly healthState?: HealthState;
+    icon?: IconDefinition;
+    impact?: EntityImpact;
+    kind?: string;
+    labels?: Record<string, string>;
+    readonly provisioningState?: HealthModelProvisioningState;
+    signals?: SignalGroup;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: any;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetail {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly details?: ErrorDetail[];
+    readonly message?: string;
+    readonly target?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetail;
+}
+
+// @public
+export interface EvaluationRule {
+    degradedRule?: ThresholdRule;
+    dynamicDetectionRule?: DynamicDetectionRule;
+    unhealthyRule?: ThresholdRule;
+}
+
+// @public
+export interface HealthModel extends TrackedResource {
+    identity?: ManagedServiceIdentity;
+    properties?: HealthModelProperties;
+}
+
+// @public
+export interface HealthModelProperties {
+    readonly dataplaneEndpoint?: string;
+    discovery?: ModelDiscoverySettings;
+    readonly provisioningState?: HealthModelProvisioningState;
+}
+
+// @public
+export type HealthModelProvisioningState = string;
+
+// @public
+export interface HealthModelUpdate {
+    identity?: ManagedServiceIdentity;
+    properties?: HealthModelUpdateProperties;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface HealthModelUpdateProperties {
+    discovery?: ModelDiscoverySettings;
+}
+
+// @public
+export type HealthState = string;
+
+// @public
+export interface IconDefinition {
+    customData?: string;
+    iconName: string;
+}
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownAlertSeverity {
+    Sev0 = "Sev0",
+    Sev1 = "Sev1",
+    Sev2 = "Sev2",
+    Sev3 = "Sev3",
+    Sev4 = "Sev4"
+}
+
+// @public
+export enum KnownAuthenticationKind {
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownDependenciesAggregationType {
+    Thresholds = "Thresholds",
+    WorstOf = "WorstOf"
+}
+
+// @public
+export enum KnownDiscoveryRuleRecommendedSignalsBehavior {
+    Disabled = "Disabled",
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownDiscoveryRuleRelationshipDiscoveryBehavior {
+    Disabled = "Disabled",
+    Enabled = "Enabled"
+}
+
+// @public
+export enum KnownDynamicThresholdDirection {
+    GreaterOrLowerThan = "GreaterOrLowerThan",
+    GreaterThan = "GreaterThan",
+    LowerThan = "LowerThan"
+}
+
+// @public
+export enum KnownDynamicThresholdModel {
+    AnomalyDetection = "AnomalyDetection"
+}
+
+// @public
+export enum KnownEntityImpact {
+    Limited = "Limited",
+    Standard = "Standard",
+    Suppressed = "Suppressed"
+}
+
+// @public
+export enum KnownHealthModelProvisioningState {
+    Canceled = "Canceled",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleting = "Deleting",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownHealthState {
+    Degraded = "Degraded",
+    Deleted = "Deleted",
+    Error = "Error",
+    Healthy = "Healthy",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownManagedServiceIdentityType {
+    None = "None",
+    SystemAssigned = "SystemAssigned",
+    SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownMetricAggregationType {
+    // (undocumented)
+    Average = "Average",
+    // (undocumented)
+    Count = "Count",
+    // (undocumented)
+    Maximum = "Maximum",
+    // (undocumented)
+    Minimum = "Minimum",
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    Total = "Total"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownRefreshInterval {
+    PT10M = "PT10M",
+    PT1H = "PT1H",
+    PT1M = "PT1M",
+    PT2H = "PT2H",
+    PT30M = "PT30M",
+    PT5M = "PT5M"
+}
+
+// @public
+export enum KnownSignalKind {
+    // (undocumented)
+    AzureResourceMetric = "AzureResourceMetric",
+    // (undocumented)
+    LogAnalyticsQuery = "LogAnalyticsQuery",
+    // (undocumented)
+    PrometheusMetricsQuery = "PrometheusMetricsQuery"
+}
+
+// @public
+export enum KnownSignalOperator {
+    Equals = "Equals",
+    GreaterOrEquals = "GreaterOrEquals",
+    GreaterThan = "GreaterThan",
+    LowerOrEquals = "LowerOrEquals",
+    LowerThan = "LowerThan"
+}
+
+// @public
+export enum KnownVersions {
+    V20250501Preview = "2025-05-01-preview"
+}
+
+// @public
+export interface LogAnalyticsQuerySignalDefinitionProperties extends SignalDefinitionProperties {
+    queryText: string;
+    signalKind: "LogAnalyticsQuery";
+    timeGrain?: string;
+    valueColumnName?: string;
+}
+
+// @public
+export interface LogAnalyticsSignalGroup {
+    authenticationSetting: string;
+    logAnalyticsWorkspaceResourceId: string;
+    signalAssignments?: SignalAssignment[];
+}
+
+// @public
+export interface ManagedIdentityAuthenticationSettingProperties extends AuthenticationSettingProperties {
+    authenticationKind: "ManagedIdentity";
+    managedIdentityName: string;
+}
+
+// @public
+export interface ManagedServiceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type: ManagedServiceIdentityType;
+    userAssignedIdentities?: Record<string, UserAssignedIdentity | null>;
+}
+
+// @public
+export type ManagedServiceIdentityType = string;
+
+// @public
+export type MetricAggregationType = string;
+
+// @public
+export interface ModelDiscoverySettings {
+    addRecommendedSignals: DiscoveryRuleRecommendedSignalsBehavior;
+    identity?: string;
+    scope: string;
+}
+
+// @public
+export interface Operation {
+    readonly actionType?: ActionType;
+    display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PrometheusMetricsSignalDefinitionProperties extends SignalDefinitionProperties {
+    queryText: string;
+    signalKind: "PrometheusMetricsQuery";
+    timeGrain?: string;
+}
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export type RefreshInterval = string;
+
+// @public
+export interface Relationship extends ProxyResource {
+    properties?: RelationshipProperties;
+}
+
+// @public
+export interface RelationshipProperties {
+    childEntityName: string;
+    readonly deletionDate?: Date;
+    readonly discoveredBy?: string;
+    displayName?: string;
+    labels?: Record<string, string>;
+    parentEntityName: string;
+    readonly provisioningState?: HealthModelProvisioningState;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceMetricSignalDefinitionProperties extends SignalDefinitionProperties {
+    aggregationType: MetricAggregationType;
+    dimension?: string;
+    dimensionFilter?: string;
+    metricName: string;
+    metricNamespace: string;
+    signalKind: "AzureResourceMetric";
+    timeGrain: string;
+}
+
+// @public
+export interface SignalAssignment {
+    signalDefinitions: string[];
+}
+
+// @public
+export interface SignalDefinition extends ProxyResource {
+    properties?: SignalDefinitionPropertiesUnion;
+}
+
+// @public
+export interface SignalDefinitionProperties {
+    dataUnit?: string;
+    readonly deletionDate?: Date;
+    displayName?: string;
+    evaluationRules: EvaluationRule;
+    labels?: Record<string, string>;
+    readonly provisioningState?: HealthModelProvisioningState;
+    refreshInterval?: RefreshInterval;
+    signalKind: SignalKind;
+}
+
+// @public
+export type SignalDefinitionPropertiesUnion = ResourceMetricSignalDefinitionProperties | LogAnalyticsQuerySignalDefinitionProperties | PrometheusMetricsSignalDefinitionProperties | SignalDefinitionProperties;
+
+// @public
+export interface SignalGroup {
+    azureLogAnalytics?: LogAnalyticsSignalGroup;
+    azureMonitorWorkspace?: AzureMonitorWorkspaceSignalGroup;
+    azureResource?: AzureResourceSignalGroup;
+    dependencies?: DependenciesSignalGroup;
+}
+
+// @public
+export type SignalKind = string;
+
+// @public
+export type SignalOperator = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface ThresholdRule {
+    operator: SignalOperator;
+    threshold: string;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface UserAssignedIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```