@azure/arm-programenrollment package

Interfacce

DomainGroup

Un gruppo di domini edu con ambito fino a un tenant Entra.

EduEnrollment

Un'iscrizione a un programma educativo che raggruppa i domini Entra sotto un unico ambito di programma sovrano/educativo.

EduEnrollmentPatch

Il tipo usato per le operazioni di aggiornamento dell'EduEnrollment.

EduEnrollmentProperties

Dettagli del programma EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Parametri facoltativi.

EduEnrollmentsDeleteOptionalParams

Parametri facoltativi.

EduEnrollmentsGetOptionalParams

Parametri facoltativi.

EduEnrollmentsListByResourceGroupOptionalParams

Parametri facoltativi.

EduEnrollmentsListBySubscriptionOptionalParams

Parametri facoltativi.

EduEnrollmentsOperations

Interfaccia che rappresenta un'operazione di EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parametri facoltativi.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta comune all'errore per tutte le API di Azure Resource Manager per restituire dettagli di errore per operazioni fallite.

Operation

Dettagli di un'operazione API REST, restituita dall'API operazioni del provider di risorse

OperationDisplay

Informazioni di visualizzazione localizzate per un'operazione.

OperationsListOptionalParams

Parametri facoltativi.

OperationsOperations

Interfaccia che rappresenta un'operazione operations.

PageSettings

Opzioni per il metodo byPage

PagedAsyncIterableIterator

Interfaccia che consente l'iterazione iterabile asincrona sia al completamento che alla pagina.

ProgramEnrollmentClientOptionalParams

Parametri facoltativi per il client.

Resource

Campi comuni restituiti nella risposta per tutte le risorse di Azure Resource Manager

RestorePollerOptions
SystemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TrackedResource

La definizione del modello di risorsa per una risorsa di livello superiore di Azure Resource Manager con "tag" e "location"

Alias tipo

ActionType

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.
KnownActionType può essere usato in modo intercambiabile con ActionType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

interno: le azioni sono destinate alle API solo interne.

AzureSupportedClouds

I valori supportati per l'impostazione cloud come tipo letterale stringa

ContinuablePage

Interfaccia che descrive una pagina di risultati.

CreatedByType

Tipo di entità che ha creato la risorsa.
KnownCreatedByType può essere usato in modo intercambiabile con CreatedByType, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

User: l'entità è stata creata da un utente.
'applicazione: l'entità è stata creata da un'applicazione.
ManagedIdentity: l'entità è stata creata da un'identità gestita.
Key: l'entità è stata creata da una chiave.

DomainGroupState

Lo stato di valutazione di un gruppo di domini.
KnownDomainGroupState può essere usato in modo intercambiabile con DomainGroupState, questo enum contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

In sospeso: La valutazione è in attesa.
Azione Richiesta: È necessaria un'azione per completare la valutazione.
Fallito: Valutazione fallita.
Riuscito: Valutazione riuscita a buon fine.

Origin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. Il valore predefinito è "user, system"
KnownOrigin può essere usato in modo intercambiabile con Origin, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

'utente: indica che l'operazione viene avviata da un utente.
di sistema: indica che l'operazione viene avviata da un sistema.
utente,di sistema: indica che l'operazione viene avviata da un utente o da un sistema.

ProvisioningState

Stato dell'operazione corrente.
KnownProvisioningState può essere usato in modo intercambiabile con ProvisioningState, questa enumerazione contiene i valori noti supportati dal servizio.

Valori noti supportati dal servizio

Operazione riuscita: la risorsa è stata creata.
non riuscito: creazione della risorsa non riuscita.
annullata: la creazione della risorsa è stata annullata.
Provisioning: Provisioning iniziale in corso
Aggiornamento: aggiornamento in corso
Cancellazione: cancellazione in corso

Enumerazioni

AzureClouds

Un enum per descrivere gli ambienti Azure Cloud.

KnownActionType

Enumerazione estendibile. Indica il tipo di azione. "Interno" si riferisce alle azioni destinate solo alle API interne.

KnownCreatedByType

Tipo di entità che ha creato la risorsa.

KnownDomainGroupState

Lo stato di valutazione di un gruppo di domini.

KnownOrigin

Esecutore previsto dell'operazione; come nel Controllo degli accessi basato sulle risorse (RBAC) e nell'interfaccia utente dei log di audit. Il valore predefinito è "user, system"

KnownProvisioningState

Stato dell'operazione corrente.

KnownVersions

Valori noti di KnownVersions accettati dal servizio.

Funzioni

isRestError(unknown)

Typeguard per RestError

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

Variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

Dettagli funzione

isRestError(unknown)

Typeguard per RestError

function isRestError(e: unknown): e

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e

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

Crea un poller dallo stato serializzato di un altro poller. Questo può essere utile quando si desidera creare poller in un host diverso o un poller deve essere costruito dopo che quello originale non è nell'ambito.

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

Parametri

serializedState

string

sourceOperation

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

Valori restituiti

PollerLike<OperationState<TResult>, TResult>

Dettagli delle variabili

RestError

Tipo di errore personalizzato per le richieste di pipeline non riuscite.

RestError: RestErrorConstructor

Tipo