Verwalten von Azure-Ressourcen mithilfe der REST-API

  • Artikel

Erfahren Sie, wie Sie mit der REST-API für Azure Resource Manager und Ihre Azure-Ressourcen verwalten. Eine umfassende Referenz zum Strukturieren von Azure REST-Aufrufen finden Sie unter Erste Schritte mit REST. Weitere Informationen zu den verfügbaren Vorgängen finden Sie in der REST-API-Referenz zur Ressourcenverwaltung.

Abrufen eines Zugriffstokens

Um einen REST-API-Aufruf von Azure zu tätigen, müssen Sie zunächst ein Zugriffstoken abrufen. Fügen Sie dieses Zugriffstoken in die Header Ihrer Azure-REST-API-Aufrufe ein, indem Sie den Header „Autorisierung“ verwenden und den Wert auf „Bearer {access-token}“ festlegen.

Wenn Sie neue Token programmgesteuert als Teil Ihrer Anwendung abrufen müssen, können Sie ein Zugriffstoken abrufen, indem Sie Ihre Clientanwendung bei Microsoft Entra ID registrieren.

Wenn Sie neu sind und Azure-REST-APIs mit Ihrem individuellen Token testen möchten, können Sie Ihr aktuelles Zugriffstoken schnell mit Azure PowerShell oder der Azure CLI abrufen.

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

Vorgangsbereich

Sie können viele Azure Resource Manager-Vorgänge in verschiedenen Bereichen aufrufen:

type `Scope`
Verwaltungsgruppe providers/Microsoft.Management/managementGroups/{managementGroupId}
Subscription subscriptions/{subscriptionId}
Resource group subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
Resource subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

Ressourcen auflisten

Der folgende REST-Vorgang gibt die Ressourcen innerhalb einer bereitgestellten Ressourcengruppe zurück.

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

Hier sehen Sie ein Beispiel cURL-Befehl, mit dem Sie alle Ressourcen in einer Ressourcengruppe mithilfe der Azure Resource Manager-API auflisten können:

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'

Im Authentifizierungsschritt sieht dieses Beispiel wie folgt aus:

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'

Bereitstellen von Ressourcen in einer vorhandenen Ressourcengruppe

Sie können Azure-Ressourcen direkt mithilfe der REST-API bereitstellen oder eine Resource Manager-Vorlage zum Erstellen von Azure-Ressourcen bereitstellen.

Bereitstellen einer Ressource

Der folgende REST-Vorgang erstellt ein Speicherkonto. Ausführlichere Informationen zu diesem Beispiel finden Sie unter Erstellen eines Azure Storage-Kontos mit der REST-API. Eine vollständige Referenzdokumentation und Beispiele für den Speicherressourcenanbieter finden Sie in der Rest-API-Referenz zum Speicherressourcenanbieter.

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",
}

Bereitstellen einer Vorlage

Die folgenden Vorgänge stellen eine Schnellstartvorlage zum Erstellen eines Speicherkontos bereit. Weitere Informationen finden Sie unter Quickstart: Erstellen von Azure Resource Manager-Vorlagen mit Visual Studio Code. Die API-Referenz zu diesem Aufruf finden Sie unter Bereitstellungen – Erstellen oder Aktualisieren.

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"
  }
}

Bei einer REST-API darf der Wert von uri weder eine lokale Datei noch eine Datei sein, die nur in Ihrem lokalen Netzwerk verfügbar ist. Azure Resource Manager muss auf die Vorlage zugreifen können. Geben Sie einen URI-Wert an, der als HTTP- oder HTTPS-Wert heruntergeladen werden kann. Weitere Informationen hierzu finden Sie unter Bereitstellen von Ressourcen mit Azure Resource Manager-Vorlagen und Azure PowerShell.

Bereitstellen einer Ressourcengruppe und von Ressourcen

Mithilfe einer Vorlage können Sie eine Ressourcengruppe erstellen und Ressourcen in der Ressourcengruppe bereitstellen. Weitere Informationen finden Sie unter Erstellen einer Ressourcengruppe und Bereitstellen von Ressourcen.

Bereitstellen von Ressourcen für mehrere Abonnements oder Ressourcengruppen

In der Regel stellen Sie alle Ressourcen in der Vorlage als einzelne Ressourcengruppe bereit. Es gibt jedoch Szenarien, bei denen Sie eine Reihe von Ressourcen zwar gemeinsam, aber in verschiedenen Ressourcengruppen oder Abonnements bereitstellen möchten. Weitere Informationen finden Sie unter Bereitstellen von Azure-Ressourcen für mehrere Abonnements oder Ressourcengruppen.

Löschen von Ressourcen

Der folgende Vorgang zeigt, wie ein Speicherkonto gelöscht wird.

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

Weitere Informationen dazu, in welcher Reihenfolge Ressourcenlöschungen in Azure Resource Manager durchgeführt werden, finden Sie unter Azure Resource Manager: Löschvorgang von Ressourcengruppen.

Zugriff auf Ressourcen verwalten

Der Zugriff auf Ressourcen in Azure wird mithilfe der rollenbasierten Zugriffssteuerung in Azure (Azure RBAC) verwaltet. Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von Azure-Rollenzuweisungen mit REST.

Nächste Schritte