@azure/arm-programenrollment package

Интерфейсы

DomainGroup

Группа edu-доменов, ограниченных на Entra tenant.

EduEnrollment

Это образовательная программа, объединяющая домены Entra под единой суверенной/образовательной программой.

EduEnrollmentPatch

Тип, используемый для операций обновления EduEnrollment.

EduEnrollmentProperties

Подробности программы EduEnrollment.

EduEnrollmentsCreateOrUpdateOptionalParams

Необязательные параметры.

EduEnrollmentsDeleteOptionalParams

Необязательные параметры.

EduEnrollmentsGetOptionalParams

Необязательные параметры.

EduEnrollmentsListByResourceGroupOptionalParams

Необязательные параметры.

EduEnrollmentsListBySubscriptionOptionalParams

Необязательные параметры.

EduEnrollmentsOperations

Интерфейс, представляющий операции EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Необязательные параметры.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Подробности ошибки.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях.

Operation

Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов

OperationDisplay

Локализованная информация для отображения операции.

OperationsListOptionalParams

Необязательные параметры.

OperationsOperations

Интерфейс, представляющий операции операций.

PageSettings

Параметры метода byPage

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

ProgramEnrollmentClientOptionalParams

Необязательные параметры для клиента.

Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager

RestorePollerOptions
SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.

TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением

Псевдонимы типа

ActionType

Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.
KnownActionType можно использовать взаимозаменяемо с ActionType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

внутренних: действия предназначены для внутренних API.

AzureSupportedClouds

Поддерживаемые значения для настройки облака в виде строкового литерала

ContinuablePage

Интерфейс, описывающий страницу результатов.

CreatedByType

Тип сущности, создающей ресурс.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user: сущность была создана пользователем.
приложения: сущность была создана приложением.
ManagedIdentity: сущность была создана управляемым удостоверением.
ключ: сущность была создана ключом.

DomainGroupState

Состояние оценки группы доменов.
KnownDomainGroupState может использоваться как синонимы с DomainGroupState, этот enum содержит известные значения, поддерживаемые сервисом.

Известные значения, поддерживаемые службой

Ожидается: Оценка находится в ожидании.
ДействиеТребуется: Для завершения оценки требуется действие.
Неуспешно: Оценка провалилась.
Успешно: Оценка прошла успешно.

Origin

Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — user, system
KnownOrigin можно использовать взаимозаменяемо с Origin, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

пользователя. Указывает, что операция инициируется пользователем.
системный: указывает, что операция инициируется системой.
пользователя, системная: указывает, что операция инициируется пользователем или системой.

ProvisioningState

Состояние текущей операции.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

успешно создан: ресурс создан.
сбой: сбой создания ресурса.
отменено: создание ресурса было отменено.
Provisioning: Начальная подготовка в процессе
Обновление: Обновление в процессе
Удаление: Удаление в процессе

Перечисления

AzureClouds

Enum для описания среды Azure Cloud.

KnownActionType

Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API.

KnownCreatedByType

Тип сущности, создающей ресурс.

KnownDomainGroupState

Состояние оценки группы доменов.

KnownOrigin

Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — user, system

KnownProvisioningState

Состояние текущей операции.

KnownVersions

Известные значения KnownVersions, которые принимает служба.

Функции

isRestError(unknown)

Typeguard для RestError

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

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

Переменные

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

Сведения о функции

isRestError(unknown)

Typeguard для RestError

function isRestError(e: unknown): e

Параметры

e

unknown

Что-то поймано предложением catch.

Возвращаемое значение

e

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

Создает опрашиватель из сериализованного состояния другого опрашителя. Это может быть полезно, если вы хотите создать опросы на другом узле или опросщике необходимо создать после того, как исходный не находится в области.

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

Параметры

serializedState

string

sourceOperation

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

Возвращаемое значение

PollerLike<OperationState<TResult>, TResult>

Сведения об переменной

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

RestError: RestErrorConstructor

Тип