Dela via

Hantera Azure-resurser med hjälp av REST-API:et

  • Artikel

Lär dig hur du använder REST-API:et för Azure Resource Manager för att hantera dina Azure-resurser. En omfattande referens för hur du strukturerar Azure REST-anrop finns i Komma igång med REST. Mer information om tillgängliga åtgärder finns i REST API-referensen för Resource Management.

Hämta en åtkomsttoken

Om du vill göra ett REST API-anrop till Azure måste du först skaffa en åtkomsttoken. Inkludera den här åtkomsttoken i rubrikerna i dina Azure REST API-anrop med rubriken "Authorization" och ange värdet till "Bearer {access-token}".

Om du behöver hämta nya token programmatiskt som en del av ditt program kan du hämta en åtkomsttoken genom att registrera klientprogrammet med Microsoft Entra-ID.

Om du kommer igång och vill testa Azure REST API:er med din enskilda token kan du snabbt hämta din aktuella åtkomsttoken med antingen Azure PowerShell eller Azure CLI.

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

Åtgärdsomfång

Du kan anropa många Azure Resource Manager-åtgärder i olika omfång:

Typ Omfattning
Hanteringsgrupp providers/Microsoft.Management/managementGroups/{managementGroupId}
Prenumeration subscriptions/{subscriptionId}
Resursgrupp subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
Resurs subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

Lista resurser

Följande REST-åtgärd returnerar resurserna i en angivet resursgrupp.

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

Här är ett exempel på ett cURL-kommando som du kan använda för att lista alla resurser i en resursgrupp med hjälp av Azure Resource Manager-API:et:

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'

Med autentiseringssteget ser det här exemplet ut så här:

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'

Distribuera resurser till en befintlig resursgrupp

Du kan distribuera Azure-resurser direkt med hjälp av REST-API:et eller distribuera en Resource Manager-mall för att skapa Azure-resurser.

Distribuera en resurs

Följande REST-åtgärd skapar ett lagringskonto. Mer information om det här exemplet finns i Skapa ett Azure Storage-konto med REST-API:et. Fullständig referensdokumentation och exempel för lagringsresursprovidern finns i REST API-referensen för lagringsresursprovidern.

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

Distribuera en mall

Följande åtgärder distribuerar en snabbstartsmall för att skapa ett lagringskonto. Mer information finns i Snabbstart: Skapa Azure Resource Manager-mallar med hjälp av Visual Studio Code. API-referensen för det här anropet finns i Distributioner – Skapa eller uppdatera.

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

För REST-API:er kan värdet uri för inte vara en lokal fil eller en fil som bara är tillgänglig i det lokala nätverket. Azure Resource Manager måste kunna komma åt mallen. Ange ett URI-värde som kan laddas ned som HTTP eller HTTPS. Mer information finns i Distribuera resurser med Resource Manager-mallar och Azure PowerShell.

Distribuera en resursgrupp och resurser

Du kan skapa en resursgrupp och distribuera resurser till gruppen med hjälp av en mall. Mer information finns i Skapa resursgrupp och distribuera resurser.

Distribuera resurser till flera prenumerationer eller resursgrupper

Normalt distribuerar du alla resurser i mallen till en enda resursgrupp. Det finns dock scenarier där du vill distribuera en uppsättning resurser tillsammans men placera dem i olika resursgrupper eller prenumerationer. Mer information finns i Distribuera Azure-resurser till flera prenumerationer eller resursgrupper.

Ta bort resurser

Följande åtgärd visar hur du tar bort ett lagringskonto.

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

Mer information om hur Azure Resource Manager beställer borttagning av resurser finns i borttagning av Azure Resource Manager-resursgrupp.

Hantera åtkomst till resurser

Rollbaserad åtkomstkontroll i Azure (Azure RBAC) är det sätt som du hanterar åtkomst till resurser i Azure. Mer information finns i Lägga till eller ta bort Azure-rolltilldelningar med HJÄLP av REST.

Nästa steg