@azure/arm-selfhelp package

Klasy

HelpRP

Interfejsy

AutomatedCheckResult

Tylko dla typu AutomatedStep

CheckNameAvailabilityCheckAvailabilityOptionalParams

Parametry opcjonalne.

CheckNameAvailabilityOperations

Interfejs reprezentujący operacje CheckNameAvailability.

CheckNameAvailabilityRequest

Treść żądania sprawdzania dostępności.

CheckNameAvailabilityResponse

Odpowiedź na to, czy żądana nazwa zasobu jest dostępna, czy nie.

ClassificationService

Obiekt wyniku klasyfikacji usługi.

ContinueRequestBody

Treść narzędzia do rozwiązywania problemów ContinueRequest.

Diagnostic

Właściwości zwracane w szczegółowych informacjach.

DiagnosticInvocation

Wywołanie rozwiązania z dodatkowymi parametrami wymaganymi do wywołania.

DiagnosticResource

Zasób diagnostyczny

DiagnosticResourceProperties

Właściwości zasobów diagnostycznych.

DiagnosticsCreateOptionalParams

Parametry opcjonalne.

DiagnosticsGetOptionalParams

Parametry opcjonalne.

DiagnosticsOperations

Interfejs reprezentujący operacje diagnostyczne.

DiscoveryNlpRequest

Odnajdź żądanie NLP.

DiscoveryNlpResponse

Pomyślnie pobrano listę metadanych rozwiązania.

DiscoverySolutionListOptionalParams

Parametry opcjonalne.

DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams

Parametry opcjonalne.

DiscoverySolutionNLPDiscoverSolutionsOptionalParams

Parametry opcjonalne.

DiscoverySolutionNLPOperations

Interfejs reprezentujący operacje DiscoverySolutionNLP.

DiscoverySolutionOperations

Interfejs reprezentujący operacje DiscoverySolution.

ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorModel

Definicja 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.

ExtensionResource

Podstawowy zasób rozszerzenia.

Filter

Kryterium filtrowania

FilterGroup

Grupa filtrów

HelpRPOptionalParams

Opcjonalne parametry dla klienta.

Insight

Szczegółowe szczegółowe informacje uzyskane za pośrednictwem wywołania diagnostyki szczegółowych informacji

MetricsBasedChart

Wykres oparty na metrykach rozwiązań

NlpSolutions

Metadane NLP.

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 metody byPage

PagedAsyncIterableIterator

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

ProxyResource

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

ReplacementMaps

Mapy zastępcze rozwiązania.

ReplacementMapsSelfHelp

Mapy zastępcze rozwiązania.

Resource

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

ResponseOption

Stan zasobu.

ResponseValidationProperties

Właściwości weryfikacji odpowiedzi wejściowej kroku narzędzia do rozwiązywania problemów

RestartTroubleshooterResponse

Odpowiedź na ponowne uruchomienie narzędzia do rozwiązywania problemów

RestorePollerOptions
SearchResult

Szczegóły wyniku wyszukiwania w usłudze AzureKB.

Section

Część rozwiązania i są podziałami w renderowaniu rozwiązania.

SectionSelfHelp

Część rozwiązania i są podziałami w renderowaniu rozwiązania.

SimplePollerLike

Prosty poller, który może służyć do sondowania długotrwałej operacji.

SimplifiedSolutionsCreateOptionalParams

Parametry opcjonalne.

SimplifiedSolutionsGetOptionalParams

Parametry opcjonalne.

SimplifiedSolutionsOperations

Interfejs reprezentujący operacje SimplifiedSolutions.

SimplifiedSolutionsResource

Uproszczona odpowiedź na rozwiązania.

SimplifiedSolutionsResourceProperties

Wynik uproszczonych rozwiązań

SolutionCreateOptionalParams

Parametry opcjonalne.

SolutionGetOptionalParams

Parametry opcjonalne.

SolutionMetadataProperties

Właściwości metadanych

SolutionMetadataResource

Zasób metadanych

SolutionNlpMetadataResource

Zasób metadanych nlp

SolutionOperations

Interfejs reprezentujący operacje rozwiązania.

SolutionPatchRequestBody

Treść patchrequest rozwiązania

SolutionResource

Odpowiedź na rozwiązanie.

SolutionResourceProperties

Wynik rozwiązania

SolutionResourceSelfHelp

Odpowiedź rozwiązania samodzielnej pomocy.

SolutionSelfHelpGetOptionalParams

Parametry opcjonalne.

SolutionSelfHelpOperations

