Overzicht van de Terraform AzAPI-provider
De AzAPI-provider is een dunne laag boven op de Azure ARM REST API's. Met de AzAPI-provider kunt u elk Azure-resourcetype beheren met behulp van een API-versie. Deze provider vormt een aanvulling op de AzureRM-provider door het beheer van nieuwe Azure-resources en -eigenschappen in te schakelen (inclusief beperkte preview).
Resources
Om u in staat te stellen alle Azure-resources en -functies te beheren zonder dat er updates nodig zijn, bevat de AzAPI-provider de volgende algemene resources:
Resourcenaam | Beschrijving |
---|---|
azapi_resource | Wordt gebruikt voor het volledig beheren van elke Azure-resource (besturingsvlak) (API) met volledige CRUD. Voorbeeldgebruiksvoorbeelden: Nieuwe preview-service Nieuwe functie toegevoegd aan bestaande service Bestaande functie/service die momenteel niet wordt gedekt |
azapi_update_resource | Wordt gebruikt voor het beheren van resources of delen van resources die geen volledige CRUD hebben Voorbeeldgebruiksvoorbeelden: Nieuwe eigenschappen voor een bestaande service bijwerken Vooraf gemaakte onderliggende resource bijwerken, zoals DNS SOA-record. |
Voorbeelden van resourceconfiguratie
Met het volgende codefragment wordt een resource geconfigureerd die momenteel niet bestaat in de AzureRM-provider:
resource "azapi_resource" "publicip" {
type = "Microsoft.Network/Customipprefixes@2021-03-01"
name = "exfullrange"
parent_id = azurerm_resource_group.example.id
location = "westus2"
body = jsonencode({
properties = {
cidr = "10.0.0.0/24"
signedMessage = "Sample Message for WAN"
}
})
}
Met het volgende codefragment wordt een preview-eigenschap geconfigureerd voor een bestaande resource vanuit AzureRM:
resource "azapi_update_resource" "test" {
type = "Microsoft.ContainerRegistry/registries@2020-11-01-preview"
resource_id = azurerm_container_registry.acr.id
body = jsonencode({
properties = {
anonymousPullEnabled = var.bool_anonymous_pull
}
})
}
Verificatie met behulp van de AzAPI-provider
De AzAPI-provider maakt dezelfde verificatiemethoden mogelijk als de AzureRM-provider. Zie Terraform verifiëren bij Azure voor meer informatie over verificatieopties.
Voordelen van het gebruik van de AzAPI-provider
De AzAPI-provider biedt de volgende voordelen:
- Ondersteunt alle Azure-services:
- Persoonlijke preview-services en -functies
- Openbare preview-services en -functies
- Alle API-versies
- Volledige kwaliteit van Terraform-statusbestand
- Eigenschappen en waarden worden opgeslagen in status
- Geen afhankelijkheid van Swagger
- Algemene en consistente Azure-verificatie
Ervaring en levenscyclus van de AzAPI-provider
In deze sectie worden enkele hulpprogramma's beschreven waarmee u de AzAPI-provider kunt gebruiken.
VS Code-extensie en taalserver
De AzAPI VS Code-extensie biedt een uitgebreide ontwerpervaring met de volgende voordelen:
- Intellisense
- Automatisch aanvullen van code
- Hints
- Syntaxisvalidatie
- Snelle informatie
AzAPI2AzureRM-migratiehulpprogramma
De AzureRM-provider biedt de meest geïntegreerde Terraform-ervaring voor het beheren van Azure-resources. Daarom is het aanbevolen gebruik van de AzAPI- en AzureRM-providers als volgt:
- Gebruik de AzAPI-provider terwijl de service of functie in preview is.
- zodra de service officieel is uitgebracht, gebruikt u de AzureRM-provider.
Het hulpprogramma AzAPI2AzureRM is ontworpen om te migreren van de AzAPI-provider naar de AzureRM-provider.
AzAPI2AzureRM is een opensource-hulpprogramma waarmee het proces van het converteren van AzAPI-resources naar AzureRM-resources wordt geautomatiseerd.
AzAPI2AzureRM heeft twee modi: plannen en migreren:
- In het plan worden de AzAPI-resources weergegeven die kunnen worden gemigreerd.
- Migreren migreert de AzAPI-resources naar AzureRM-resources in zowel de HCL-bestanden als de status.
AzAPI2AzureRM zorgt er na de migratie voor dat uw Terraform-configuratie en -status zijn afgestemd op uw werkelijke status. U kunt controleren of de status is bijgewerkt door uit te voeren terraform plan
nadat de migratie is voltooid om te zien dat er niets is gewijzigd.
De AzAPI-provider gebruiken
Voeg de AzAPI-provider toe aan uw Terraform-configuratie.
terraform { required_providers { azapi = { source = "Azure/azapi" } } } provider "azapi" { # More information on the authentication methods supported by # the AzureRM Provider can be found here: # https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs # subscription_id = "..." # client_id = "..." # client_secret = "..." # tenant_id = "..." }
Declareer een of meer AzAPI-resources, zoals wordt weergegeven in de volgende voorbeeldcode:
resource "azapi_resource" "example" { name = "example" parent_id = data.azurerm_machine_learning_workspace.existing.id type = "Microsoft.MachineLearningServices/workspaces/computes@2021-07-01" location = "eastus" body = jsonencode({ properties = { computeType = "ComputeInstance" disableLocalAuth = true properties = { vmSize = "STANDARD_NC6" } } }) }
Volgende stappen
Feedback
https://aka.ms/ContentUserFeedback.
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie:Feedback verzenden en weergeven voor