Overzicht van aangepaste Azure-resourceproviders
Azure Custom Resource Providers is een uitbreidbaar platform naar Azure. Hiermee kunt u aangepaste API's definiëren die kunnen worden gebruikt om de standaard Azure-ervaring te verrijken. In deze documentatie wordt het volgende beschreven:
- Een aangepaste Azure-resourceprovider bouwen en implementeren.
- Aangepaste resourceproviders van Azure gebruiken om bestaande werkstromen uit te breiden.
- Waar u handleidingen en codevoorbeelden kunt vinden om aan de slag te gaan.
Belangrijk
Aangepaste resourceproviders is momenteel in openbare preview. Deze preview-versie wordt aangeboden zonder service level agreement en wordt niet aanbevolen voor productieworkloads. Misschien worden bepaalde functies niet ondersteund of zijn de mogelijkheden ervan beperkt. Zie Supplemental Terms of Use for Microsoft Azure Previews (Aanvullende gebruiksvoorwaarden voor Microsoft Azure-previews) voor meer informatie.
Wat kunnen aangepaste resourceproviders doen
Hier volgen enkele voorbeelden van wat u kunt bereiken met Azure Custom Resource Providers:
- Azure Resource Manager REST API uitbreiden met interne en externe services.
- Schakel aangepaste scenario's in op bestaande Azure-werkstromen.
- Beheer en effect van Azure Resource Manager-sjablonen aanpassen.
Wat is een aangepaste resourceprovider?
Aangepaste Azure-resourceproviders worden gemaakt door een contract tussen Azure en een eindpunt te maken. Dit contract definieert een lijst met nieuwe resources en acties via een nieuwe resource, Microsoft.CustomProviders/resourceProviders. De aangepaste resourceprovider maakt deze nieuwe API's vervolgens beschikbaar in Azure. Aangepaste Azure-resourceproviders bestaan uit drie delen: aangepaste resourceprovider, eindpunten en aangepaste resources.
Aangepaste resourceproviders bouwen
Aangepaste resourceproviders zijn een lijst met contracten tussen Azure en eindpunten. In deze contracten wordt beschreven hoe Azure moet communiceren met hun eindpunten. De resourceproviders fungeren als een proxy en sturen aanvragen en antwoorden door naar en van het opgegeven eindpunt. Een resourceprovider kan twee typen contracten opgeven: resourceTypes en acties. Deze worden ingeschakeld via eindpuntdefinities. Een eindpuntdefinitie bestaat uit drie velden: name, routingType en eindpunt.
Voorbeeldeindpunt:
{
"name": "{endpointDefinitionName}",
"routingType": "Proxy",
"endpoint": "https://{endpointURL}/"
}
| Eigenschap | Vereist | Beschrijving |
|---|---|---|
| naam | Ja | De naam van de eindpuntdefinitie. Azure maakt deze naam beschikbaar via de API onder '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/ resourceProviders/{resourceProviderName}/{endpointDefinitionName}' |
| routingType | No | Bepaalt het contracttype met het eindpunt. Als dit niet is opgegeven, wordt de standaardwaarde 'Proxy' gebruikt. |
| endpoint | Ja | Het eindpunt waarnaar de aanvragen worden gerouteerd. Hiermee worden het antwoord en eventuele neveneffecten van de aanvraag verwerkt. |
Aangepaste resources bouwen
ResourceTypes beschrijven nieuwe aangepaste resources die worden toegevoegd aan Azure. Deze maken eenvoudige RESTful CRUD-methoden beschikbaar. Meer informatie over het maken van aangepaste resources
Voorbeeld van aangepaste resourceprovider met resourceTypes:
{
"properties": {
"resourceTypes": [
{
"name": "myCustomResources",
"routingType": "Proxy",
"endpoint": "https://{endpointURL}/"
}
]
},
"location": "eastus"
}
API's die zijn toegevoegd aan Azure voor het bovenstaande voorbeeld:
| HttpMethod | Voorbeeld-URI | Description |
|---|---|---|
| PUT | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview |
De Azure REST API-aanroep om een nieuwe resource te maken. |
| DELETE | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview |
De Azure REST API-aanroep om een bestaande resource te verwijderen. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources/{customResourceName}?api-version=2018-09-01-preview |
De Azure REST API-aanroep om een bestaande resource op te halen. |
| GET | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomResources?api-version=2018-09-01-preview |
De Azure REST API-aanroep om de lijst met bestaande resources op te halen. |
Aangepaste acties bouwen
Acties beschrijven nieuwe acties die worden toegevoegd aan Azure. Deze kunnen boven op de resourceprovider worden weergegeven of worden genest onder een resourceType. Meer informatie over het maken van aangepaste acties
Voorbeeld van aangepaste resourceprovider met acties:
{
"properties": {
"actions": [
{
"name": "myCustomAction",
"routingType": "Proxy",
"endpoint": "https://{endpointURL}/"
}
]
},
"location": "eastus"
}
API's die zijn toegevoegd aan Azure voor het bovenstaande voorbeeld:
| HttpMethod | Voorbeeld-URI | Description |
|---|---|---|
| POST | /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/ myCustomAction?api-version=2018-09-01-preview |
De Azure REST API-aanroep om de actie te activeren. |
Hulp nodig?
Als u vragen hebt over de ontwikkeling van aangepaste Azure-resourceproviders, kunt u deze vragen stellen op Stack Overflow. Misschien is er een soortgelijke vraag gesteld en beantwoord, dus controleer dit eerst vóór u een vraag stelt. Voeg de tag azure-custom-providers toe om snel antwoord te krijgen.
Volgende stappen
In dit artikel hebt u meer geleerd over aangepaste resourceproviders. Ga naar het volgende artikel om een aangepaste resourceprovider te maken.