Sdílet prostřednictvím

Nasazení prostředků pomocí šablon ARM a rozhraní REST API Azure Resource Manageru

  • Článek

Tento článek vysvětluje, jak pomocí rozhraní REST API Azure Resource Manageru s šablonami Azure Resource Manageru (šablony ARM) nasadit prostředky do Azure.

Šablonu můžete buď zahrnout do textu požadavku, nebo vytvořit odkaz na soubor. Při použití souboru to může být místní soubor nebo externí soubor, který je k dispozici prostřednictvím identifikátoru URI. Když je vaše šablona v účtu úložiště, můžete omezit přístup k šabloně a poskytnout token sdíleného přístupového podpisu (SAS) během nasazování.

Požadována oprávnění

Pokud chcete nasadit soubor Bicep nebo šablonu ARM, musíte mít přístup k zápisu pro prostředky, které nasazujete, a přístup ke všem operacím s prostředky typu Microsoft.Resources/deployments. Pokud chcete například nasadit virtuální počítač, potřebujete Microsoft.Compute/virtualMachines/write a Microsoft.Resources/deployments/* oprávnění. Operace citlivostní operace má stejné požadavky na oprávnění.

Seznam rolí a oprávnění najdete v tématu Předdefinované role Azure.

Obor nasazení

Nasazení můžete cílit na skupinu prostředků, předplatné Azure, skupinu pro správu nebo tenanta. V závislosti na rozsahu nasazení použijete různé příkazy.

  • K nasazení do skupiny prostředků použijte nasazení – Vytvořit. Požadavek se odešle na:

    PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2020-10-01

  • K nasazení do předplatného použijte nasazení – Vytvořit v oboru předplatného. Požadavek se odešle na:

    PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2020-10-01

    Další informace o nasazeních na úrovni předplatného najdete v tématu Vytváření skupin prostředků a prostředků na úrovni předplatného.

  • K nasazení do skupiny pro správu použijte nasazení – Vytvořit v oboru skupiny pro správu. Požadavek se odešle na:

    PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2020-10-01

    Další informace o nasazeních na úrovni skupiny pro správu najdete v tématu Vytváření prostředků na úrovni skupiny pro správu.

  • K nasazení do tenanta použijte nasazení – Vytvoření nebo aktualizace v oboru tenanta. Požadavek se odešle na:

    PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2020-10-01

    Další informace o nasazeních na úrovni tenanta najdete v tématu Vytváření prostředků na úrovni tenanta.

Příklady v tomto článku používají nasazení skupin prostředků.

Nasazení pomocí rozhraní REST API

  1. Nastavte běžné parametry a hlavičky, včetně ověřovacích tokenů.

  2. Pokud nasazujete do skupiny prostředků, která neexistuje, vytvořte skupinu prostředků. Zadejte ID předplatného, název nové skupiny prostředků a umístění, které potřebujete pro vaše řešení. Další informace najdete v tématu Vytvoření skupiny prostředků.

    PUT https://management.azure.com/subscriptions/<YourSubscriptionId>/resourcegroups/<YourResourceGroupName>?api-version=2020-06-01

    S textem požadavku, jako je:

    {
 "location": "West US",
 "tags": {
   "tagname1": "tagvalue1"
 }
}

  3. Před nasazením šablony můžete zobrazit náhled změn, které šablona provede ve vašem prostředí. Pomocí operace citlivostní analýza ověřte, že šablona provede očekávané změny. Citlivostní analýza také ověří chyby šablony.

  4. Pokud chcete nasadit šablonu, zadejte ID předplatného, název skupiny prostředků, název nasazení v identifikátoru URI požadavku.

    PUT https://management.azure.com/subscriptions/<YourSubscriptionId>/resourcegroups/<YourResourceGroupName>/providers/Microsoft.Resources/deployments/<YourDeploymentName>?api-version=2020-10-01

    V textu požadavku zadejte odkaz na šablonu a soubor parametrů. Další informace o souboru parametrů najdete v tématu Vytvoření souboru parametrů Resource Manageru.

    Všimněte si, že mode je nastavená na přírůstkovou hodnotu. Pokud chcete spustit úplné nasazení, nastavte mode na Dokončeno. Při použití kompletního režimu buďte opatrní, protože neúmyslně odstraňte prostředky, které nejsou ve vaší šabloně.

    {
 "properties": {
   "templateLink": {
     "uri": "http://mystorageaccount.blob.core.windows.net/templates/template.json",
     "contentVersion": "1.0.0.0"
   },
   "parametersLink": {
     "uri": "http://mystorageaccount.blob.core.windows.net/templates/parameters.json",
     "contentVersion": "1.0.0.0"
   },
   "mode": "Incremental"
 }
}

    Pokud chcete protokolovat obsah odpovědi, obsah požadavku nebo obojí, zahrňte debugSetting do požadavku.

    {
 "properties": {
   "templateLink": {
     "uri": "http://mystorageaccount.blob.core.windows.net/templates/template.json",
     "contentVersion": "1.0.0.0"
   },
   "parametersLink": {
     "uri": "http://mystorageaccount.blob.core.windows.net/templates/parameters.json",
     "contentVersion": "1.0.0.0"
   },
   "mode": "Incremental",
   "debugSetting": {
     "detailLevel": "requestContent, responseContent"
   }
 }
}

    Účet úložiště můžete nastavit tak, aby používal token sdíleného přístupového podpisu (SAS). Další informace naleznete v tématu Delegování přístupu pomocí sdíleného přístupového podpisu.

    Pokud potřebujete zadat citlivou hodnotu pro parametr (například heslo), přidejte tuto hodnotu do trezoru klíčů. Načtěte trezor klíčů během nasazení, jak je znázorněno v předchozím příkladu. Další informace najdete v tématu Použití služby Azure Key Vault k předání hodnoty zabezpečeného parametru během nasazování.

  5. Místo propojení se soubory pro šablonu a parametry je můžete zahrnout do textu požadavku. Následující příklad ukazuje text požadavku s vloženou šablonou a parametrem:

    {
   "properties": {
   "mode": "Incremental",
   "template": {
     "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
     "contentVersion": "1.0.0.0",
     "parameters": {
       "storageAccountType": {
         "type": "string",
         "defaultValue": "Standard_LRS",
         "allowedValues": [
           "Standard_LRS",
           "Standard_GRS",
           "Standard_ZRS",
           "Premium_LRS"
         ],
         "metadata": {
           "description": "Storage Account type"
         }
       },
       "location": {
         "type": "string",
         "defaultValue": "[resourceGroup().location]",
         "metadata": {
           "description": "Location for all resources."
         }
       }
     },
     "variables": {
       "storageAccountName": "[format('{0}standardsa', uniquestring(resourceGroup().id))]"
     },
     "resources": [
       {
         "type": "Microsoft.Storage/storageAccounts",
         "apiVersion": "2022-09-01",
         "name": "[variables('storageAccountName')]",
         "location": "[parameters('location')]",
         "sku": {
           "name": "[parameters('storageAccountType')]"
         },
         "kind": "StorageV2",
         "properties": {}
       }
     ],
     "outputs": {
       "storageAccountName": {
         "type": "string",
         "value": "[variables('storageAccountName')]"
       }
     }
   },
   "parameters": {
     "location": {
       "value": "eastus2"
     }
   }
 }
}

  6. Pokud chcete získat stav nasazení šablony, použijte nasazení – Získat.

    GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2020-10-01

Nasazení s využitím ARMClient

ARMClient je jednoduchý nástroj příkazového řádku pro vyvolání rozhraní API Azure Resource Manageru. Pokud chcete nástroj nainstalovat, přečtěte si téma ARMClient.

Zobrazení seznamu předplatných:

armclient GET /subscriptions?api-version=2021-04-01

Seznam skupin prostředků:

armclient GET /subscriptions/<subscription-id>/resourceGroups?api-version=2021-04-01

Nahraďte <ID> předplatného svým ID předplatného Azure.

Vytvoření skupiny prostředků v oblasti USA – střed:

armclient PUT /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>?api-version=2021-04-01  "{location: 'central us', properties: {}}"

Případně můžete text vložit do souboru JSON s názvem CreateRg.json:

{
  "location": "Central US",
  "properties": { }
}

armclient PUT /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>?api-version=2021-04-01 '@CreateRg.json'

Další informace najdete v tématu ARMClient: nástroj příkazového řádku pro rozhraní Azure API.

Název nasazení

Nasazení můžete pojmenovat, například ExampleDeployment.

Při každém spuštění nasazení se položka přidá do historie nasazení skupiny prostředků s názvem nasazení. Pokud spustíte jiné nasazení a dáte mu stejný název, nahradí se předchozí položka aktuálním nasazením. Pokud chcete zachovat jedinečné položky v historii nasazení, dejte každému nasazení jedinečný název.

Pokud chcete vytvořit jedinečný název, můžete přiřadit náhodné číslo. Nebo přidejte hodnotu data.

Pokud spustíte souběžná nasazení do stejné skupiny prostředků se stejným názvem nasazení, dokončí se pouze poslední nasazení. Všechna nasazení se stejným názvem, který se nedokončil, se nahradí posledním nasazením. Pokud například spustíte nasazení s názvem newStorage , které nasadí účet úložiště s názvem storage1, a současně spustíte jiné nasazení, které nasadí účet úložiště s názvem newStorage storage2, nasadíte pouze jeden účet úložiště. Výsledný účet úložiště má název storage2.

Pokud však spustíte nasazení s názvem newStorage , které nasadí účet úložiště s názvem storage1, a hned po jeho dokončení spustíte jiné nasazení, které nasadí účet úložiště s názvem newStorage storage2, pak máte dva účty úložiště. Jeden má název storage1a druhý má název storage2. V historii nasazení ale máte jenom jednu položku.

Když pro každé nasazení zadáte jedinečný název, můžete je spustit souběžně bez konfliktu. Pokud spustíte nasazení s názvem newStorage1 , které nasadí účet úložiště s názvem storage1, a současně spustíte jiné nasazení, které nasadí účet úložiště s názvem newStorage2 storage2, budete mít dva účty úložiště a dvě položky v historii nasazení.

Aby nedocházelo ke konfliktům se souběžnými nasazeními a k zajištění jedinečných položek v historii nasazení, dejte každému nasazení jedinečný název.

Další kroky