@azure/arm-programenrollment package

Interfejsy

DomainGroup

Grupa domen edu była dostosowana do tenanta Entra.

EduEnrollment

Zapis do programu edukacyjnego, który grupuje domeny Entra pod jednym zakresem programu suwerennego/edukacyjnego.

EduEnrollmentPatch

Typ używany do aktualizacji EduEnrollment.

EduEnrollmentProperties

Szczegóły programu EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Parametry opcjonalne.

EduEnrollmentsDeleteOptionalParams

Parametry opcjonalne.

EduEnrollmentsGetOptionalParams

Parametry opcjonalne.

EduEnrollmentsListByResourceGroupOptionalParams

Parametry opcjonalne.

EduEnrollmentsListBySubscriptionOptionalParams

Parametry opcjonalne.

EduEnrollmentsOperations

Interfejs reprezentujący operacje EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parametry opcjonalne.

ErrorAdditionalInfo

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

ErrorDetail

Szczegóły błędu.

ErrorResponse

Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji.

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.

PageSettings

Opcje dla metody byPage

PagedAsyncIterableIterator

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

ProgramEnrollmentClientOptionalParams

Parametry opcjonalne dla klienta.

Resource

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

RestorePollerOptions
SystemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

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ę"

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 ActionType. To 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.

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 parametrem CreatedByType, 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.

DomainGroupState

Stan oceny grupy domenowej.
KnownDomainGroupState może być używany zamiennie z DomainGroupState, a ten enum zawiera znane wartości obsługiwane przez usługę.

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

W trakcie oczekiwania: Ocena jest w trakcie realizacji.
Wymagane działania: Do zakończenia oceny wymagane jest działanie.
Niezaliczone: Ocena niezadowolona.
Sukces: Ocena zakończona sukcesem.

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

ProvisioningState

Stan bieżącej operacji.
KnownProvisioningState można używać zamiennie z parametrem ProvisioningState, wyliczenie zawiera znane wartości obsługiwane przez usługę.

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.
Provisioning: Wstępne udostępnianie w toku
Aktualizacja: Aktualizacja w toku
Usuwanie: Usuwanie w toku

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.

KnownCreatedByType

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

KnownDomainGroupState

Stan oceny grupy domenowej.

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"

KnownProvisioningState

Stan bieżącej operacji.

KnownVersions

Znane wartości KnownVersions akceptowanych przez usługę.

Funkcje

isRestError(unknown)

Funkcja Typeguard dla błędu RestError

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

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się 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>(ProgramEnrollmentClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Tworzy poller ze stanu serializowanego innego poller. Może to być przydatne, gdy chcesz utworzyć sondy na innym hoście lub poller musi zostać skonstruowany po tym, jak oryginalny nie znajduje się w zakresie.

function restorePoller<TResponse, TResult>(client: ProgramEnrollmentClient, 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