@azure/arm-programenrollment package

Interfaces

DomainGroup

Een groep edu-domeinen die beperkt zijn tot een Entra-huurder.

EduEnrollment

Een inschrijving voor onderwijsprogramma's die de entra-domeinen onder één enkele soeverein/edu programmascope groepeert.

EduEnrollmentPatch

Het type dat wordt gebruikt voor update-operaties van de EduEnrollment.

EduEnrollmentProperties

Details van het programma EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Optionele parameters.

EduEnrollmentsDeleteOptionalParams

Optionele parameters.

EduEnrollmentsGetOptionalParams

Optionele parameters.

EduEnrollmentsListByResourceGroupOptionalParams

Optionele parameters.

EduEnrollmentsListBySubscriptionOptionalParams

Optionele parameters.

EduEnrollmentsOperations

Interface die een EduEnrollments-operatie vertegenwoordigt.

EduEnrollmentsUpdateOptionalParams

Optionele parameters.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

Het foutdetail.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen.

Operation

Details van een REST API-bewerking, geretourneerd door de Resource Provider Operations-API

OperationDisplay

Gelokaliseerde weergave-informatie voor een operatie.

OperationsListOptionalParams

Optionele parameters.

OperationsOperations

Interface voor bewerkingen.

PageSettings

Opties voor de methode byPage

PagedAsyncIterableIterator

Een interface waarmee asynchrone iteratie zowel kan worden voltooid als per pagina.

ProgramEnrollmentClientOptionalParams

Optionele parameters voor de client.

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

RestorePollerOptions
SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TrackedResource

De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie

Type-aliassen

ActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.
KnownActionType kan door elkaar worden gebruikt met ActionType. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Interne: Acties zijn voor interne API's.

AzureSupportedClouds

De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreatedByType

Het type entiteit dat de resource heeft gemaakt.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker: de entiteit is gemaakt door een gebruiker.
application: de entiteit is gemaakt door een toepassing.
ManagedIdentity-: de entiteit is gemaakt door een beheerde identiteit.
Sleutel: de entiteit is gemaakt door een sleutel.

DomainGroupState

De beoordelingstoestand van een domeingroep.
KnownDomainGroupState kan door elkaar worden gebruikt met DomainGroupState; dit enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

In behandeling: Beoordeling is nog in behandeling.
ActieVereist: Actie is vereist om de beoordeling te voltooien.
Niet geslaagd: Beoordeling mislukt.
Geslaagd: Beoordeling geslaagd.

Origin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'
KnownOrigin kan door elkaar worden gebruikt met Origin. Deze opsomming bevat de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

gebruiker: geeft aan dat de bewerking door een gebruiker wordt gestart.
systeem: Geeft aan dat de bewerking door een systeem wordt gestart.
gebruiker, systeem: Geeft aan dat de bewerking wordt gestart door een gebruiker of systeem.

ProvisioningState

De status van de huidige bewerking.
KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.
Provisioning: Initiële provisioning in uitvoering
Update: Update in uitvoering
Verwijderen: Verwijderen in uitvoering

Enums

AzureClouds

Een enum om Azure Cloud-omgevingen te beschrijven.

KnownActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.

KnownCreatedByType

Het type entiteit dat de resource heeft gemaakt.

KnownDomainGroupState

De beoordelingstoestand van een domeingroep.

KnownOrigin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'

KnownProvisioningState

De status van de huidige bewerking.

KnownVersions

Bekende waarden van KnownVersions die de service accepteert.

Functies

isRestError(unknown)

Typeguard voor RestError

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

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

Hiermee maakt u een poller op basis van de geserialiseerde status van een andere poller. Dit kan handig zijn als u pollers wilt maken op een andere host of een poller moet worden gemaakt nadat het oorspronkelijke poller niet binnen het bereik valt.

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

Parameters

serializedState

string

sourceOperation

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

Retouren

PollerLike<OperationState<TResult>, TResult>

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type