@azure/arm-cloudhealth package

Interfejsy

AlertConfiguration

Szczegóły konfiguracji alertu

ApplicationInsightsTopologySpecification

Specyfikacja reguły odkrywania dla zapytania topologii Application Insights

AuthenticationSetting

Ustawienie uwierzytelniania w modelu zdrowia

AuthenticationSettingProperties

Właściwości ustawień uwierzytelniania

AuthenticationSettingsCreateOrUpdateOptionalParams

Parametry opcjonalne.

AuthenticationSettingsDeleteOptionalParams

Parametry opcjonalne.

AuthenticationSettingsGetOptionalParams

Parametry opcjonalne.

AuthenticationSettingsListByHealthModelOptionalParams

Parametry opcjonalne.

AuthenticationSettingsOperations

Interfejs reprezentujący operacje AuthenticationSettings.

AzureMonitorWorkspaceSignals

A grouping of Azure Monitor workspace signals.

AzureResourceSignal

Instancja sygnału Azure Resource Metric przypisana do jednostki.

AzureResourceSignals

Grupa sygnałów zasobów Azure

CloudHealthClientOptionalParams

Parametry opcjonalne dla klienta.

DependenciesSignalGroupV2

Właściwości dla podmiotów zależnych, tj. podmiotów potomnych

DiscoveryError

Szczegóły błędu nieudanej operacji wykrywania

DiscoveryRule

Reguła odkrywania, która automatycznie znajduje encje i relacje w modelu zdrowia na podstawie zapytania Azure Resource Graph

DiscoveryRuleProperties

Właściwości reguł odkrywania

DiscoveryRulePropertiesCreate

Właściwości reguł odkrywania dla operacji tworzenia/aktualizacji, pomijając pola tylko do odczytu po stronie serwera (w modelu kanonicznym wymagana jest nazwa jednostki + tylko do odczytu).

DiscoveryRuleResourceCreate

Zasób reguł odkrywania do operacji tworzenia/aktualizacji.

DiscoveryRuleSpecification

Model bazowy specyfikacji reguł odkrywania

DiscoveryRulesCreateOrUpdateOptionalParams

Parametry opcjonalne.

DiscoveryRulesDeleteOptionalParams

Parametry opcjonalne.

DiscoveryRulesGetOptionalParams

Parametry opcjonalne.

DiscoveryRulesListByHealthModelOptionalParams

Parametry opcjonalne.

DiscoveryRulesOperations

Interfejs reprezentujący operacje DiscoveryRules.

EntitiesCreateOrUpdateOptionalParams

Parametry opcjonalne.

EntitiesDeleteOptionalParams

Parametry opcjonalne.

EntitiesGetHistoryOptionalParams

Parametry opcjonalne.

EntitiesGetOptionalParams

Parametry opcjonalne.

EntitiesGetSignalHistoryOptionalParams

Parametry opcjonalne.

EntitiesIngestHealthReportOptionalParams

Parametry opcjonalne.

EntitiesListByHealthModelOptionalParams

Parametry opcjonalne.

EntitiesOperations

Interfejs reprezentujący operacje Encja.

Entity

Jednostka (czyli węzeł) modelu zdrowia

EntityAlerts

Konfiguracja alertu dla jednostki

EntityCoordinates

Pozycja wizualna jednostki

EntityHistoryRequest

Ciało żądające uzyskania historii zdrowia podmiotu

EntityHistoryResponse

Odpowiedź zawierająca przejścia stanów zdrowia jednostek

EntityProperties

Właściwości wspólne dla wszystkich rodzajów bytów

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.

EvaluationRule

Reguła ewaluacji dla definicji sygnału

ExternalSignal

Zewnętrznie przesłana instancja sygnału przypisana do jednostki.

ExternalSignalGroup

Grupa sygnałów przesyłanych z zewnątrz.

HealthModel

Źródło HealthModel

HealthModelProperties

Właściwości HealthModel

HealthModelUpdate

Typ używany do operacji aktualizacji HealthModel.

HealthModelsCreateOptionalParams

Parametry opcjonalne.

HealthModelsDeleteOptionalParams

Parametry opcjonalne.

HealthModelsGetOptionalParams

Parametry opcjonalne.

HealthModelsListByResourceGroupOptionalParams

