@azure/arm-programenrollment package
Classes
| ProgramEnrollmentClient |
Interfaces
| DomainGroup |
Un groupe de domaines edu délimités par un locataire Entra. |
| EduEnrollment |
Un programme d’inscription éducatif regroupant les domaines Entra sous un seul champ d’application souverain/édu. |
| EduEnrollmentPatch |
Le type utilisé pour les opérations de mise à jour de l’EduEnrollment. |
| EduEnrollmentProperties |
Détails du programme EduInscription. |
| EduEnrollmentsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| EduEnrollmentsDeleteOptionalParams |
Paramètres facultatifs. |
| EduEnrollmentsGetOptionalParams |
Paramètres facultatifs. |
| EduEnrollmentsListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| EduEnrollmentsListBySubscriptionOptionalParams |
Paramètres facultatifs. |
| EduEnrollmentsOperations |
Interface représentant une opération EduEnrollments. |
| EduEnrollmentsUpdateOptionalParams |
Paramètres facultatifs. |
| ErrorAdditionalInfo |
Informations supplémentaires sur l’erreur de gestion des ressources. |
| ErrorDetail |
Détail de l’erreur. |
| ErrorResponse |
Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. |
| Operation |
Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources |
| OperationDisplay |
Informations d’affichage localisées pour une opération. |
| OperationsListOptionalParams |
Paramètres facultatifs. |
| OperationsOperations |
Interface représentant des opérations. |
| PageSettings |
Options de la méthode byPage |
| PagedAsyncIterableIterator |
Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page. |
| ProgramEnrollmentClientOptionalParams |
Paramètres facultatifs pour le client. |
| Resource |
Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager |
| RestorePollerOptions | |
| SystemData |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
| TrackedResource |
Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement » |
Alias de type
| ActionType |
Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement. Valeurs connues prises en charge par le serviceinterne : les actions sont destinées aux API internes uniquement. |
| AzureSupportedClouds |
Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne |
| ContinuablePage |
Interface qui décrit une page de résultats. |
| CreatedByType |
Type d’entité qui a créé la ressource. Valeurs connues prises en charge par le service
'utilisateur: l’entité a été créée par un utilisateur. |
| DomainGroupState |
L’état d’évaluation d’un groupe de domaines. Valeurs connues prises en charge par le service
En attente : L’évaluation est en attente. |
| Origin |
Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système » Valeurs connues prises en charge par le service
'utilisateur: indique que l’opération est lancée par un utilisateur. |
| ProvisioningState |
État de l’opération actuelle. Valeurs connues prises en charge par le service
réussi: la ressource a été créée. |
Énumérations
| AzureClouds |
Un enum pour décrire les environnements Azure Cloud. |
| KnownActionType |
Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement. |
| KnownCreatedByType |
Type d’entité qui a créé la ressource. |
| KnownDomainGroupState |
L’état d’évaluation d’un groupe de domaines. |
| KnownOrigin |
Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système » |
| KnownProvisioningState |
État de l’opération actuelle. |
| KnownVersions |
Valeurs connues de KnownVersions que le service accepte. |
Functions
| is |
Typeguard pour RestError |
| restore |
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue. |
Variables
| Rest |
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué. |
Informations relatives à la fonction
isRestError(unknown)
Typeguard pour RestError
function isRestError(e: unknown): e
Paramètres
- e
-
unknown
Quelque chose d’intercepté par une clause catch.
Retours
e
restorePoller<TResponse, TResult>(ProgramEnrollmentClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.
function restorePoller<TResponse, TResult>(client: ProgramEnrollmentClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Paramètres
- client
- ProgramEnrollmentClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retours
PollerLike<OperationState<TResult>, TResult>
Détails de variable
RestError
Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.
RestError: RestErrorConstructor