Interfejs reprezentujący operacje SolutionSelfHelp.

SolutionUpdateOptionalParams

Parametry opcjonalne.

SolutionWarmUpOptionalParams

Parametry opcjonalne.

SolutionWarmUpRequestBody

Treść rozwiązania WarmUpRequest

Solutions

Lista rozwiązań

SolutionsDiagnostic

Diagnostyka rozwiązań

SolutionsResourcePropertiesSelfHelp

Wynik rozwiązania

SolutionsTroubleshooters

Narzędzia do rozwiązywania problemów w rozwiązaniach

Step

Krok narzędzia do rozwiązywania problemów

StepInput

Szczegóły danych wejściowych kroków.

SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

TriggerCriterion

Kryterium wyzwalacza żądania rozwiązania. SolutionId/ProblemClassificationId jest jedynym obsługiwanym typem wyzwalacza dla żądania PUT rozwiązania. ReplacementKey jest jedynym obsługiwanym typem wyzwalacza dla żądania PATCH rozwiązania.

TroubleshooterInstanceProperties

Właściwości wystąpienia narzędzia do rozwiązywania problemów.

TroubleshooterResource

Odpowiedź na narzędzie do rozwiązywania problemów.

TroubleshooterResponse

Odpowiedź użytkownika na żądanie kontynuacji narzędzia do rozwiązywania problemów

TroubleshootersContinueOptionalParams

Parametry opcjonalne.

TroubleshootersCreateOptionalParams

Parametry opcjonalne.

TroubleshootersEndOptionalParams

Parametry opcjonalne.

TroubleshootersGetOptionalParams

Parametry opcjonalne.

TroubleshootersOperations

Interfejs reprezentujący operacje Troubleshooter.

TroubleshootersRestartOptionalParams

Parametry opcjonalne.

Video

Szczegóły wideo

VideoGroup

Szczegóły grupy wideo

VideoGroupVideo

Szczegóły wideo grupy wideo

WebResult

Wynik internetowy usługi AzureKB

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.

AggregationType

Dozwolone wartości to Sum, Avg, Count, Min, Max. Domyślna to suma
KnownAggregationType może być używany zamiennie z AggregationType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Sum
Avg
liczba
Minuta
Maksimum

AutomatedCheckResultType

Typ wyniku.
KnownAutomatedCheckResultType może być używany zamiennie z AutomatedCheckResultType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Powodzenie
Ostrzeżenie
Błąd
Informacje

AzureSupportedClouds

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

Confidence

Pewność wyniku wyszukiwania.
KnownConfidence może być używany zamiennie z Confidence, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Niski
Średni
Wysoki

ContinuablePage

Interfejs opisujący stronę z wynikami.

CreatedByType

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

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

Użytkownik: Encja została utworzona przez użytkownika.
Aplikacja: Jednostka została utworzona przez aplikację.
ManagedIdentity: jednostka została utworzona przez tożsamość zarządzaną.
Klucz: Jednostka została utworzona za pomocą klucza.

DiagnosticProvisioningState

Stan aprowizacji diagnostycznej.
KnownDiagnosticProvisioningState może być używany zamiennie z DiagnosticProvisioningState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

powodzeniem: wszystkie dane diagnostyczne w usłudze Batch zakończyły się pomyślnie.
partialComplete: Niektóre diagnostyki są nadal uruchomione lub nie powiodły się.
niepowodzenie: nie można uruchomić całej diagnostyki.
Uruchomione: wszystkie narzędzia diagnostyczne są nadal uruchomione.
anulowane: po anulowaniu żądania diagnostycznego.

ExecutionStatus

Stan wykonywania kroku narzędzia do rozwiązywania problemów.
KnownExecutionStatus można używać zamiennie z parametrem ExecutionStatus, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Powodzenie: Wykonanie kroku powiodło się.
Uruchamianie: Wykonywanie kroku jest uruchomione
Niepowodzenie: Wykonanie kroku nie powiodło się
Ostrzeżenie: Ostrzeżenie o wykonaniu kroku

ImportanceLevel

Poziom ważności szczegółowych informacji.
KnownImportanceLevel można używać zamiennie z wartością ImportanceLevel, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

krytyczne: po uruchomieniu diagnostyki znaleziono krytyczne informacje.
ostrzeżenie: po uruchomieniu diagnostyki znaleziono szczegółowe informacje ostrzegawcze.
Information: Po uruchomieniu diagnostyki znaleziono szczegółowe informacje.

Name

