Üzembehelyezési függvények ARM-sablonokhoz

  • Cikk

Resource Manager az alábbi függvényeket biztosítja az Azure Resource Manager-sablon (ARM-sablon) aktuális üzembe helyezéséhez kapcsolódó értékek lekéréséhez:

Az erőforrásokból, erőforráscsoportokból vagy előfizetésekből származó értékek lekéréséhez lásd: Erőforrásfüggvények.

Tipp

Azért javasoljuk a Bicep használatát, mert ugyanazokkal a képességekkel rendelkezik, mint az ARM-sablonok, és a szintaxis használata egyszerűbb. További információ: Üzembehelyezési függvények.

üzembe helyezés

deployment()

Az aktuális üzembe helyezési művelettel kapcsolatos információkat adja vissza.

A Bicepben használja az üzembe helyezési függvényt.

Visszatérési érték

Ez a függvény az üzembe helyezés során átadott objektumot adja vissza. A visszaadott objektum tulajdonságai a következőktől függően különböznek:

  • sablon vagy sablonspecifikáció üzembe helyezése.
  • egy helyi fájlból származó sablon üzembe helyezése, vagy egy URI-on keresztül elért távoli fájlból származó sablon üzembe helyezése.
  • üzembe helyezés egy erőforráscsoportban, vagy üzembe helyezés egy másik hatókörben (Azure-előfizetés, felügyeleti csoport vagy bérlő).

Ha helyi sablont helyez üzembe egy erőforráscsoportban: a függvény a következő formátumot adja vissza:

