@azure/arm-cloudhealth package

Rozhraní

AlertConfiguration

Detaily konfigurace upozornění

ApplicationInsightsTopologySpecification

Specifikace pravidla objevování pro dotaz na topologii Application Insights

AuthenticationSetting

Nastavení autentizace v modelu zdraví

AuthenticationSettingProperties

Vlastnosti nastavení autentizace

AuthenticationSettingsCreateOrUpdateOptionalParams

Volitelné parametry.

AuthenticationSettingsDeleteOptionalParams

Volitelné parametry.

AuthenticationSettingsGetOptionalParams

Volitelné parametry.

AuthenticationSettingsListByHealthModelOptionalParams

Volitelné parametry.

AuthenticationSettingsOperations

Rozhraní reprezentující operace AuthenticationSettings.

AzureMonitorWorkspaceSignals

A grouping of Azure Monitor workspace signals.

AzureResourceSignal

Instance signálu Azure Resource Metric přiřazená k entitě.

AzureResourceSignals

Skupina Azure resource signals

CloudHealthClientOptionalParams

Volitelné parametry pro klienta.

DependenciesSignalGroupV2

Vlastnosti závislých entit, tj. podřízených entit

DiscoveryError

Chybové detaily při neúspěšné operaci objevování

DiscoveryRule

Pravidlo objevování, které automaticky nachází entity a vztahy v modelu zdraví na základě dotazu Azure Resource Graph

DiscoveryRuleProperties

Vlastnosti pravidel objevování

DiscoveryRulePropertiesCreate

Vlastnosti pravidel objevování pro operace vytváření/aktualizace, vynechávající pole pouze pro čtení na straně serveru (v kanonickém modelu je vyžadováno jméno entity+pouze pro čtení).

DiscoveryRuleResourceCreate

Zdroj pravidel objevování pro operace vytváření/aktualizace.

DiscoveryRuleSpecification

Základní model specifikací pravidel objevování

DiscoveryRulesCreateOrUpdateOptionalParams

Volitelné parametry.

DiscoveryRulesDeleteOptionalParams

Volitelné parametry.

DiscoveryRulesGetOptionalParams

Volitelné parametry.

DiscoveryRulesListByHealthModelOptionalParams

Volitelné parametry.

DiscoveryRulesOperations

Rozhraní reprezentující operace DiscoveryRules.

EntitiesCreateOrUpdateOptionalParams

Volitelné parametry.

EntitiesDeleteOptionalParams

Volitelné parametry.

EntitiesGetHistoryOptionalParams

Volitelné parametry.

EntitiesGetOptionalParams

Volitelné parametry.

EntitiesGetSignalHistoryOptionalParams

Volitelné parametry.

EntitiesIngestHealthReportOptionalParams

Volitelné parametry.

EntitiesListByHealthModelOptionalParams

Volitelné parametry.

EntitiesOperations

Rozhraní reprezentující operace entity.

Entity

Entita (tzv. uzel) modelu zdraví

EntityAlerts

Konfigurace upozornění pro entitu

EntityCoordinates

Vizuální poloha entity

EntityHistoryRequest

Tělo žádosti o získání zdravotní historie entity

EntityHistoryResponse

Odpověď obsahující přechody zdravotních stavů entit

EntityProperties

Vlastnosti, které jsou společné všem typům entit

ErrorAdditionalInfo

Další informace o chybě při správě prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace

EvaluationRule

Evaluační pravidlo pro definici signálu

ExternalSignal

Externě odeslaná instance signálu přiřazená entitě.

ExternalSignalGroup

Skupina externě odeslaných signálů.

HealthModel

Zdroj HealthModel

HealthModelProperties

Vlastnosti HealthModel

HealthModelUpdate

Typ používaný pro aktualizační operace HealthModelu.

HealthModelsCreateOptionalParams

Volitelné parametry.

HealthModelsDeleteOptionalParams

Volitelné parametry.

HealthModelsGetOptionalParams

Volitelné parametry.

HealthModelsListByResourceGroupOptionalParams

Volitelné parametry.

HealthModelsListBySubscriptionOptionalParams

Volitelné parametry.

HealthModelsOperations

Rozhraní reprezentující operace HealthModels.

HealthModelsUpdateOptionalParams

Volitelné parametry.

HealthReportEvaluationRule

Hodnotící pravidla pro zdravotní zprávu

HealthReportRequest

Zdravotní zpráva podáváná pro konkrétní signál

HealthStateTransition

Záznam o přechodu zdravotního stavu

IconDefinition

Vizuální definice ikony entity

LogAnalyticsQuerySignalDefinitionProperties

Vlastnosti definice signálu dotazů v Log Analytics

LogAnalyticsSignal

Instance signálu Log Analytics Query přiřazená k entitě.

LogAnalyticsSignals

Skupina signálů pracovního prostoru Log Analytics.

ManagedIdentityAuthenticationSettingProperties

Vlastnosti nastavení autentizace pro Azure Managed Identity

ManagedServiceIdentity

Identita spravované služby (identita přiřazená systémem nebo identita přiřazená uživatelem)

Operation

Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků

OperationDisplay