Parametry opcjonalne.

HealthModelsListBySubscriptionOptionalParams

Parametry opcjonalne.

HealthModelsOperations

Interfejs reprezentujący operacje HealthModels.

HealthModelsUpdateOptionalParams

Parametry opcjonalne.

HealthReportEvaluationRule

Zasady oceny raportu zdrowotnego

HealthReportRequest

Raport zdrowotny złożony dla konkretnego sygnału

HealthStateTransition

Zapis przejścia stanu zdrowia

IconDefinition

Wizualna definicja ikony jednostki

LogAnalyticsQuerySignalDefinitionProperties

Właściwości Definicji sygnału zapytania w Log Analytics

LogAnalyticsSignal

Instancja sygnału zapytania Log Analytics przypisana do jednostki.

LogAnalyticsSignals

Grupa sygnałów przestrzeni roboczej Log Analytics.

ManagedIdentityAuthenticationSettingProperties

Właściwości ustawień uwierzytelniania dla Azure Managed Identity

ManagedServiceIdentity

Tożsamość usługi zarządzanej (tożsamości przypisane przez system i/lub tożsamości przypisane przez użytkownika)

Operation

Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów

OperationDisplay

Zlokalizowane informacje wyświetlane dla operacji.

OperationsListOptionalParams

Parametry opcjonalne.

OperationsOperations

Interfejs reprezentujący operacje Operations.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.

PrometheusMetricsSignal

Instancja sygnału zapytania Prometheus Metrics przypisana do jednostki.

PrometheusMetricsSignalDefinitionProperties

Właściwości definicji sygnału metryki Prometheus

ProxyResource

Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji

Relationship

Relacja (czyli krawędź) między dwoma podmiotami w modelu zdrowia

RelationshipProperties

Właściwości relacji

RelationshipsCreateOrUpdateOptionalParams

Parametry opcjonalne.

RelationshipsDeleteOptionalParams

Parametry opcjonalne.

RelationshipsGetOptionalParams

Parametry opcjonalne.

RelationshipsListByHealthModelOptionalParams

Parametry opcjonalne.

RelationshipsOperations

Interfejs reprezentujący operacje relacji.

Resource

Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager

ResourceGraphQuerySpecification

Specyfikacja reguły odkrywania zapytania Azure Resource Graph

ResourceMetricSignalDefinitionProperties

Właściwości definicji sygnału Azure Resource Metric Signal

RestorePollerOptions
SignalDefinition

Definicja sygnału w modelu zdrowotnym

SignalDefinitionProperties

Właściwości SignalDefinition

SignalDefinitionsCreateOrUpdateOptionalParams

Parametry opcjonalne.

SignalDefinitionsDeleteOptionalParams

Parametry opcjonalne.

SignalDefinitionsGetOptionalParams

Parametry opcjonalne.

SignalDefinitionsListByHealthModelOptionalParams

Parametry opcjonalne.

SignalDefinitionsOperations

Interfejs reprezentujący operacje SignalDefinitions.

SignalGroups

Zawiera różne grupy sygnałów, które można przypisać do jednostki

SignalHistoryDataPoint

Punkt danych w szeregu czasowym sygnału

SignalHistoryRequest

Ciało żądań do uzyskania historii sygnału

SignalHistoryResponse

Odpowiedź zawierająca historię sygnału

SignalInstanceProperties

Dodatkowe właściwości dla instancji sygnału przypisanych do jednostki

SignalStatus

Status sygnału

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ThresholdRuleV2

Reguła oceny oparta na progu dla definicji sygnału

TrackedResource

Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację"

UserAssignedIdentity

Właściwości tożsamości przypisanej przez użytkownika

Aliasy typu

ActionType

Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego.
KnownActionType można używać zamiennie z właściwością ActionType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

wewnętrzny: akcje dotyczą interfejsów API tylko do użytku wewnętrznego.

AlertSeverity

Stopień alarmu
KnownAlertSeverity może być używany zamiennie z AlertSeverity, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Sev0: Krytyczne
Sev1: Błąd
Sev2: Ostrzeżenie
Sev3: Informacyjne
Sev4: Rozmowne

AuthenticationKind