Nazwa kryterium wyzwalacza.
ZnaneNazwa może być używana zamiennie z nazwą. To wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Identyfikator rozwiązania
ProblemClassificationId (Identyfikator klasyfikacji)
Klucz zastępczy

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.

QuestionContentType

Wartość domyślna to Tekst.
KnownQuestionContentType może być używany zamiennie z QuestionContentType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Tekst
Język HTML
Markdown

QuestionType

Rodzaj pytania
KnownQuestionType może być używany zamiennie z QuestionType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

RadioButton: Przycisk radiowy SingleChoice
Lista rozwijana: lista rozwijana SingleChoice.
TextInput: Wprowadzanie tekstu
MultiLineInfoBox: MultiLineInfoBox
DateTimePicker: Selektor daty/godziny
Wybór wielokrotny: Wybór wielokrotny

ResultType

Typ wyniku wyszukiwania.
KnownResultType może być używany zamiennie z ResultType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Społeczność
dokumentacja

SolutionProvisioningState

Stan aprowizacji rozwiązania.
KnownSolutionProvisioningState może być używany zamiennie z SolutionProvisioningState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Powodzenie: Wszystkie rozwiązania w partii zakończyły się pomyślnie.
PartialComplete: Niektóre rozwiązania są nadal uruchomione lub zakończyły się niepowodzeniem.
Niepowodzenie: Nie można uruchomić wszystkich rozwiązań.
Uruchomione: wszystkie rozwiązania są nadal uruchomione.
Anulowane: gdy żądanie rozwiązania zostanie anulowane.

SolutionType

Typ rozwiązania.
KnownSolutionType może być używany zamiennie z SolutionType, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Diagnostyka: typ zasobu diagnostyki.
Rozwiązania: typ zasobu Rozwiązania.
Narzędzia do rozwiązywania problemów: typ zasobu Narzędzia do rozwiązywania problemów.
SelfHelp: typ zasobu SelfHelp.

Status

Oznacza stan zasobu diagnostycznego.
znanystatus można używać zamiennie ze stanem. Wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Niepowodzenie: tworzenie diagnostyki nie powiodło się.
MissingInputs: brak wymaganych danych wejściowych do uruchomienia żądania.
Uruchomiona: diagnostyka jest nadal uruchomiona.
Powodzenie: tworzenie diagnostyki powiodło się.
limit czasu: przekroczono limit czasu diagnostyki.

TroubleshooterProvisioningState

Stan aprowizacji narzędzia do rozwiązywania problemów.
KnownTroubleshooterProvisioningState może być używany zamiennie z TroubleshooterProvisioningState, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Powodzenie
Nie działa
Anulowane
Działa
Automatyczne kontynuowanie

Type

Typ kroku rozwiązywania problemów.
znany typ może być używany zamiennie z typem, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Decyzja
Rozwiązanie
Wgląd
Zautomatyzowana kontrola
Dane wejściowe

ValidationScope

Zakres walidacji
KnownValidationScope może być używany zamiennie z ValidationScope, to wyliczenie zawiera znane wartości obsługiwane przez usługę.

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

Brak
URLFormat
GuidFormat
Format adresu IP
NumberOnlyFormat (Tylko Liczba)

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.

KnownAggregationType

Dozwolone wartości to Sum, Avg, Count, Min, Max. Wartość domyślna to Suma

KnownAutomatedCheckResultType

Typ wyniku.

KnownConfidence

Pewność wyniku wyszukiwania.

KnownCreatedByType

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

KnownDiagnosticProvisioningState

Stan aprowizacji diagnostycznej.

KnownExecutionStatus

Stan wykonywania kroku narzędzia do rozwiązywania problemów.

KnownImportanceLevel

Poziom ważności szczegółowych informacji.

KnownName

Nazwa kryterium wyzwalacza.

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"

KnownQuestionContentType

Wartość domyślna to Tekst.

KnownQuestionType

Typ pytania

KnownResultType

Typ wyniku wyszukiwania.

KnownSolutionProvisioningState

Stan aprowizacji rozwiązania.

KnownSolutionType

Typ rozwiązania.

KnownStatus

Oznacza stan zasobu diagnostycznego.

KnownTroubleshooterProvisioningState

Stan aprowizacji narzędzia do rozwiązywania problemów.

KnownType

Typ kroku rozwiązywania problemów.

KnownValidationScope

Zakres weryfikacji

KnownVersions

Dostępne wersje interfejsu API.

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

restorePoller<TResponse, TResult>(HelpRP, 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>(HelpRP, 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: HelpRP, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

client
HelpRP
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