Présentation des fournisseurs de ressources personnalisés Azure

Article
06/01/2023

Les fournisseurs de ressources personnalisés Azure constituent une plateforme d’extensibilité à Azure. Cette dernière vous permet de définir des API personnalisées qui peuvent être utilisées pour enrichir l’expérience Azure par défaut. Cette documentation décrit :

Comment créer et déployer un fournisseur de ressources personnalisé Azure.
Comment utiliser des fournisseurs de ressources personnalisés Azure pour étendre les workflows existants.
Où trouver des guides et exemples de code pour commencer.

Diagramme des fournisseurs de ressources personnalisées Azure, affichant la relation entre Azure Resource Manager, les fournisseurs de ressources personnalisées et les ressources.

Important

Les fournisseurs de ressources personnalisés sont actuellement disponibles en préversion publique. Cette préversion est fournie sans contrat de niveau de service et n’est pas recommandée pour les charges de travail de production. Certaines fonctionnalités peuvent être limitées ou non prises en charge. Pour plus d’informations, consultez Conditions d’Utilisation Supplémentaires relatives aux Évaluations Microsoft Azure.

Utilité des fournisseurs de ressources personnalisés

Voici quelques exemples de ce que vous pouvez faire avec les fournisseurs de ressources personnalisés Azure :

Étendre les API REST Azure Resource Manager pour inclure des services internes et externes.
Activer des scénarios personnalisés sur des workflows Azure existants.
Personnaliser le contrôle et l’effet des modèles Azure Resource Manager.

Présentation d’un fournisseur de ressources personnalisé

Les fournisseurs de ressources personnalisés Azure sont mis en place en créant un contrat entre Azure et un point de terminaison. Ce contrat définit une liste des nouvelles ressources et actions via une nouvelle ressource, Microsoft.CustomProviders/resourceProviders. Le fournisseur de ressources personnalisé expose ensuite ces nouvelles API dans Azure. Les fournisseurs de ressources personnalisés Azure sont composés de 3 parties : le fournisseur de ressources personnalisé, les points de terminaison et les ressources personnalisées.

Guide pratique pour créer des fournisseurs de ressources personnalisés Azure

Les fournisseurs de ressources personnalisés sont une liste de contrats entre Azure et des points de terminaison. Ces contrats décrivent comment Azure doit interagir avec ses points de terminaison. Le fournisseur de ressources agit comme un proxy et transfère les requêtes et les réponses vers et à partir du point de terminaison spécifié. Un fournisseur de ressources peut spécifier 2 types de contrat : resourceTypes et actions. Ceux-ci sont activés par le biais des définitions de point de terminaison. Une définition de point de terminaison se compose de 3 champs : name, routingType et endpoint.

Exemple de point de terminaison :

{
  "name": "{endpointDefinitionName}",
  "routingType": "Proxy",
  "endpoint": "https://{endpointURL}/"
}

Propriété	Obligatoire	Description
name	Oui	Nom de la définition de point de terminaison. Azure expose ce nom via son API sous « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/ resourceProviders/{resourceProviderName}/{endpointDefinitionName} »
routingType	non	Détermine le type de contrat avec le point de terminaison. En l’absence de spécification, « Proxy » est spécifié par défaut.
endpoint	Oui	Point de terminaison vers lequel router les requêtes. Il gère la réponse, ainsi que tous les effets secondaires de la requête.

Création de ressources personnalisées

ResourceTypes décrit les nouvelles ressources personnalisées qui sont ajoutées à Azure. Celles-ci exposent des méthodes CRUD RESTful de base. Consultez d’autres informations sur la création de ressources personnalisées.

Exemple de fournisseur de ressources personnalisé avec resourceTypes :

{
  "properties": {
    "resourceTypes": [
      {
        "name": "myCustomResources",
        "routingType": "Proxy",
        "endpoint": "https://{endpointURL}/"
      }
    ]
  },
  "location": "eastus"
}

API ajoutées à Azure pour l’exemple ci-dessus :

HttpMethod	URI d’exemple	Description
PUT	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Appel d’API REST Azure pour créer une ressource.
Suppression	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Appel d’API REST Azure pour supprimer une ressource existante.
GET	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Appel d’API REST Azure pour récupérer une ressource existante.
GET	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources?api-version=2018-09-01-preview	Appel d’API REST Azure pour récupérer la liste des ressources existantes.

Création d’actions personnalisées

Les actions décrivent les nouvelles actions ajoutées à Azure. Celles-ci peuvent être exposées sur le fournisseur de ressources ou imbriquées sous un resourceType. Consultez d’autres informations sur la création d’actions personnalisées.

Exemple de fournisseur de ressources personnalisé avec actions :

{
  "properties": {
    "actions": [
      {
        "name": "myCustomAction",
        "routingType": "Proxy",
        "endpoint": "https://{endpointURL}/"
      }
    ]
  },
  "location": "eastus"
}

API ajoutées à Azure pour l’exemple ci-dessus :

HttpMethod	URI d’exemple	Description
POST	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomAction?api-version=2018-09-01-preview	Appel d’API REST Azure pour activer l’action.

Besoin d’aide

Si vous avez des questions sur le développement de fournisseurs de ressources personnalisés Azure, postez-les sur Stack Overflow. Avant de la publier, vérifiez si votre réponse a déjà été posée et a déjà reçu une réponse. Ajoutez le mot clé azure-custom-providers pour obtenir une réponse rapide !

Étapes suivantes

Dans cet article, vous avez découvert les fournisseurs de ressources personnalisés. Passez à l’article suivant pour créer un fournisseur de ressources personnalisé.