A Bicep hatókörfüggvényei
Ez a cikk a Hatókörértékek lekéréséhez használható Bicep-függvényeket ismerteti.
managementGroup
managementGroup()
Egy objektumot ad vissza, amely a felügyeleti csoport tulajdonságaival rendelkezik az aktuális üzemelő példányban.
managementGroup(identifier)
A hatókör felügyeleti csoportra való beállításához használt objektumot ad vissza.
Névtér: az.
Megjegyzések
managementGroup()
csak felügyeleti csoport üzemelő példányaihoz használható. Az üzembe helyezési művelet aktuális felügyeleti csoportját adja vissza. Hatókörobjektum lekérésekor vagy az aktuális felügyeleti csoport tulajdonságainak lekérésekor használható.
managementGroup(identifier)
bármely üzembehelyezési hatókörhöz használható, de csak a hatókörobjektum lekérésekor. A felügyeleti csoport tulajdonságainak lekéréséhez nem adhatja meg a felügyeleti csoport azonosítóját.
Paraméterek
Paraméter | Kötelező | Típus | Leírás |
---|---|---|---|
Azonosító | Nem | húr | Az üzembe helyezendő felügyeleti csoport egyedi azonosítója. Ne használja a felügyeleti csoport megjelenítendő nevét. Ha nem ad meg értéket, a rendszer visszaadja az aktuális felügyeleti csoportot. |
Visszaadott érték
A tulajdonság modul- vagy bővítményerőforrás-típuson való beállításához scope
használt objektum. Vagy egy objektum, amely az aktuális felügyeleti csoport tulajdonságaival rendelkezik.
Példa felügyeleti csoportra
Az alábbi példa egy modul hatókörét egy felügyeleti csoportra állítja.
param managementGroupIdentifier string
module 'mgModule.bicep' = {
name: 'deployToMG'
scope: managementGroup(managementGroupIdentifier)
}
A következő példa az aktuális felügyeleti csoport tulajdonságait adja vissza.
targetScope = 'managementGroup'
var mgInfo = managementGroup()
output mgResult object = mgInfo
A következőt adja vissza:
"mgResult": {
"type": "Object",
"value": {
"id": "/providers/Microsoft.Management/managementGroups/examplemg1",
"name": "examplemg1",
"properties": {
"details": {
"parent": {
"displayName": "Tenant Root Group",
"id": "/providers/Microsoft.Management/managementGroups/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000"
},
"updatedBy": "00000000-0000-0000-0000-000000000000",
"updatedTime": "2020-07-23T21:05:52.661306Z",
"version": "1"
},
"displayName": "Example MG 1",
"tenantId": "00000000-0000-0000-0000-000000000000"
},
"type": "/providers/Microsoft.Management/managementGroups"
}
}
A következő példa létrehoz egy új felügyeleti csoportot, és ezzel a függvénnyel állítja be a szülő felügyeleti csoportot.
targetScope = 'managementGroup'
param mgName string = 'mg-${uniqueString(newGuid())}'
resource newMG 'Microsoft.Management/managementGroups@2023-04-01' = {
scope: tenant()
name: mgName
properties: {
details: {
parent: {
id: managementGroup().id
}
}
}
}
output newManagementGroup string = mgName
resourceGroup
resourceGroup()
Az aktuális erőforráscsoportot képviselő objektumot ad vissza.
resourceGroup(resourceGroupName)
And
resourceGroup(subscriptionId, resourceGroupName)
A hatókör erőforráscsoportra állításához használt objektumot ad vissza.
Névtér: az.
Megjegyzések
A resourceGroup függvénynek két különböző felhasználási módja van. Az egyik használat a hatókör modul- vagy bővítményerőforrás-típuson való beállítására használható. A másik használat az aktuális erőforráscsoport részleteinek lekérése. A függvény elhelyezése határozza meg a függvény használatát. A tulajdonság beállításakor egy scope
hatókörobjektumot ad vissza.
resourceGroup()
a hatókör beállításához vagy az erőforráscsoport részleteinek lekéréséhez használható.
resourceGroup(resourceGroupName)
és resourceGroup(subscriptionId, resourceGroupName)
csak a hatókör beállításához használható.
Paraméterek
Paraméter | Kötelező | Típus | Leírás |
---|---|---|---|
resourceGroupName | Nem | húr | Annak az erőforráscsoportnak a neve, amelybe üzembe kíván helyezni. Ha nem ad meg értéket, a függvény visszaadja az aktuális erőforráscsoportot. |
subscriptionId | Nem | húr | A központilag üzembe helyezendő előfizetés egyedi azonosítója. Ha nem ad meg értéket, az aktuális előfizetés lesz visszaadva. |
Visszaadott érték
A hatókör beállításakor a függvény egy olyan objektumot ad vissza, amely érvényes egy scope
modul vagy bővítmény erőforrástípus tulajdonságára.
Ha az erőforráscsoport részleteinek lekérésére szolgál, a függvény a következő formátumot adja vissza:
{
"id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}",
"name": "{resourceGroupName}",
"type":"Microsoft.Resources/resourceGroups",
"location": "{resourceGroupLocation}",
"managedBy": "{identifier-of-managing-resource}",
"tags": {
},
"properties": {
"provisioningState": "{status}"
}
}
A managedBy tulajdonság csak olyan erőforráscsoportok esetén lesz visszaadva, amelyek egy másik szolgáltatás által felügyelt erőforrásokat tartalmaznak. Felügyelt alkalmazások, Databricks és AKS esetén a tulajdonság értéke a kezelő erőforrás erőforrás-azonosítója.
Példa erőforráscsoportra
Az alábbi példa egy modult egy erőforráscsoportra terjed ki.
param resourceGroupName string
module exampleModule 'rgModule.bicep' = {
name: 'exampleModule'
scope: resourceGroup(resourceGroupName)
}
A következő példa az erőforráscsoport tulajdonságait adja vissza.
output resourceGroupOutput object = resourceGroup()
Egy objektumot ad vissza a következő formátumban:
{
"id": "/subscriptions/{subscription-id}/resourceGroups/examplegroup",
"name": "examplegroup",
"type":"Microsoft.Resources/resourceGroups",
"location": "southcentralus",
"properties": {
"provisioningState": "Succeeded"
}
}
A resourceGroup függvény gyakori használata, ha az erőforrásokat az erőforráscsoporttal azonos helyen hozza létre. Az alábbi példa az erőforráscsoport helyét használja egy alapértelmezett paraméterértékhez.
param location string = resourceGroup().location
A resourceGroup függvénnyel címkéket is alkalmazhat az erőforráscsoportból egy erőforrásra. További információ: Címkék alkalmazása erőforráscsoportból.
előfizetést
subscription()
Az aktuális üzemelő példány előfizetésének adatait adja vissza.
subscription(subscriptionId)
A hatókör előfizetésre való beállításához használt objektumot ad vissza.
Névtér: az.
Megjegyzések
Az előfizetési függvény két különböző felhasználási módból áll. Az egyik használat a hatókör modul- vagy bővítményerőforrás-típuson való beállítására használható. A másik használat az aktuális előfizetés részleteinek lekérése. A függvény elhelyezése határozza meg a függvény használatát. A tulajdonság beállításakor egy scope
hatókörobjektumot ad vissza.
subscription(subscriptionId)
csak a hatókör beállításához használható.
subscription()
a hatókör beállításához vagy az előfizetés részleteinek lekéréséhez használható.
Paraméterek
Paraméter | Kötelező | Típus | Leírás |
---|---|---|---|
subscriptionId | Nem | húr | A központilag üzembe helyezendő előfizetés egyedi azonosítója. Ha nem ad meg értéket, az aktuális előfizetés lesz visszaadva. |
Visszaadott érték
A hatókör beállításakor a függvény egy olyan objektumot ad vissza, amely érvényes egy scope
modul vagy bővítmény erőforrástípus tulajdonságára.
Ha az előfizetés részleteinek lekérésére szolgál, a függvény a következő formátumot adja vissza:
{
"id": "/subscriptions/{subscription-id}",
"subscriptionId": "{subscription-id}",
"tenantId": "{tenant-id}",
"displayName": "{name-of-subscription}"
}
Előfizetési példa
Az alábbi példa egy modulra terjed ki az előfizetésre.
module exampleModule 'subModule.bicep' = {
name: 'deployToSub'
scope: subscription()
}
A következő példa egy előfizetés adatait adja vissza.
output subscriptionOutput object = subscription()
bérlő
tenant()
A hatókör bérlőre való beállításához használt objektumot ad vissza.
Vagy
A felhasználó bérlőjének értékét adja vissza.
Névtér: az.
Megjegyzések
tenant()
bármilyen üzembe helyezési hatókörrel használható. Mindig az aktuális bérlőt adja vissza. Ezzel a függvénnyel beállíthatja egy erőforrás hatókörét, vagy lekérheti az aktuális bérlő tulajdonságait.
Visszaadott érték
A tulajdonság modul- vagy bővítményerőforrás-típuson való beállításához scope
használt objektum. Vagy egy objektum, amely az aktuális bérlő tulajdonságaival rendelkezik.
Bérlői példa
Az alábbi példa egy, a bérlőn üzembe helyezett modult mutat be.
module exampleModule 'tenantModule.bicep' = {
name: 'deployToTenant'
scope: tenant()
}
A következő példa egy bérlő tulajdonságait adja vissza.
var tenantInfo = tenant()
output tenantResult object = tenantInfo
A következőt adja vissza:
"tenantResult": {
"type": "Object",
"value": {
"countryCode": "US",
"displayName": "Contoso",
"id": "/tenants/00000000-0000-0000-0000-000000000000",
"tenantId": "00000000-0000-0000-0000-000000000000"
}
}
Egyes erőforrásokhoz egy tulajdonság bérlőazonosítójának megadására van szükség. A bérlőazonosító paraméterként való átadása helyett lekérheti a bérlői függvénnyel.
resource kv 'Microsoft.KeyVault/vaults@2023-07-01' = {
name: 'examplekeyvault'
location: 'westus'
properties: {
tenantId: tenant().tenantId
...
}
}
Következő lépések
Az üzembehelyezési hatókörökről az alábbiakban olvashat bővebben:
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: