@azure/arm-programenrollment package

Rozhraní

DomainGroup

Skupina edu domén zaměřených na tenanta Entra.

EduEnrollment

Zápis do vzdělávacího programu, který sdružuje domény Entra pod jeden suverénní/vzdělávací program.

EduEnrollmentPatch

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

EduEnrollmentProperties

Podrobnosti o programu EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Volitelné parametry.

EduEnrollmentsDeleteOptionalParams

Volitelné parametry.

EduEnrollmentsGetOptionalParams

Volitelné parametry.

EduEnrollmentsListByResourceGroupOptionalParams

Volitelné parametry.

EduEnrollmentsListBySubscriptionOptionalParams

Volitelné parametry.

EduEnrollmentsOperations

Rozhraní reprezentující operace EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Volitelné parametry.

ErrorAdditionalInfo

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

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích.

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í iteraci k dokončení i po stránce.

ProgramEnrollmentClientOptionalParams

Volitelné parametry pro klienta.

Resource

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

RestorePollerOptions
SystemData

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

TrackedResource

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

Aliasy typu

ActionType

Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.
Pole KnownActionType 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čené pouze pro interní rozhraní API.

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

user: Entita byla vytvořena uživatelem.
Application: Entita byla vytvořena aplikací.
ManagedIdentity: Entita byla vytvořena spravovanou identitou.
Klíč: Entita byla vytvořena klíčem.

DomainGroupState

Stav hodnocení doménové skupiny.
KnownDomainGroupState lze použít zaměnitelně s DomainGroupState, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Čeká na to: Posouzení je v přípravě.
Nutná akce: K dokončení hodnocení je vyžadována akce.
Neúspěšné: Hodnocení neúspěšné.
Úspěch: Hodnocení úspěšné.

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.
Pole KnownOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

uživatel: Označuje, že operace je inicializována uživatelem.
systémová: Označuje, že operace je inicializována systémem.
uživatel, systémová: Označuje, že operace je inicializována uživatelem nebo systémem.

ProvisioningState

Stav aktuální operace.
KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet 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.
Provisioning: Probíhá počáteční provisioning
Aktualizace: Probíhá aktualizace
Mazání: Smazání v procesu

Výčty

AzureClouds

Enum pro popis prostředí Azure Cloud.

KnownActionType

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

KnownCreatedByType

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

KnownDomainGroupState

Stav hodnocení doménové skupiny.

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.

KnownProvisioningState

Stav aktuální operace.

KnownVersions

Známé hodnoty KnownVersions, které služba přijímá.

Funkce

isRestError(unknown)

Typeguard pro RestError

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

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

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>(ProgramEnrollmentClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Vytvoří poller ze serializovaného stavu jiného polleru. To může být užitečné v případě, že chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller po původním dotazu, který není v rozsahu.

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>

Návraty

PollerLike<OperationState<TResult>, TResult>

Podrobnosti proměnné

RestError

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

RestError: RestErrorConstructor

Typ