Azure-resources beheren met behulp van de REST API

  • Artikel

Meer informatie over het gebruik van de REST API voor Azure Resource Manager om uw Azure-resources te beheren. Zie Aan de slag met REST voor uitgebreide naslaginformatie over het structuren van Azure REST-aanroepen. Bekijk de naslaginformatie over de REST API van Resource Management voor meer informatie over de beschikbare bewerkingen.

Een toegangstoken opvragen

Als u een REST API-aanroep naar Azure wilt maken, moet u eerst een toegangstoken verkrijgen. Neem dit toegangstoken op in de headers van uw Azure REST API-aanroepen met behulp van de header Autorisatie en stel de waarde in op Bearer {access-token}.

Als u nieuwe tokens programmatisch wilt ophalen als onderdeel van uw toepassing, kunt u een toegangstoken verkrijgen door uw clienttoepassing te registreren bij Microsoft Entra ID.

Als u aan de slag gaat en Azure REST API's wilt testen met behulp van uw afzonderlijke token, kunt u uw huidige toegangstoken snel ophalen met Azure PowerShell of Azure CLI.

token=$(az account get-access-token --query accessToken --output tsv)

Bewerkingsbereik

U kunt veel Azure Resource Manager-bewerkingen aanroepen op verschillende bereiken:

Type Bereik
Beheergroep providers/Microsoft.Management/managementGroups/{managementGroupId}
Abonnement subscriptions/{subscriptionId}
Resourcegroep subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
Resource subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

Resources weergeven

Met de volgende REST-bewerking worden de resources binnen een opgegeven resourcegroep geretourneerd.

GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Hier volgt een voorbeeld van een cURL-opdracht die u kunt gebruiken om alle resources in een resourcegroep weer te geven met behulp van de Azure Resource Manager-API:

curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Met de verificatiestap ziet dit voorbeeld er als volgt uit:

token=$(az account get-access-token --query accessToken --output tsv)
curl  -H "Authorization: Bearer $token" -H 'Content-Type: application/json' -X GET 'https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources?api-version=2021-04-01'

Resources implementeren in een bestaande resourcegroep

U kunt Azure-resources rechtstreeks implementeren met behulp van de REST API of een Resource Manager-sjabloon implementeren om Azure-resources te maken.

Een resource implementeren

Met de volgende REST-bewerking wordt een opslagaccount gemaakt. Zie Een Azure Storage-account maken met de REST API voor meer informatie over dit voorbeeld. Volledige referentiedocumentatie en voorbeelden voor de opslagresourceprovider zijn beschikbaar in de REST API-verwijzing voor opslagresourceproviders.

PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2018-02-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "sku": {
    "name": "Standard_GRS"
  },
  "kind": "StorageV2",
  "location": "eastus2",
}

Een sjabloon implementeren

Met de volgende bewerkingen wordt een quickstart-sjabloon geïmplementeerd om een opslagaccount te maken. Zie quickstart: Azure Resource Manager-sjablonen maken met behulp van Visual Studio Code voor meer informatie. Zie Implementaties - Maken of bijwerken voor de API-verwijzing van deze aanroep.

PUT /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/my-deployment?api-version=2021-04-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Content-Type: application/json
Host: management.azure.com

{
  "properties": {
    "templateLink": {
      "uri": "https://example.com/azuretemplates/azuredeploy.json"
    },
    "parametersLink": {
        "uri": "https://example.com/azuretemplates/azuredeploy.parameters.json"
    },
    "mode": "Incremental"
  }
}

Voor de REST API's kan de waarde uri geen lokaal bestand zijn of een bestand dat alleen beschikbaar is in uw lokale netwerk. Azure Resource Manager moet toegang hebben tot de sjabloon. Geef een URI-waarde op die kan worden gedownload als HTTP of HTTPS. Raadpleeg voor meer informatie Resources implementeren met Resource Manager-sjablonen en Azure PowerShell.

Een resourcegroep en resources implementeren

U kunt een resourcegroep maken en resources implementeren in de groep met behulp van een sjabloon. Zie Resourcegroep maken en resources implementeren voor meer informatie.

Resources implementeren in meerdere abonnementen of resourcegroepen

Normaal gesproken implementeert u alle resources in uw sjabloon in één resourcegroep. Er zijn echter scenario's waarin u een set resources samen wilt implementeren, maar deze in verschillende resourcegroepen of abonnementen wilt plaatsen. Zie Azure-resources implementeren in meerdere abonnementen of resourcegroepen voor meer informatie.

Resources verwijderen

De volgende bewerking laat zien hoe u een opslagaccount verwijdert.

DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2022-09-01 HTTP/1.1
Authorization: Bearer <bearer-token>
Host: management.azure.com

Zie Azure Resource Manager-resourcegroepverwijdering voor meer informatie over hoe Azure Resource Manager het verwijderen van resources bestelt.

Toegang tot resources beheren

Op rollen gebaseerd toegangsbeheer van Azure (Azure RBAC) is de manier waarop u de toegang tot resources in Azure beheert. Zie Azure-roltoewijzingen toevoegen of verwijderen met REST voor meer informatie.

Volgende stappen