Fájlfüggvények a Bicep-hez
Ez a cikk a Külső fájlokból származó tartalmak betöltéséhez használható Bicep-függvényeket ismerteti.
loadFileAsBase64
loadFileAsBase64(filePath)
Betölti a fájlt base64-sztringként.
Névtér: sys.
Paraméterek
| Paraméter | Kötelező | Típus | Leírás |
|---|---|---|---|
| filePath | Igen | húr | A betöltendő fájl elérési útja. Az elérési út az üzembe helyezett Bicep-fájlhoz képest van. Nem tartalmazhat változókat. |
Megjegyzések
Ezt a függvényt akkor használja, ha olyan bináris tartalommal rendelkezik, amelyet fel szeretne venni az üzembe helyezésbe. Ahelyett, hogy manuálisan kódolása a fájlt egy base64-sztringre, és hozzáadja a Bicep-fájlhoz, töltse be a fájlt ezzel a függvénnyel. A fájl betöltődik, amikor a Bicep-fájlt JSON-sablonra fordítják. Nem használhat változókat a fájl elérési útjában, mert nem oldották fel őket a sablon összeállításakor. Az üzembe helyezés során a JSON-sablon a fájl tartalmát rögzített sztringként tartalmazza.
Ehhez a függvényhez a Bicep CLI 0.4.X-es vagy újabb verziója szükséges.
A fájl maximális mérete 96 Kb.
Visszaadott érték
A fájl base64-sztringként.
loadJsonContent
loadJsonContent(filePath, [jsonPath], [encoding])
Betölti a megadott JSON-fájlt bármely objektumként.
Névtér: sys.
Paraméterek
| Paraméter | Kötelező | Típus | Leírás |
|---|---|---|---|
| filePath | Igen | húr | A betöltendő fájl elérési útja. Az elérési út az üzembe helyezett Bicep-fájlhoz képest van. Nem tartalmazhat változókat. |
| jsonPath | Nem | húr | JSONPath-kifejezés, amely megadja, hogy a fájlnak csak egy része legyen betöltve. |
| Kódolás | Nem | húr | A fájlkódolás. Az alapértelmezett érték utf-8. Az elérhető lehetőségek a következők: iso-8859-1, us-ascii, utf-16, utf-16BEvagy utf-8. |
Megjegyzések
Ezt a függvényt akkor használja, ha egy külön fájlban tárolt JSON-tartalommal vagy minified JSON-tartalommal rendelkezik. A Bicep-fájl JSON-tartalmának duplikálása helyett töltse be a tartalmat ezzel a függvénnyel. A JSON-fájlok egy részét egy JSON-elérési út megadásával töltheti be. A fájl betöltése a Bicep-fájl JSON-sablonba történő fordításakor történik. Nem vehet fel változókat a fájl elérési útjára, mert nem oldották fel őket a sablon összeállításakor. Az üzembe helyezés során a JSON-sablon a fájl tartalmát rögzített sztringként tartalmazza.
A VS Code-ban a betöltött objektum tulajdonságai elérhetők intellienseként. Létrehozhat például egy olyan fájlt, amely számos Bicep-fájlban megosztható értékekkel. Ebben a cikkben egy példa látható.
Ehhez a függvényhez a Bicep CLI 0.7.X-es vagy újabb verziója szükséges.
A fájl maximális megengedett mérete 1 048 576 karakter, beleértve a sorvégződéseket is.
Visszaadott érték
A fájl tartalma bármely objektumként.
Példák
Az alábbi példa létrehoz egy JSON-fájlt, amely egy hálózati biztonsági csoport értékeit tartalmazza.
{
"description": "Allows SSH traffic",
"protocol": "Tcp",
"sourcePortRange": "*",
"destinationPortRange": "22",
"sourceAddressPrefix": "*",
"destinationAddressPrefix": "*",
"access": "Allow",
"priority": 100,
"direction": "Inbound"
}
Betöltheti a fájlt, és JSON-objektummá alakíthatja. Az objektummal értékeket rendelhet az erőforráshoz.
param location string = resourceGroup().location
var nsgconfig = loadJsonContent('nsg-security-rules.json')
resource newNSG 'Microsoft.Network/networkSecurityGroups@2021-02-01' = {
name: 'example-nsg'
location: location
properties: {
securityRules: [
{
name: 'SSH'
properties: nsgconfig
}
]
}
}
A hálózati biztonsági csoportot üzembe helyező más Bicep-fájlokban lévő értékek fájlját újra felhasználhatja.
loadYamlContent
loadYamlContent(filePath, [pathFilter], [encoding])
Betölti a megadott YAML-fájlt bármely objektumként.
Névtér: sys.
Paraméterek
| Paraméter | Kötelező | Típus | Leírás |
|---|---|---|---|
| filePath | Igen | húr | A betöltendő fájl elérési útja. Az elérési út az üzembe helyezett Bicep-fájlhoz képest van. Nem tartalmazhat változókat. |
| pathFilter | Nem | húr | Az elérésiút-szűrő egy JSONPath-kifejezés, amely azt határozza meg, hogy a fájlnak csak egy része legyen betöltve. |
| Kódolás | Nem | húr | A fájlkódolás. Az alapértelmezett érték utf-8. Az elérhető lehetőségek a következők: iso-8859-1, us-ascii, utf-16, utf-16BEvagy utf-8. |
Megjegyzések
Ezt a függvényt akkor használja, ha egy külön fájlban tárolt YAML-tartalommal vagy minimálisra módosított YAML-tartalommal rendelkezik. AHELYETT, hogy duplikálja a YAML-tartalmat a Bicep-fájlban, töltse be a tartalmat ezzel a függvénnyel. A YAML-fájlok egy részét egy elérésiút-szűrő megadásával töltheti be. A fájl betöltődik, amikor a Bicep-fájlt a YAML-sablonra fordítják. Nem vehet fel változókat a fájl elérési útjára, mert nem oldották fel őket a sablon összeállításakor. Az üzembe helyezés során a YAML-sablon a fájl tartalmát rögzített sztringként tartalmazza.
A VS Code-ban a betöltött objektum tulajdonságai elérhetők intellienseként. Létrehozhat például egy olyan fájlt, amely számos Bicep-fájlban megosztható értékekkel. Ebben a cikkben egy példa látható.
Ehhez a függvényhez a Bicep CLI 0.16.X-es vagy újabb verziója szükséges.
A fájl maximális megengedett mérete 1 048 576 karakter, beleértve a sorvégződéseket is.
Visszaadott érték
A fájl tartalma bármely objektumként.
Példák
Az alábbi példa létrehoz egy YAML-fájlt, amely egy hálózati biztonsági csoport értékeit tartalmazza.
description: "Allows SSH traffic"
protocol: "Tcp"
sourcePortRange: "*"
destinationPortRange: "22"
sourceAddressPrefix: "*"
destinationAddressPrefix: "*"
access: "Allow"
priority: 100
direction: "Inbound"
Betöltheti a fájlt, és JSON-objektummá alakíthatja. Az objektummal értékeket rendelhet az erőforráshoz.
param location string = resourceGroup().location
var nsgconfig = loadYamlContent('nsg-security-rules.yaml')
resource newNSG 'Microsoft.Network/networkSecurityGroups@2021-02-01' = {
name: 'example-nsg'
location: location
properties: {
securityRules: [
{
name: 'SSH'
properties: nsgconfig
}
]
}
}
A hálózati biztonsági csoportot üzembe helyező más Bicep-fájlokban lévő értékek fájlját újra felhasználhatja.
loadTextContent
loadTextContent(filePath, [encoding])
A megadott fájl tartalmát sztringként tölti be.
Névtér: sys.
Paraméterek
| Paraméter | Kötelező | Típus | Leírás |
|---|---|---|---|
| filePath | Igen | húr | A betöltendő fájl elérési útja. Az elérési út az üzembe helyezett Bicep-fájlhoz képest van. Nem tartalmazhat változókat. |
| Kódolás | Nem | húr | A fájlkódolás. Az alapértelmezett érték utf-8. Az elérhető lehetőségek a következők: iso-8859-1, us-ascii, utf-16, utf-16BEvagy utf-8. |
Megjegyzések
Ezt a függvényt akkor használja, ha egy külön fájlban tárolt tartalommal rendelkezik. A tartalmat aHelyett, hogy duplikálja a Bicep-fájlba, betöltheti. Betölthet például egy üzembehelyezési szkriptet egy fájlból. A fájl betöltése a Bicep-fájl JSON-sablonba történő fordításakor történik. A fájl elérési útjában nem szerepelhetnek változók, mert nem oldották fel őket a sablon összeállításakor. Az üzembe helyezés során a JSON-sablon a fájl tartalmát rögzített sztringként tartalmazza.
A függvény használatával loadJsonContent() töltse be a JSON-fájlokat.
Ehhez a függvényhez a Bicep CLI 0.4.X-es vagy újabb verziója szükséges.
A fájl maximális megengedett mérete 131 072 karakter, beleértve a sorvégződéseket is.
Visszaadott érték
A fájl tartalma sztringként.
Példák
Az alábbi példa betölt egy szkriptet egy fájlból, és üzembehelyezési szkripthez használja.
resource exampleScript 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
name: 'exampleScript'
location: resourceGroup().location
kind: 'AzurePowerShell'
identity: {
type: 'UserAssigned'
userAssignedIdentities: {
'/subscriptions/{sub-id}/resourcegroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{id-name}': {}
}
}
properties: {
azPowerShellVersion: '8.3'
scriptContent: loadTextContent('myscript.ps1')
retentionInterval: 'P1D'
}
}
Következő lépések
- A Bicep-fájlok szakaszainak leírását a Bicep-fájlok szerkezetének és szintaxisának ismertetése című témakörben találja.