@azure/arm-programenrollment package

Schnittstellen

DomainGroup

Eine Gruppe von edu-Domains, die auf einen Entra-Tenant beschränkt sind.

EduEnrollment

Eine Einschreibung in Bildungsprogrammen, die die Entra-Domänen unter einen einzigen souveränen/edu-Programmbereich gruppiert.

EduEnrollmentPatch

Der Typ, der für Update-Operationen des EduEnrollment verwendet wird.

EduEnrollmentProperties

Details zum Programm: EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Optionale Parameter.

EduEnrollmentsDeleteOptionalParams

Optionale Parameter.

EduEnrollmentsGetOptionalParams

Optionale Parameter.

EduEnrollmentsListByResourceGroupOptionalParams

Optionale Parameter.

EduEnrollmentsListBySubscriptionOptionalParams

Optionale Parameter.

EduEnrollmentsOperations

Schnittstelle stellt EduEnrollments-Operationen dar.

EduEnrollmentsUpdateOptionalParams

Optionale Parameter.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben.

Operation

Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird

OperationDisplay

Lokalisierte Anzeigeinformationen für eine Operation.

OperationsListOptionalParams

Optionale Parameter.

OperationsOperations

Schnittstelle, die vorgänge darstellt.

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.

ProgramEnrollmentClientOptionalParams

Optionale Parameter für den Client.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden

RestorePollerOptions
SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"

Typaliase

ActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownActionType kann austauschbar mit ActionType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Interne: Aktionen gelten nur für interne APIs.

AzureSupportedClouds

Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

CreatedByType

Die Art der Entität, die die Ressource erstellt hat.
KnownCreatedByType austauschbar mit CreatedByType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer-: Die Entität wurde von einem Benutzer erstellt.
Application: Die Entität wurde von einer Anwendung erstellt.
ManagedIdentity-: Die Entität wurde durch eine verwaltete Identität erstellt.
Key: Die Entität wurde mit einem Schlüssel erstellt.

DomainGroupState

Der Bewertungszustand einer Domänengruppe.
KnownDomainGroupState kann austauschbar mit DomainGroupState verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Ausstehend: Bewertung steht noch aus.
Erforderliche Aktion: Zur Durchführung der Bewertung ist eine Handlung erforderlich.
Durchgefallen: Bewertung fehlgeschlagen.
Erfolgreich: Bewertung erfolgreich.

Origin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownOrigin kann austauschbar mit Origin verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird.
System-: Gibt an, dass der Vorgang von einem System initiiert wird.
Benutzer,System: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wird.

ProvisioningState

Der Status des aktuellen Vorgangs.
KnownProvisioningState austauschbar mit ProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erfolgreich: Ressource wurde erstellt.
Fehlgeschlagene: Fehler bei der Ressourcenerstellung.
Abgebrochene: Die Ressourcenerstellung wurde abgebrochen.
Bereitstellung: Anfängliche Bereitstellung im Gange
Aktualisierung: Update läuft
Löschen: Löschung im Gange

Enumerationen

AzureClouds

Ein Enum zur Beschreibung von Azure Cloud-Umgebungen.

KnownActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.

KnownCreatedByType

Die Art der Entität, die die Ressource erstellt hat.

KnownDomainGroupState

Der Bewertungszustand einer Domänengruppe.

KnownOrigin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"

KnownProvisioningState

Der Status des aktuellen Vorgangs.

KnownVersions

Bekannte Werte von KnownVersions, die der Dienst akzeptiert.

Functions

isRestError(unknown)

Typeguard für RestError

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Umfragen auf einem anderen Host erstellen möchten oder ein Poller erstellt werden muss, nachdem das ursprüngliche Abfragefeld nicht im Gültigkeitsbereich liegt.

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

Parameter

serializedState

string

sourceOperation

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

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