@azure/arm-programenrollment package

Antarmuka

DomainGroup

Sekelompok domain edu yang dicakup ke penyewa Entra.

EduEnrollment

Pendaftaran program pendidikan yang mengelompokkan domain Entra di bawah satu ruang lingkup program kedaulatan/edu.

EduEnrollmentPatch

Jenis yang digunakan untuk operasi pembaruan EduEnrollment.

EduEnrollmentProperties

Rincian Program EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Parameter opsional.

EduEnrollmentsDeleteOptionalParams

Parameter opsional.

EduEnrollmentsGetOptionalParams

Parameter opsional.

EduEnrollmentsListByResourceGroupOptionalParams

Parameter opsional.

EduEnrollmentsListBySubscriptionOptionalParams

Parameter opsional.

EduEnrollmentsOperations

Antarmuka yang mewakili operasi EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parameter opsional.

ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

ErrorDetail

Detail kesalahan.

ErrorResponse

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal.

Operation

Detail operasi REST API, dikembalikan dari API Operasi Penyedia Sumber Daya

OperationDisplay

Informasi tampilan yang dilokalkan untuk suatu operasi.

OperationsListOptionalParams

Parameter opsional.

OperationsOperations

Antarmuka yang mewakili operasi Operasi.

PageSettings

Opsi untuk metode byPage

PagedAsyncIterableIterator

Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.

ProgramEnrollmentClientOptionalParams

Parameter opsional untuk klien.

Resource

Bidang umum yang dikembalikan dalam respons untuk semua sumber daya Azure Resource Manager

RestorePollerOptions
SystemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

TrackedResource

Definisi model sumber daya untuk Sumber Daya Azure Resource Manager melacak sumber daya tingkat atas yang memiliki 'tag' dan 'lokasi'

Alias Jenis

ActionType

Enum yang dapat diperluas. Menunjukkan jenis tindakan. "Internal" mengacu pada tindakan yang hanya untuk API internal saja.
KnownActionType dapat digunakan secara bergantian dengan ActionType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Internal : Tindakan adalah untuk API internal saja.

AzureSupportedClouds

Nilai yang didukung untuk pengaturan cloud sebagai jenis literal string

ContinuablePage

Antarmuka yang menjelaskan halaman hasil.

CreatedByType

Jenis entitas yang membuat sumber daya.
KnownCreatedByType dapat digunakan secara bergantian dengan CreatedByType, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Pengguna : Entitas dibuat oleh pengguna.
Aplikasi : Entitas dibuat oleh aplikasi.
ManagedIdentity: Entitas dibuat oleh identitas terkelola.
Key: Entitas dibuat oleh kunci.

DomainGroupState

Status penilaian grup domain.
KnownDomainGroupState dapat digunakan secara bergantian dengan DomainGroupState, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Tertunda: Penilaian tertunda.
ActionRequired: Tindakan diperlukan untuk menyelesaikan penilaian.
Gagal: Penilaian gagal.
Berhasil: Penilaian berhasil.

Origin

Pelaksana operasi yang dimaksudkan; seperti dalam Resource Based Access Control (RBAC) dan log audit UX. Nilai defaultnya adalah "user,system"
KnownOrigin dapat digunakan secara bergantian dengan Origin, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

pengguna : Menunjukkan operasi dimulai oleh pengguna.
sistem : Menunjukkan operasi dimulai oleh sistem.
pengguna,sistem : Menunjukkan operasi dimulai oleh pengguna atau sistem.

ProvisioningState

Status operasi saat ini.
KnownProvisioningState dapat digunakan secara bergantian dengan ProvisioningState, enum ini berisi nilai yang diketahui yang didukung layanan.

Nilai yang diketahui didukung oleh layanan

Berhasil: Sumber daya telah dibuat.
Gagal: Pembuatan sumber daya gagal.
Dibatalkan: Pembuatan sumber daya dibatalkan.
Penyediaan: Penyediaan awal sedang berlangsung
Memperbarui: Pembaruan sedang berlangsung
Penghapusan: Penghapusan sedang berlangsung

Enum

AzureClouds

Enum untuk mendeskripsikan lingkungan Azure Cloud.

KnownActionType

Enum yang dapat diperluas. Menunjukkan jenis tindakan. "Internal" mengacu pada tindakan yang hanya untuk API internal saja.

KnownCreatedByType

Jenis entitas yang membuat sumber daya.

KnownDomainGroupState

Status penilaian grup domain.

KnownOrigin

Pelaksana operasi yang dimaksudkan; seperti dalam Resource Based Access Control (RBAC) dan log audit UX. Nilai defaultnya adalah "user,system"

KnownProvisioningState

Status operasi saat ini.

KnownVersions

Nilai KnownVersions yang diketahui yang diterima layanan.

Fungsi

isRestError(unknown)

Typeguard untuk RestError

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

Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan.

Variabel

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

Detail Fungsi

isRestError(unknown)

Typeguard untuk RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Sesuatu tertangkap oleh klausul tangkapan.

Mengembalikan

e

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

Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan.

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>

Mengembalikan

PollerLike<OperationState<TResult>, TResult>

Detail Variabel

RestError

Jenis kesalahan kustom untuk permintaan alur yang gagal.

RestError: RestErrorConstructor

Jenis