Classes CAPI dans les Serveur MID includes de script
Mise en service et gouvernance du cloud fournit plusieurs classes JavaScript qui effectuent des appels REST vers les fournisseurs dans le cloud. Ces classes sont appelées à partir d’includes de Serveur MID script (pour Azure par défaut) ou d’appels Java dans le système (pour AWS par défaut). Si vous créez des fournisseurs, des interfaces ou des API CAPI personnalisés (pour n’importe quel fournisseur dans le cloud), vous pouvez utiliser Serveur MID des includes de script pour appeler les classes.
Afficher les classes CAPI en accédant à dans l’interface de l’instance système de base (et non dans l’interface ).Portail d'administration du cloud Vous recherchez le nom d’une classe dans la zone de recherche Go to search (Accéder à la recherche) à l’aide de la colonne Name (Nom ) :
Classes de base
Ces classes de base sont disponibles par défaut. Ils constituent la base des classes Azure et AWS qui effectuent les appels REST réels.
- CloudAPIBase
CloudAPIBase est une API indépendante du fournisseur qui communique avec tous les types d’API dans le cloud. Il fournit des fonctions de débogage et de journalisation de base, ainsi que de collecte d’informations de proxy sur le Serveur MID fichier . Il définit également les en-têtes, les paramètres, les points de terminaison et
this.parameter.- AWSCloudAPIBase
- Cette classe est étendue à partir de CloudAPIBase et fournit des fonctions qui appellent l’appelant pour effectuer des demandes GET, PUT, POST et DELETE. La classe offre la possibilité d’exécuter une méthode
executeAction, qui est une implémentation AWS de GET, ou la méthode invoke, qui fournit des appels d’API REST. - AzureCloudAPIBase
Cette classe est étendue à partir de CloudAPIBase et fournit des fonctions qui effectuent ces actions :
- Extraire les ID de ressources.
- Extraire les propriétés du point de terminaison.
- Répertorier les ressources.
- Appelez l’appelant pour effectuer des demandes GET, PUT, POST et DELETE.
AzureCloudAPIBase utilise la méthode _invokeRequest pour effectuer des appels d’API REST à Azure à l’aide des appels d’API REST standard.
Classes de demandeur
Les classes Invoker effectuent les appels REST réels vers le fournisseur dans le cloud. Si vous créez une interface et une API CAPI personnalisées, vous devez CloudRestAPIInvoker étendre pour créer vos appels REST.
- CloudRestAPIInvoker
Cette classe est une classe abstraite permettant d’effectuer des appels d’API REST. S’il existe des en-têtes et/ou des paramètres à envoyer avec une requête, les classes qui implémentent l’appelant doivent étendre cet objet. Ils doivent également fournir des remplacements pour getEndpointUrl pour renvoyer le point de terminaison ciblé, et pour getHeaders et getParameters. Par exemple, avec les API REST Azure, l’authentification nécessite la transmission d’un jeton comme en-tête. L’extension qui l’implémente doit fournir une réponse à partir de getHeaders qui effectue la création ou la récupération du jeton et la définit. Cet objet de base invoque getHeaders et renvoie tout ce qu’il reçoit avec la demande. Cette classe fournit également une getResponse méthode pour gérer la réponse du fournisseur dans le cloud.
Si vous créez une API CAPI personnalisée, vous devez l’étendre CloudRestAPIInvoker pour effectuer des appels REST vers le fournisseur dans le cloud.
- AmazonWebServicesAPIInvoker
- Cette classe est une extension de CloudRestAPIInvoker et fournit des méthodes pour effectuer des appels d’API REST au fournisseur dans le cloud.
- AzureAPIInvoker
- Cette classe est étendue de et fournit des CloudRestAPIInvoker fonctions qui effectuent ces appels d’API REST à Azure Resource Manager :
- Définit le principal de service, les en-têtes et les paramètres des appels REST.
- Obtient l’URL du point de terminaison, le jeton (ID client, ID de locataire et clé secrète) et les en-têtes/paramètres.
- Récupère et décode le corps de la réponse JSON à partir du fournisseur dans le cloud.
- AzureEAAPIInvoker
- Cette classe retourne le jeton d’accès à l’API REST Azure Enterprise Agreement (EA).
- AzureStorageAPIInvoker
- Cette classe effectue des appels REST pour le stockage Azure. Les fonctions de cette classe peuvent obtenir le jeton, la réponse, les en-têtes et les paramètres.
Ce graphique illustre comment ces classes de base sont utilisées pour étendre les classes spécifiques à AWS et à Azure :
Exceptions
- RESTAPIException
- Cette classe de base gère les exceptions qui peuvent se produire pendant l’appel REST. Renvoie le code de réponse du fournisseur dans le cloud.
- AWSAPIException
- Cette classe gère les exceptions qui peuvent se produire pendant l’appel REST.
- AzureAPIException
- Cette classe lève une exception d’exécution en cas de besoin lors de l’invocation d’API Azure.
Classes pour les informations d’identification
- CloudRESTRequestSigningUtil
Cette classe utilise les remplacements spécifiés dans les remplacements de configuration d’API CAPI. La AmazonWebServicesRequestSigner classe étend cette classe. Pour Azure, de nombreux signataires sont intégrés dans les includes de Serveur MID script pour les mappeurs de méthode dans les API CAPI Azure.
- AmazonWebServicesRequestSigner
- Cette classe configure une session sécurisée pour l’appel d’API REST en prenant des informations sur une demande et en créant une chaîne signée v4 pour la demande. Cette classe est étendue à partir de CloudRESTRequestSigningUtil.
Autres classes Azure
| Classe | Description |
|---|---|
| AzureAlertRule | Classe permettant de créer et de supprimer des règles d’alerte Azure. |
| AzureAuthorizationPolicy | Classe pour affecter des stratégies de balise. |
| AzureComputeAvailabilitySet | Classe permettant d’extraire des ensembles de disponibilités Azure. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/compute/availabilitysets |
| AzureComputeHardware | Classe permettant d’extraire les tailles Azure. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/compute/virtualmachinesizes |
| AzureComputeImage | Classe permettant de gérer les appels d’API Azure par rapport à l’image. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/manageddisks/images/images-rest-api |
| AzureComputeVirtualMachine | Classe permettant de gérer les appels d’API Azure sur les ordinateurs virtuels. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/compute/virtualmachines Taille et capacités de l’ordinateur virtuel : versions prises en charge par Cloud-Init https://docs.microsoft.com/en-us/azure/virtual-machines/virtual-machines-windows-sizes https://docs.microsoft.com/en-us/azure/virtual-machines/virtual-machines-linux-sizes : https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init |
| Déploiement Azure | Classe permettant de gérer le déploiement du modèle ARM Azure. |
| AzureDeploymentOperation | Classe pour gérer l’opération de déploiement du modèle ARM Azure. |
| Images Azure | Classe pour gérer les images Azure. |
| AzureLoadBalancer | Classe permettant de gérer les appels d’API Azure par rapport aux équilibreurs de charge. Reportez-vous à : https://msdn.microsoft.com/en-us/library/azure/mt163651.aspx |
| AzureLocalNetworkGateways | Classe permettant de créer et de récupérer des passerelles de réseau local. |
| AzureNetworkNIC | Classe permettant de gérer les appels d’API Azure par rapport aux cartes d’interface réseau. Reportez-vous à : https://msdn.microsoft.com/en-us/library/azure/mt163579.aspx |
| AzureNetworkPublicIP | Classe permettant de gérer les appels d’API Azure par rapport aux adresses IP publiques. Reportez-vous à : https://msdn.microsoft.com/en-us/library/azure/mt163638.aspx |
| AzureNetworkRouter | Classe permettant de gérer les appels d’API Azure par rapport à la table d’itinéraires. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/network/route-tables |
| AzureNetworkSecurityGroup | Classe permettant de gérer les appels d’API Azure par rapport aux cartes d’interface réseau. Reportez-vous à : https://msdn.microsoft.com/en-us/library/azure/mt163579.aspx |
| AzureNetworkVirtualNetwork | Classe permettant de gérer les appels d’API Azure sur les réseaux virtuels. |
| Fournisseur Azure | Classe permettant d’obtenir les détails du fournisseur Azure, tels que l’URL et la version du fournisseur. |
| AzureRegion | Classe permettant d’extraire les régions Azure. |
| Ressource AzureResource | Gère l’objet référencé par ObjectID dans les paramètres. Il récupère également la version de l’API. Cette classe est principalement destinée à obtenir des types non pris en charge ou à supprimer des ressources. |
| AzureResourceGroupManager | Classe pour gérer les groupes de ressources ARM Azure. |
| AzureResponseUtil | Classe pour traduire la réponse de l’API Azure en objet DTO. |
| AzureStorageAccount | Classe permettant de gérer les appels d’API Azure par rapport au compte de stockage. Reportez-vous à : //https://msdn.microsoft.com/en-us/library/azure/mt163638.aspx |
| AzureStorageBlob | Classe permettant de créer et de manipuler des conteneurs de stockage et des blobs. |
| AzureStorageManagedDisk | Classe pour gérer les appels d’API Azure sur le disque géré. Reportez-vous à : https://docs.microsoft.com/en-us/rest/api/manageddisks/disks/disks-create-or-update |
| Abonnement Azure | Classe permettant d’extraire les abonnements Azure. |
| AzureVirtualNetworkGateways | Classe permettant de créer et de manipuler des passerelles de réseau virtuel. |
| AzureCloudEAAPIBase | Objet de base pour les gestionnaires d’API Azure EA. Les API Azure EA ont une URL de base de https://consumption.azure.com et nécessitent le numéro d’inscription dans le chemin d’accès. Cette classe gère le marshalling des paramètres EnrollmentNumber et EnrollmentToken. |
Autres classes AWS
| Classe | Description |
|---|---|
| AmazonImages | Classe pour gérer les images d’ordinateur Amazon. http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html |
| AmazonResponseProcessorUtil | Classe pour gérer la réponse API REST AWS. |
| AWSAutoScalingGroups | Classe pour gérer les appels d’API AWS pour créer et manipuler des groupes de mise à l’échelle automatique. |
| AWSCloudFormation | Gestionnaire d’appels d’API AWS CloudFormation. |
| AWSEC2 | Gestionnaire d’appels d’API AWS EC2. |
| AWSKeyValuePair | Classe permettant d’importer et de manipuler des paires de clés. |
| AWSLaunchConfigurations | Classe d’assistance. |
| AWSS3 | Gestionnaire pour les appels d’API AWS S3. |
| AWSTopics | Cours avec rubriques AWS. |