@azure/arm-programenrollment package

Interfaces

DomainGroup

Un grupo de dominios de edu con alcance a un inquilino Entra.

EduEnrollment

Una matrícula en un programa educativo que agrupa los dominios de Entra bajo un único ámbito de programa soberano/edu.

EduEnrollmentPatch

El tipo utilizado para las operaciones de actualización del EduEnrollment.

EduEnrollmentProperties

Detalles del programa: EduInscripción.

EduEnrollmentsCreateOrUpdateOptionalParams

Parámetros opcionales.

EduEnrollmentsDeleteOptionalParams

Parámetros opcionales.

EduEnrollmentsGetOptionalParams

Parámetros opcionales.

EduEnrollmentsListByResourceGroupOptionalParams

Parámetros opcionales.

EduEnrollmentsListBySubscriptionOptionalParams

Parámetros opcionales.

EduEnrollmentsOperations

Interfaz que representa una operación de EduEnrollments.

EduEnrollmentsUpdateOptionalParams

Parámetros opcionales.

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas.

Operation

Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos

OperationDisplay

Información de visualización localizada para una operación.

OperationsListOptionalParams

Parámetros opcionales.

OperationsOperations

Interfaz que representa una operación de operaciones.

PageSettings

Opciones para el método byPage

PagedAsyncIterableIterator

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

ProgramEnrollmentClientOptionalParams

Parámetros opcionales para el cliente.

Resource

Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager

RestorePollerOptions
SystemData

Metadatos relativos a la creación y última modificación del recurso.

TrackedResource

La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación".

Alias de tipos

ActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.
KnownActionType se puede usar indistintamente con ActionType; esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

interno: las acciones son para las API solo internas.

AzureSupportedClouds

Los valores admitidos para la configuración de nube como un tipo literal de cadena

ContinuablePage

Interfaz que describe una página de resultados.

CreatedByType

Tipo de entidad que creó el recurso.
KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Usuario: un usuario creó la entidad.
Application: la entidad la creó una aplicación.
ManagedIdentity: la entidad se creó mediante una identidad administrada.
Key: la entidad se creó mediante una clave.

DomainGroupState

El estado de evaluación de un grupo de dominios.
KnownDomainGroupState puede usarse indistintamente con DomainGroupState, este enum contiene los valores conocidos que soporta el servicio.

Valores conocidos admitidos por el servicio

Pendiente: La evaluación está pendiente.
AcciónRequerida: Se requiere acción para completar la evaluación.
Suspendido: Evaluación suspendida.
Éxito: Evaluación exitosa.

Origin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"
KnownOrigin se puede usar indistintamente con Origin, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

usuario: indica que un usuario inicia la operación.
del sistema: indica que un sistema inicia la operación.
usuario,del sistema: indica que un usuario o sistema inicia la operación.

ProvisioningState

Estado de la operación actual.
KnownProvisioningState se puede usar indistintamente con ProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

Correcto: se ha creado el recurso.
Error: Error en la creación de recursos.
cancelada: se canceló la creación de recursos.
Provisionamiento: Provisión inicial en curso
Actualización: Actualización en curso
Eliminación: Eliminación en curso

Enumeraciones

AzureClouds

Un enum para describir los entornos de Azure Cloud.

KnownActionType

Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas.

KnownCreatedByType

Tipo de entidad que creó el recurso.

KnownDomainGroupState

El estado de evaluación de un grupo de dominios.

KnownOrigin

El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema"

KnownProvisioningState

Estado de la operación actual.

KnownVersions

Valores conocidos de KnownVersions que acepta el servicio.

Funciones

isRestError(unknown)

Typeguard para RestError

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

Variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

Detalles de la función

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e

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

Crea un sondeo a partir del estado serializado de otro sondeo. Esto puede ser útil cuando desea crear sondeos en un host diferente o un sondeo debe construirse después de que el original no esté en el ámbito.

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

Parámetros

serializedState

string

sourceOperation

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

Devoluciones

PollerLike<OperationState<TResult>, TResult>

Detalles de variables

RestError

Tipo de error personalizado para solicitudes de canalización con error.

RestError: RestErrorConstructor

Tipo