{
  "name": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

Ha távoli sablont helyez üzembe egy erőforráscsoportban: a függvény a következő formátumot adja vissza:

{
  "name": "",
  "properties": {
    "templateLink": {
      "uri": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

Amikor sablonspecifikációt helyez üzembe egy erőforráscsoportban: a függvény a következő formátumot adja vissza:

{
  "name": "",
  "properties": {
    "templateLink": {
      "id": ""
    },
    "template": {
      "$schema": "",
      "contentVersion": "",
      "parameters": {},
      "variables": {},
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

Amikor üzembe helyez egy Azure-előfizetést, felügyeleti csoportot vagy bérlőt, a return objektum egy tulajdonságot location is tartalmaz. A helytulajdonság helyi vagy külső sablon üzembe helyezésekor is szerepel. A formátum a következő:

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "$schema": "",
      "contentVersion": "",
      "resources": [],
      "outputs": {}
    },
    "templateHash": "",
    "parameters": {},
    "mode": "",
    "provisioningState": ""
  }
}

LanguageVersion 2.0-sablon üzembe helyezésekor a függvény a deployment tulajdonságok korlátozott részhalmazát adja vissza:

{
  "name": "",
  "location": "",
  "properties": {
    "template": {
      "contentVersion": ""
    },
    "templateLink": {
      "id": "",
      "uri": ""
    }
  }
}

Megjegyzések

A szülősablon deployment() URI-ja alapján hivatkozhat egy másik sablonra.

"variables": {
  "sharedTemplateUrl": "[uri(deployment().properties.templateLink.uri, 'shared-resources.json')]"
}

Ha újra üzembe helyez egy sablont a portál üzembe helyezési előzményeiből, a sablon helyi fájlként lesz üzembe helyezve. A templateLink tulajdonság nem lesz visszaadva az üzembe helyezési függvényben. Ha a sablon egy másik sablonra mutató hivatkozás létrehozására templateLink támaszkodik, ne használja újra a portált. Ehelyett használja a sablon eredeti üzembe helyezéséhez használt parancsokat.

Példa

Az alábbi példa egy üzembehelyezési objektumot ad vissza.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "deploymentOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

Az előző példa a következő objektumot adja vissza:

{
  "name": "deployment",
  "properties": {
    "template": {
      "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
      "contentVersion": "1.0.0.0",
      "resources": [],
      "outputs": {
        "deploymentOutput": {
          "type": "Object",
          "value": "[deployment()]"
        }
      }
    },
    "templateHash": "13135986259522608210",
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted"
  }
}

Egy előfizetés üzembe helyezése esetén az alábbi példa egy üzembehelyezési objektumot ad vissza.

{
  "$schema": "https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {},
  "resources": [],
  "outputs": {
    "exampleOutput": {
      "type": "object",
      "value": "[deployment()]"
    }
  }
}

környezet

environment()

Az üzembe helyezéshez használt Azure-környezettel kapcsolatos információkat adja vissza.

A Bicepben használja a környezeti függvényt.

Megjegyzések

A fiókjához tartozó regisztrált környezetek listájának megtekintéséhez használja az az cloud list vagya Get-AzEnvironment parancsot.

Visszatérési érték

Ez a függvény az aktuális Azure-környezet tulajdonságait adja vissza. Az alábbi példa a globális Azure tulajdonságait mutatja be. A szuverén felhők némileg eltérő tulajdonságokat adhatnak vissza.

{
  "name": "",
  "gallery": "",
  "graph": "",
  "portal": "",
  "graphAudience": "",
  "activeDirectoryDataLake": "",
  "batch": "",
  "media": "",
  "sqlManagement": "",
  "vmImageAliasDoc": "",
  "resourceManager": "",
  "authentication": {
    "loginEndpoint": "",
    "audiences": [
      "",
      ""
    ],
    "tenant": "",
    "identityProvider": ""
  },
  "suffixes": {
    "acrLoginServer": "",
    "azureDatalakeAnalyticsCatalogAndJob": "",
    "azureDatalakeStoreFileSystem": "",
    "azureFrontDoorEndpointSuffix": "",
    "keyvaultDns": "",
    "sqlServerHostname": "",
    "storage": ""
  }
}

Példa

Az alábbi példasablon a környezeti objektumot adja vissza.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "resources": [],
  "outputs": {
    "environmentOutput": {
      "type": "object",
      "value": "[environment()]"
    }
  }
}

Az előző példa a következő objektumot adja vissza a globális Azure-ban való üzembe helyezéskor:

{
  "name": "AzureCloud",
  "gallery": "https://gallery.azure.com/",
  "graph": "https://graph.windows.net/",
  "portal": "https://portal.azure.com",
  "graphAudience": "https://graph.windows.net/",
  "activeDirectoryDataLake": "https://datalake.azure.net/",
  "batch": "https://batch.core.windows.net/",
  "media": "https://rest.media.azure.net",
  "sqlManagement": "https://management.core.windows.net:8443/",
  "vmImageAliasDoc": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/arm-compute/quickstart-templates/aliases.json",
  "resourceManager": "https://management.azure.com/",
  "authentication": {
    "loginEndpoint": "https://login.microsoftonline.com/",
    "audiences": [
      "https://management.core.windows.net/",
      "https://management.azure.com/"
    ],
    "tenant": "common",
    "identityProvider": "AAD"
  },
  "suffixes": {
    "acrLoginServer": ".azurecr.io",
    "azureDatalakeAnalyticsCatalogAndJob": "azuredatalakeanalytics.net",
    "azureDatalakeStoreFileSystem": "azuredatalakestore.net",
    "azureFrontDoorEndpointSuffix": "azurefd.net",
    "keyvaultDns": ".vault.azure.net",
    "sqlServerHostname": ".database.windows.net",
    "storage": "core.windows.net"
  }
}

parameters

parameters(parameterName)

Paraméterértéket ad vissza. A megadott paraméternevet a sablon paraméterek szakaszában kell definiálni.

A Bicepben közvetlenül hivatkozzon a paraméterekre a szimbolikus nevük használatával.

Paraméterek

Paraméter Kötelező Típus Description
parameterName Yes sztring A visszaadandó paraméter neve.

Visszatérési érték

A megadott paraméter értéke.

Megjegyzések

Általában paramétereket használ az erőforrásértékek beállításához. Az alábbi példa a webhely nevét az üzembe helyezés során átadott paraméterértékre állítja.

"parameters": {
  "siteName": {
    "type": "string"
  }
}, "resources": [
  {
    "type": "Microsoft.Web/Sites",
    "apiVersion": "2016-08-01",
    "name": "[parameters('siteName')]",
    ...
  }
]

Példa

Az alábbi példa a paraméterfüggvény egyszerűsített használatát mutatja be.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "stringParameter": {
      "type": "string",
      "defaultValue": "option 1"
    },
    "intParameter": {
      "type": "int",
      "defaultValue": 1
    },
    "objectParameter": {
      "type": "object",
      "defaultValue": {
        "one": "a",
        "two": "b"
      }
    },
    "arrayParameter": {
      "type": "array",
      "defaultValue": [ 1, 2, 3 ]
    },
    "crossParameter": {
      "type": "string",
      "defaultValue": "[parameters('stringParameter')]"
    }
  },
  "variables": {},
  "resources": [],
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "[parameters('stringParameter')]"
    },
    "intOutput": {
      "type": "int",
      "value": "[parameters('intParameter')]"
    },
    "objectOutput": {
      "type": "object",
      "value": "[parameters('objectParameter')]"
    },
    "arrayOutput": {
      "type": "array",
      "value": "[parameters('arrayParameter')]"
    },
    "crossOutput": {
      "type": "string",
      "value": "[parameters('crossParameter')]"
    }
  }
}