Obsługiwane rodzaje ustawień uwierzytelniania jako dyskryminator
KnownAuthenticationKind może być używany zamiennie z AuthenticationKind, a ten enum zawiera znane wartości, które usługa obsługuje.

Znane wartości obsługiwane przez usługę

ManagedIdentity

AuthenticationSettingPropertiesUnion

Alias dla AuthenticationSettingPropertiesUnion

AzureSupportedClouds

Obsługiwane wartości ustawienia chmury jako typ literału ciągu

ContinuablePage

Interfejs opisujący stronę wyników.

CreatedByType

Rodzaj jednostki, która utworzyła zasób.
KnownCreatedByType można używać zamiennie z wartością CreatedByType. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownik: jednostka została utworzona przez użytkownika.
Application: jednostka została utworzona przez aplikację.
managedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
klucz: jednostka została utworzona przez klucz.

DependenciesAggregationType

Typ agregacji dla zależności podrzędnych.
KnownDependenciesAggregationType może być używany zamiennie z DependenciesAggregationType, ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Najgorsze: Domyślne zachowanie: Najgorszy stan zdrowia dziecka jest propagowany.
MinHealthy: Zdrowe, jeśli liczba lub procent zdrowych dzieci spełnia próg.
MaxNotHealthy: Zdrowy, jeśli liczba lub procent niezdrowych dzieci pozostaje poniżej progu.

DependenciesAggregationUnit

Typ jednostki dla progów agregacji zależności.
KnownDependenciesAggregationUnit może być używany zamiennie z DependenciesAggregationUnit, ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Absolut: Próg to bezwzględna liczba bytów.
Procent: Próg to procent podmiotów (0-100).

DiscoveryRuleKind

Dyskryminator typu dyskryminator specyfikacji reguły odkrycia
KnownDiscoveryRuleKind może być używany zamiennie z DiscoveryRuleKind, ten enum zawiera znane wartości, które obsługuje usługa.

Znane wartości obsługiwane przez usługę

ResourceGraphQuery: odkrywanie oparte na zapytaniach Azure Resource Graph
ApplicationInsightsTopology: Odkrywanie oparte na topologii Application Insights

DiscoveryRuleRecommendedSignalsBehavior

Zalecane zachowanie sygnału regułą odkrywania
ZnaneDiscoveryRuleRecommendedSignalsBehavior może być używane zamiennie z DiscoveryRuleRecommendedSignalsBehavior, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Włączone: Automatycznie dodaj zalecane sygnały
Wyłączony: Nie dodawaj automatycznie zalecanych sygnałów

DiscoveryRuleRelationshipDiscoveryBehavior

Zachowanie odkrywania relacji według reguły odkrywania
ZnaneDiscoveryRuleRelationshipDiscoveryZachowanie może być używane zamiennie z DiscoveryRuleRelationshipDiscoveryBehavior, a ten enum zawiera znane wartości, które usługa wspiera.

Znane wartości obsługiwane przez usługę

Włączone: Automatycznie próbuj odkrywać zależności
Niepełnosprawność: Nie próbuj automatycznie odkrywać relacji

DiscoveryRuleSpecificationUnion

Alias dla DiscoveryRuleSpecificationUnion

EntityImpact

Rodzaj wpływu, jaki podmiot ma na propagację stanu zdrowia
KnownEntityImpact może być używany zamiennie z EntityImpact, a ten enum zawiera znane wartości, które obsługuje usługa.

Znane wartości obsługiwane przez usługę

Standard: Standardowy udar
Ograniczone: Ograniczony wpływ
Tłumione: Tłumione uderzenie

HealthModelProvisioningState

Stany dostarczania Modelu Opieki
KnownHealthModelProvisioningState może być używany zamiennie z HealthModelProvisioningState, a ten enum zawiera znane wartości, które obsługuje usługa.

Znane wartości obsługiwane przez usługę

pomyślnie: utworzono zasób.
Niepowodzenie: tworzenie zasobu nie powiodło się.
Anulowano: tworzenie zasobów zostało anulowane.
Tworzenie
Usuwanie

HealthState

Stan zdrowia podmiotu
KnownHealthState może być używany zamiennie z HealthState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Zdrowy: Zdrowy stan
Degradacja: Degradacja
Niezdrowy: Niezdrowy status
Nieznany: Status nieznany
Usunięte: status usunięty

