Übersicht über benutzerdefinierte Azure-Ressourcenanbieter

Artikel
06/01/2023

Benutzerdefinierte Azure-Ressourcenanbieter sind eine Erweiterbarkeitsplattform für Azure. Sie ermöglichen Ihnen, benutzerdefinierte APIs zu definieren, mit denen Sie die standardmäßige Azure-Umgebung erweitern können. In diesem Artikel wird Folgendes beschrieben:

Erstellen und Bereitstellen eines benutzerdefinierten Azure-Ressourcenanbieters
Nutzen eines benutzerdefinierten Azure-Ressourcenanbieters zum Erweitern vorhandener Workflows
Auffinden von Anleitungen und Codebeispielen für den Einstieg

Diagramm: Benutzerdefinierte Azure-Ressourcenanbieter mit Darstellung der Beziehung zwischen Azure Resource Manager, benutzerdefinierten Ressourcenanbietern und Ressourcen

Wichtig

Benutzerdefinierte Ressourcenanbieter sind derzeit als öffentliche Vorschauversion verfügbar. Diese Vorschauversion wird ohne Vereinbarung zum Servicelevel bereitgestellt und ist nicht für Produktionsworkloads vorgesehen. Manche Features werden möglicherweise nicht unterstützt oder sind nur eingeschränkt verwendbar. Weitere Informationen finden Sie unter Zusätzliche Nutzungsbestimmungen für Microsoft Azure-Vorschauen.

Aufgaben benutzerdefinierter Ressourcenanbieter

Es folgen einige Beispiele der Aufgaben benutzerdefinierter Azure-Ressourcenanbieter:

Erweitern der Azure Resource Manager-REST-API mit internen und externen Diensten
Ermöglichen benutzerdefinierter Szenarien, die auf vorhandenen Azure-Workflows basieren
Anpassen der Steuerung und Wirkung von Azure Resource Manager-Vorlagen

Was ist ein benutzerdefinierter Ressourcenanbieter?

Benutzerdefinierte Azure-Ressourcenanbieter werden durch Abschluss eines Vertrags zwischen Azure und einem Endpunkt erstellt. Dieser Vertrag definiert eine Liste neuer Ressourcen und Aktionen mittels einer neuen Ressource, Microsoft.CustomProviders/ResourceProviders. Der benutzerdefinierte Ressourcenanbieter stellt diese neuen APIs anschließend in Azure zur Verfügung. Benutzerdefinierte Azure-Ressourcenanbieter bestehen aus drei Teilen: benutzerdefinierter Ressourcenanbieter, Endpunkte und benutzerdefinierte Ressourcen.

Erstellen benutzerdefinierter Ressourcenanbieter

Benutzerdefinierte Ressourcenanbieter bestehen aus einer Liste von Verträgen zwischen Azure und Endpunkten. In diesen Verträgen wird beschrieben, wie Azure mit ihren Endpunkten interagieren sollte. Die Ressourcenanbieter fungieren als Proxy und leiten Anforderungen und Antworten an und von ihrem angegebenen Endpunkt weiter. Ein Ressourcenanbieter kann zwei Arten von Verträgen angeben: resourceTypes und actions. Diese werden über Endpunktdefinitionen aktiviert. Eine Endpunktdefinition besteht aus drei Feldern: name, routingType und endpoint.

Beispielendpunkt:

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

Eigenschaft	Erforderlich	BESCHREIBUNG
name	Ja	Der Name der Endpunktdefinition. Azure macht diesen Namen über seine API unter „/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/ resourceProviders/{resourceProviderName}/{endpointDefinitionName}“ verfügbar.
routingType	Nein	Bestimmt den Typ des Vertrags mit Endpunkt. Falls nicht angegeben, wird standardmäßig „Proxy“ verwendet.
endpoint	Ja	Der Endpunkt, an den die Anforderungen geleitet werden. Hiermit werden die Antwort sowie alle Nebenwirkungen der Anforderung verarbeitet.

Erstellen benutzerdefinierter Ressourcen

resourceTypes beschreibt neue benutzerdefinierte Ressourcen, die Azure hinzugefügt werden. Diese machen einfache RESTful CRUD-Methoden verfügbar. Erfahren Sie mehr über das Erstellen benutzerdefinierter Ressourcen.

Beispiel eines benutzerdefinierten Ressourcenanbieters mit resourceTypes:

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

APIs, die Azure für das obige Beispiel hinzugefügt wurden:

HttpMethod	Beispiel-URI	BESCHREIBUNG
PUT	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Der Azure-REST-API-Aufruf zum Erstellen einer neuen Ressource.
Delete	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Der Azure-REST-API-Aufruf zum Löschen einer vorhandenen Ressource.
GET	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview	Der Azure-REST-API-Aufruf zum Abrufen einer vorhandenen Ressource.
GET	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources?api-version=2018-09-01-preview	Der Azure-REST-API-Aufruf zum Abrufen der Liste vorhandener Ressourcen.

Erstellen benutzerdefinierter Aktionen

actions beschreibt neue Aktionen, die Azure hinzugefügt werden. Diese können zusätzlich zum Ressourcenanbieter verfügbar gemacht oder unter resourceType geschachtelt werden. Erfahren Sie mehr über das Erstellen benutzerdefinierter Aktionen.

Beispiel eines benutzerdefinierten Ressourcenanbieters mit actions:

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

APIs, die Azure für das obige Beispiel hinzugefügt wurden:

HttpMethod	Beispiel-URI	BESCHREIBUNG
POST	/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomAction?api-version=2018-09-01-preview	Der Azure-REST-API-Aufruf zum Aktivieren der Aktion.

Wenn Hilfe benötigt wird

Wenn Sie Fragen zur Entwicklung benutzerdefinierter Azure-Ressourcenanbieter haben, stellen Sie sie auf Stack Overflow. Eine ähnliche Frage wurde möglicherweise bereits gestellt und beantwortet, weshalb Sie dies zunächst prüfen sollten, bevor Sie etwas posten. Fügen Sie das Tag azure-custom-providers hinzu, um schnell eine Antwort zu erhalten!

Nächste Schritte

In diesem Artikel haben Sie Grundlegendes über benutzerdefinierte Ressourcenanbieter gelernt. Im nächsten Artikel erstellen Sie einen benutzerdefinierten Ressourcenanbieter.