@azure/arm-programenrollment package

Gränssnitt

DomainGroup

En grupp edu-domäner begränsade till en Entra-hyresgäst.

EduEnrollment

En utbildningsprogramregistrering som grupperar Entra-domäner under ett enda suverän/edu-programomfång.

EduEnrollmentPatch

Den typ som används för uppdateringsoperationer av EduEnrollment.

EduEnrollmentProperties

Detaljer om programmet EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Valfria parametrar.

EduEnrollmentsDeleteOptionalParams

Valfria parametrar.

EduEnrollmentsGetOptionalParams

Valfria parametrar.

EduEnrollmentsListByResourceGroupOptionalParams

Valfria parametrar.

EduEnrollmentsListBySubscriptionOptionalParams

Valfria parametrar.

EduEnrollmentsOperations

Gränssnitt som representerar EduEnrollments-operationer.

EduEnrollmentsUpdateOptionalParams

Valfria parametrar.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer.

Operation

Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder

OperationDisplay

Lokaliserad visningsinformation för en operation.

OperationsListOptionalParams

Valfria parametrar.

OperationsOperations

Gränssnitt som representerar åtgärder.

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

ProgramEnrollmentClientOptionalParams

Valfria parametrar för klienten.

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

RestorePollerOptions
SystemData

Metadata som rör skapande och senaste ändring av resursen.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

Typalias

ActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.
KnownActionType kan användas utbytbart med ActionType, den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

intern: Åtgärder gäller endast interna API:er.

AzureSupportedClouds

De värden som stöds för molninställningen som en strängliteraltyp

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CreatedByType

Den typ av entitet som skapade resursen.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.

DomainGroupState

Bedömningstillståndet för en domängrupp.
KnownDomainGroupState kan användas omväxlande med DomainGroupState, detta enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

Väntar: Bedömning är under behandling.
Åtgärd krävs: Handling krävs för att slutföra bedömningen.
Underkänd: Bedömningen misslyckades.
Lyckades: Bedömningen lyckades.

Origin

Den som ska utföra operationen; såsom i resursbaserad behörighetskontroll (RBAC) och användarupplevelsen för granskningsloggar. Standardvärdet är "user,system"
KnownOrigin kan användas omväxlande med Origin. Den här uppräkningen innehåller de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

användare: Anger att åtgärden initieras av en användare.
system: Anger att åtgärden initieras av ett system.
användare, system: Anger att åtgärden initieras av en användare eller ett system.

ProvisioningState

Status för den aktuella åtgärden.
KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.
Provisionering: Initial provisionering pågår
Uppdatering: Uppdatering pågår
Radering: Radering pågår

Uppräkningar

AzureClouds

Ett enum för att beskriva Azure Cloud-miljöer.

KnownActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.

KnownCreatedByType

Den typ av entitet som skapade resursen.

KnownDomainGroupState

Bedömningstillståndet för en domängrupp.

KnownOrigin

Den som ska utföra operationen; såsom i resursbaserad behörighetskontroll (RBAC) och användarupplevelsen för granskningsloggar. Standardvärdet är "user,system"

KnownProvisioningState

Status för den aktuella åtgärden.

KnownVersions

Kända värden för KnownVersions som tjänsten accepterar.

Funktioner

isRestError(unknown)

Typeguard för RestError

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

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

Skapar en poller från det serialiserade tillståndet för en annan poller. Detta kan vara användbart när du vill skapa pollers på en annan värd eller om en poller måste konstrueras när den ursprungliga inte finns i omfånget.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