ManagedServiceIdentityType

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).
ZnaneManagedServiceIdentityType można używać zamiennie z wartością ManagedServiceIdentityType. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak: Brak tożsamości zarządzanej.
SystemAssigned: tożsamość zarządzana przypisana przez system.
UserAssigned: tożsamość zarządzana przypisana przez użytkownika.
SystemAssigned,UserAssigned: tożsamość zarządzana przypisana przez system i użytkownika.

MetricAggregationType

Typ agregacji metrycznej
KnownMetricAggregationType można używać zamiennie z MetricAggregationType, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

Brak
Średnia
Liczba
Minimum
Maksimum
Łącznie

Origin

Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system"
ZnaneOrigin można używać zamiennie z usługą Origin, wyliczenie zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

użytkownika: wskazuje, że operacja jest inicjowana przez użytkownika.
system: wskazuje, że operacja jest inicjowana przez system.
użytkownik,system: wskazuje, że operacja jest inicjowana przez użytkownika lub system.

RefreshInterval

Interwał odświeżania w formacie długości ISO
KnownRefreshInterval może być używany zamiennie z RefreshInterval, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

PT1M: Jedna minuta
PT5M: Pięć Minut
PT10M: Dziesięć minut
PT30M: Trzydzieści minut
PT1H: Jedna godzina
PT2H: Dwie godziny

SignalDefinitionPropertiesUnion

Alias dla SignalDefinitionPropertiesUnion

SignalInstancePropertiesUnion

Alias dla SignalInstancePropertiesUnion

SignalKind

Obsługiwane rodzaje sygnałów jako dyskryminatory
KnownSignalKind może być używany zamiennie z SignalKind, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

AzureResourceMetric
LogAnalyticsQuery
PrometheusMetricsQuery
Zewnętrzny

SignalOperator

Operator sygnalisty
KnownSignalOperator może być używany zamiennie z SignalOperator, a ten enum zawiera znane wartości obsługiwane przez usługę.

Znane wartości obsługiwane przez usługę

WiększyNiż: Większy niż
LessThan: Less than
LessThanOrEqual: Mniej lub równe
WiększyNiżJednak: Większy lub równy
Równy: równy
NieRówny: Nie równy

Wyliczenia

AzureClouds

Enum opisujące środowiska Azure Cloud.

KnownActionType

Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego.

KnownAlertSeverity

Stopień alarmu

KnownAuthenticationKind

Obsługiwane rodzaje ustawień uwierzytelniania jako dyskryminator

KnownCreatedByType

Rodzaj jednostki, która utworzyła zasób.

KnownDependenciesAggregationType

Typ agregacji dla zależności podrzędnych.

KnownDependenciesAggregationUnit

Typ jednostki dla progów agregacji zależności.

KnownDiscoveryRuleKind

Dyskryminator typu dyskryminator specyfikacji reguły odkrycia

KnownDiscoveryRuleRecommendedSignalsBehavior

Zalecane zachowanie sygnału regułą odkrywania

KnownDiscoveryRuleRelationshipDiscoveryBehavior

Zachowanie odkrywania relacji według reguły odkrywania

KnownEntityImpact

Rodzaj wpływu, jaki podmiot ma na propagację stanu zdrowia

KnownHealthModelProvisioningState

Stany dostarczania Modelu Opieki

KnownHealthState

Stan zdrowia podmiotu

KnownManagedServiceIdentityType

Typ tożsamości usługi zarządzanej (gdzie dozwolone są typy SystemAssigned i UserAssigned).

KnownMetricAggregationType

Typ agregacji metrycznej

KnownOrigin

Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system"

KnownRefreshInterval

Interwał odświeżania w formacie długości ISO

KnownSignalKind

Obsługiwane rodzaje sygnałów jako dyskryminatory

KnownSignalOperator

Operator sygnalisty

KnownVersions

Wersje interfejsu API

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

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

Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

Zmienne

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

Szczegóły funkcji

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Coś złapanego przez klauzulę catch.

Zwraca

e

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

Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.

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>

Zwraca

PollerLike<OperationState<TResult>, TResult>

Szczegóły zmiennej

RestError

Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.

RestError: RestErrorConstructor

Typ