Lokalizované zobrazovací informace pro operaci.

OperationsListOptionalParams

Volitelné parametry.

OperationsOperations

Rozhraní představující Operace operací.

PageSettings

Možnosti pro metodu byPage

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iterovatelnou iteraci až do dokončení i po stránce.

PrometheusMetricsSignal

Instance signálu dotazu Prometheus Metrics přiřazená k entitě.

PrometheusMetricsSignalDefinitionProperties

Vlastnosti definice signálu Prometheus Metrics

ProxyResource

Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.

Relationship

Vztah (tzv. hrana) mezi dvěma entitami v modelu zdraví

RelationshipProperties

Vlastnosti relace

RelationshipsCreateOrUpdateOptionalParams

Volitelné parametry.

RelationshipsDeleteOptionalParams

Volitelné parametry.

RelationshipsGetOptionalParams

Volitelné parametry.

RelationshipsListByHealthModelOptionalParams

Volitelné parametry.

RelationshipsOperations

Rozhraní reprezentující operace vztahů.

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

ResourceGraphQuerySpecification

Specifikace pravidla Discovery pro dotaz Azure Resource Graph

ResourceMetricSignalDefinitionProperties

Vlastnosti definice signálu Azure Resource Metric

RestorePollerOptions
SignalDefinition

Definice signálu v modelu zdraví

SignalDefinitionProperties

Vlastnosti SignalDefinition

SignalDefinitionsCreateOrUpdateOptionalParams

Volitelné parametry.

SignalDefinitionsDeleteOptionalParams

Volitelné parametry.

SignalDefinitionsGetOptionalParams

Volitelné parametry.

SignalDefinitionsListByHealthModelOptionalParams

Volitelné parametry.

SignalDefinitionsOperations

Rozhraní reprezentující operace SignalDefinitions.

SignalGroups

Obsahuje různé skupiny signálů, které lze přiřadit entitě

SignalHistoryDataPoint

Datový bod v časové řadě signálu

SignalHistoryRequest

Tělo požadavků pro získání historie signálu

SignalHistoryResponse

Odezva obsahující historii signálu

SignalInstanceProperties

Další vlastnosti pro instance signálů přiřazené entitě

SignalStatus

Stav signálu

SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

ThresholdRuleV2

Hodnotící pravidlo na prahu pro definici signálu

TrackedResource

Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Aliasy typu

ActionType

Rozšiřitelný výčet. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.
PoleActionType lze použít zaměnitelně s ActionType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Interní: Akce jsou určeny pouze pro interní rozhraní API.

AlertSeverity

Závažnost poplachu
KnownAlertSeverity lze používat zaměnitelně s AlertSeverity, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Sev0: Kritické
Sev1: Chyba
Sev2: Varování
Sev3: Informační
Sev4: Slovní

AuthenticationKind

Podporované typy autentizačních nastavení jako diskriminátor
KnownAuthenticationKind lze používat zaměnitelně s AuthenticationKind, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

ManagedIdentity

AuthenticationSettingPropertiesUnion

Alias pro AuthenticationSettingPropertiesUnion

AzureSupportedClouds

Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu

ContinuablePage

Rozhraní, které popisuje stránku výsledků.

CreatedByType

Druh entity, která prostředek vytvořila.
PoleCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Uživatel: Entita byla vytvořena uživatelem.
Aplikace: Entita byla vytvořena aplikací.
ManagedIdentity: Entita byla vytvořena spravovanou identitou.
Klíč: Entita byla vytvořena klíčem.

DependenciesAggregationType

Typ agregace pro podřízené závislosti.
KnownDependenciesAggregationType lze použít zaměnitelně s DependenciesAggregationType, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nejhorší: Výchozí chování: Šíří se nejhorší zdravotní stav dítěte.
MinZdravé: Zdravé, pokud počet/procento zdravých dětí splňuje požadovanou hranici.
MaxNotHealthy: Zdraví, pokud počet/procento nezdravých dětí zůstává pod prahem.

DependenciesAggregationUnit

Typ jednotky pro prahy agregace závislostí.
KnownDependenciesAggregationUnit lze použít zaměnitelně s DependenciesAggregationUnit, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Absolutní: Práh je absolutní počet entit.
Procento: Práh je procento entit (0–100).

DiscoveryRuleKind

Specifikace pravidla objevování – druh diskriminátor
KnownDiscoveryRuleKind lze používat zaměnitelně s DiscoveryRuleKind, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

ResourceGraphQuery: Azure Resource Graph dotazování založené na dotazech
ApplicationInsightsTopology: Objevování založené na topologii Application Insights

DiscoveryRuleRecommendedSignalsBehavior

Doporučené chování signálu podle pravidla objevování
KnownDiscoveryRuleRecommendedSignalsBehavior lze používat zaměnitelně s DiscoveryRuleRecommendedSignalsBehavior, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Povoleno: Automaticky přidává doporučené signály
Zakázáno: Automaticky nepřidávat doporučená signály

DiscoveryRuleRelationshipDiscoveryBehavior