Az előző példában szereplő kimenet az alapértelmezett értékekkel a következő:

Név Típus Érték
stringOutput Sztring 1. lehetőség
intOutput Int 1
objectOutput Objektum {"one": "a", "two": "b"}
arrayOutput Tömb [1, 2, 3]
crossOutput Sztring 1. lehetőség

További információ a paraméterek használatáról: Paraméterek ARM-sablonokban.

Változók

variables(variableName)

A változó értékét adja eredményül. A megadott változó nevét a sablon változók szakaszában kell definiálni.

A Bicepben közvetlenül hivatkozzon a változókra a szimbolikus nevük használatával.

Paraméterek

Paraméter Kötelező Típus Description
variableName Igen Sztring A visszaadni kívánt változó neve.

Visszatérési érték

A megadott változó értéke.

Megjegyzések

Általában változók használatával egyszerűsítheti a sablont, ha csak egyszer hoz létre összetett értékeket. Az alábbi példa egy tárfiók egyedi nevét hozza létre.

"variables": {
  "storageName": "[concat('storage', uniqueString(resourceGroup().id))]"
},
"resources": [
  {
    "type": "Microsoft.Storage/storageAccounts",
    "name": "[variables('storageName')]",
    ...
  },
  {
    "type": "Microsoft.Compute/virtualMachines",
    "dependsOn": [
      "[variables('storageName')]"
    ],
    ...
  }
],

Példa

Az alábbi példa különböző változóértékeket ad vissza.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {},
  "variables": {
    "var1": "myVariable",
    "var2": [ 1, 2, 3, 4 ],
    "var3": "[ variables('var1') ]",
    "var4": {
      "property1": "value1",
      "property2": "value2"
    }
  },
  "resources": [],
  "outputs": {
    "exampleOutput1": {
      "type": "string",
      "value": "[variables('var1')]"
    },
    "exampleOutput2": {
      "type": "array",
      "value": "[variables('var2')]"
    },
    "exampleOutput3": {
      "type": "string",
      "value": "[variables('var3')]"
    },
    "exampleOutput4": {
      "type": "object",
      "value": "[variables('var4')]"
    }
  }
}

Az előző példa kimenete az alapértelmezett értékekkel:

Név Típus Érték
exampleOutput1 Sztring myVariable
exampleOutput2 Tömb [1, 2, 3, 4]
exampleOutput3 Sztring myVariable
exampleOutput4 Objektum {"property1": "value1", "property2": "value2"}

További információ a változók használatáról: Változók ARM-sablonban.

Következő lépések