使用 REST API 管理 Azure 資源

  • 發行項

了解如何將 REST API 用於 Azure Resource Manager，以管理您的 Azure 資源。 如需如何建構 Azure REST 呼叫的完整參考，請參閱開始使用 REST。 如需可用作業的詳細資訊，請檢視資源管理 REST API 參考。

取得存取權杖

若要對 Azure 進行 REST API 呼叫，您必須先取得存取權杖。 使用 "Authorization" 標頭，並將值設定為 "Bearer {access-token}"，藉以將此存取權杖包含在 Azure REST API 呼叫的標頭中。

如果您需要以程式設計方式擷取新權杖作為應用程式的一部分，您可以使用 Microsoft Entra ID 註冊用戶端應用程式以取得存取權杖。

如果您剛入門，而想要使用個別權杖來測試 Azure REST API，您可以使用 Azure PowerShell 或 Azure CLI 快速擷取目前的存取權杖。

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

作業範圍

您可以在不同的範圍呼叫許多 Azure Resource Manager 作業：

類型 範圍
管理群組 providers/Microsoft.Management/managementGroups/{managementGroupId}
訂用帳戶 subscriptions/{subscriptionId}
資源群組 subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}
資源 subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderName}/{resourceType}/{resourceName}

列出資源

下列 REST 作業會傳回提供的資源群組內的資源。

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

以下是可讓您使用 Azure Resource Manager API 列出資源群組中所有資源的範例 cURL 命令：

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'

使用驗證步驟時，此範例會顯示如下：

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'

將資源部署至現有的資源群組

您可以使用 REST API 直接部署 Azure 資源，或部署 Resource Manager 範本以建立 Azure 資源。

部署資源

下列 REST 作業會建立儲存體帳戶。 若要更詳細地查看此範例，請參閱使用 REST API 建立 Azure 儲存體帳戶。 儲存體資源提供者的完整參考文件和範例可在儲存體資源提供者 REST API 參考中取得。

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

部署範本

下列作業會建立部署快速入門範本，以建立儲存體帳戶。 如需詳細資訊，請參閱快速入門：使用 Visual Studio Code 建立 Azure Resource Manager 範本。 有關此呼叫的 API 參考，請參閱部署 - 建立或更新。

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

對於 REST API，uri 的值不可以是本機檔案，或只能在區域網路上使用的檔案。 Azure Resource Manager 必須能夠存取範本。 提供可下載為 HTTP 或 HTTPS 的 URI 值。 如需詳細資訊，請參閱使用 Resource Manager 範本與 Azure PowerShell 來部署資源。

部署資源群組與資源

您可以使用範本建立資源群組，並將資源部署至群組。 如需詳細資訊，請參閱建立資源群組並部署資源。

將資源部署至多個訂用帳戶或資源群組

一般而言，您要將範本中的所有資源部署至單一資源群組。 不過，在某些情況下，您要將一組資源部署在一起，但將它們放在不同的資源群組或訂用帳戶中。 如需詳細資訊，請參閱將 Azure 資源部署至多個訂用帳戶或資源群組。

刪除資源

下列作業說明如何刪除儲存體帳戶。

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

如需 Azure Resource Manager 如何決定資源刪除順序的詳細資訊，請參閱 Azure Resource Manager 資源群組刪除。

管理對資源的存取

Azure 角色型存取控制 (Azure RBAC) 是在 Azure 中管理資源存取權的方式。 如需詳細資訊，請參閱使用 REST 新增或移除 Azure 角色指派。

下一步