Chování při objevování vztahů podle pravidel objevování
KnownDiscoveryRuleRelationshipDiscoveryBehavior lze používat zaměnitelně s DiscoveryRuleRelationshipDiscoveryBehavior, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Povoleno: Automaticky se pokuste najít vztahy
Postižení: Nepokoušejte se automaticky objevovat vztahy

DiscoveryRuleSpecificationUnion

Alias pro DiscoveryRuleSpecificationUnion

EntityImpact

Typ dopadu, jaký má entita na šíření zdravotního stavu
KnownEntityImpact lze používat zaměnitelně s EntityImpact, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Standard: Standard impact
Omezené: Omezený dopad
Potlačené: Potlačené nárazy

HealthModelProvisioningState

Stavy poskytování zdravotního modelu
KnownHealthModelProvisioningState lze používat zaměnitelně se HealthModelProvisioningState, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Úspěšné: Prostředek byl vytvořen.
selhalo: Vytvoření prostředku se nezdařilo.
Zrušeno: Vytvoření prostředku bylo zrušeno.
vytváření
odstranění

HealthState

Zdravotní stav subjektu
PoleHealthState lze použít zaměnitelně s HealthState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Zdravý: Zdravý stav
Degradovaný: Degradovaný stav
Nezdravý: Nezdravý stav
Neznámý: Neznámý stav
Smazáno: Stav smazán

ManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).
PoleManagedServiceIdentityType lze použít zaměnitelně s ManagedServiceIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádná: Žádná spravovaná identita.
SystemAssigned: Spravovaná identita přiřazená systémem.
UserAssigned: Spravovaná identita přiřazená uživatelem.
SystemAssigned, UserAssigned: Spravovaná identita přiřazená systémem a uživatelem.

MetricAggregationType

Typ agregace metrických metrů
PoleMetricAggregationType lze použít zaměnitelně s MetricAggregationType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Nic
Průměr
Počet
Minimální
Maximum
Celkem

Origin

Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system.
PoleOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

user: Označuje, že operace je iniciována uživatelem.
systém: Označuje, že operace je iniciována systémem.
user,system: Označuje, že operace je iniciována uživatelem nebo systémem.

RefreshInterval

Interval obnovy ve formátu trvání ISO
KnownRefreshInterval lze používat zaměnitelně s RefreshInterval, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

PT1M: Jedna minuta
PT5M: Pět minut
PT10M: Deset minut
PT30M: Třicet minut
PT1H: Jedna hodina
PT2H: Dvě hodiny

SignalDefinitionPropertiesUnion

Alias pro SignalDefinitionPropertiesUnion

SignalInstancePropertiesUnion

Alias pro SignalInstancePropertiesUnion

SignalKind

Podporované druhy signálů jako diskriminátor
KnownSignalKind lze použít zaměnitelně se SignalKind, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

AzureResourceMetric
LogAnalyticsQuery
PrometheusMetricsQuery
Externí

SignalOperator

Operátor výpravy
KnownSignalOperator lze používat zaměnitelně se SignalOperator, tento enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

VětšíAž: Větší než
LessAgain: Less Than
LessThanOrEqual: Méně nebo rovno
VětšíNeboRovno: Větší nebo rovno
Rovno: Rovno
Nerovné: Není rovno

Výčty

AzureClouds

Výčet popisující cloudová prostředí Azure.

KnownActionType

Rozšiřitelný výčet. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.

KnownAlertSeverity

Závažnost poplachu

KnownAuthenticationKind

Podporované typy autentizačních nastavení jako diskriminátor

KnownCreatedByType

Druh entity, která prostředek vytvořila.

KnownDependenciesAggregationType

Typ agregace pro podřízené závislosti.

KnownDependenciesAggregationUnit

Typ jednotky pro prahy agregace závislostí.

KnownDiscoveryRuleKind

Specifikace pravidla objevování – druh diskriminátor

KnownDiscoveryRuleRecommendedSignalsBehavior

Doporučené chování signálu podle pravidla objevování

KnownDiscoveryRuleRelationshipDiscoveryBehavior

Chování při objevování vztahů podle pravidel objevování

KnownEntityImpact

Typ dopadu, jaký má entita na šíření zdravotního stavu

KnownHealthModelProvisioningState

Stavy poskytování zdravotního modelu

KnownHealthState

Zdravotní stav subjektu

KnownManagedServiceIdentityType

Typ identity spravované služby (kde jsou povolené typy SystemAssigned i UserAssigned).

KnownMetricAggregationType

Typ agregace metrických metrů

KnownOrigin

Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system.

KnownRefreshInterval

Interval obnovy ve formátu trvání ISO

KnownSignalKind

Podporované druhy signálů jako diskriminátor

KnownSignalOperator

Operátor výpravy

KnownVersions

Verze rozhraní API

Funkce

isRestError(unknown)

Typeguard pro RestError

restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru.

Proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

Podrobnosti funkce

isRestError(unknown)

Typeguard pro RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e

restorePoller<TResponse, TResult>(CloudHealthClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru.

function restorePoller<TResponse, TResult>(client: CloudHealthClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Návraty

PollerLike<OperationState<TResult>, TResult>

Podrobnosti proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

RestError: RestErrorConstructor

Typ