Funkce nasazení pro Bicep

Tento článek popisuje funkce Bicep pro získání hodnot souvisejících s aktuálním nasazením.

Nasazovač

deployer()

Vrátí informace o objektu zabezpečení (identitě), který inicioval aktuální nasazení. Instanční objekt může být uživatel, instanční objekt nebo spravovaná identita v závislosti na tom, jak bylo nasazení spuštěno.

Obor názvů: az.

Vrácená hodnota

Tato funkce vrátí objekt s podrobnostmi o objektu zabezpečení nasazení, včetně:

• objectId: ID objektu Microsoft Entra ID objektu objektu zabezpečení.
• tenantId: ID tenanta Microsoft Entra ID.
• userPrincipalName: Hlavní název uživatele (UPN), pokud je k dispozici. U instančních objektů nebo spravovaných identit může být tato vlastnost prázdná.

Poznámka:

Vrácené hodnoty závisí na kontextu nasazení. Například userPrincipalName může být prázdný pro instanční objekty nebo spravované identity.

{
  "objectId": "<principal-object-id>",
  "tenantId": "<tenant-id>",
  "userPrincipalName": "<user@domain.com or empty>"
}

Příklad

Následující příklad souboru Bicep vrátí objekt deployeru.

output deployer object = deployer()

Ukázkový výstup (hodnoty se liší v závislosti na vašem nasazení):

{
  "objectId":"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "tenantId":"aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
  "userPrincipalName":"john.doe@contoso.com"
}

Další informace o identitách Azure najdete v tématu Co je identita Azure Active Directory?

nasazení

deployment()

Vrátí informace o aktuální operaci nasazení.

Obor názvů: az.

Vrácená hodnota

Tato funkce vrátí objekt, který se předává během nasazení. Vlastnosti vráceného objektu se liší podle toho, jestli jste:

• nasazení místního souboru Bicep
• nasazení do skupiny prostředků nebo nasazení do jednoho z dalších oborů (předplatné Azure, skupina pro správu nebo tenant).

Při nasazování místního souboru Bicep do skupiny prostředků vrátí funkce následující formát:

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

Když nasadíte do předplatného Azure, skupiny pro správu nebo tenanta, návratový objekt obsahuje location vlastnost. Vlastnost location není zahrnuta při nasazování místního souboru Bicep. Formát je následující:

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

Příklad

Následující příklad vrátí objekt nasazení:

output deploymentOutput object = deployment()

Předchozí příklad vrátí následující objekt:

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

prostředí

environment()

Vrátí informace o prostředí Azure použitém k nasazení. Funkce environment() neví o konfiguracích prostředků. Může vrátit pouze jednu výchozí příponu DNS pro každý typ prostředku.

Obor názvů: az.

Poznámky

Pokud chcete zobrazit seznam registrovaných prostředí pro váš účet, použijte příkaz az cloud list nebo Get-AzEnvironment.

Vrácená hodnota

Tato funkce vrací vlastnosti pro aktuální prostředí Azure. Následující příklad ukazuje vlastnosti globálního Azure. Suverénní cloudy můžou vracet mírně odlišné vlastnosti.

{
  "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říklad

Následující příklad souboru Bicep vrátí objekt prostředí.

output environmentOutput object = environment()

Předchozí příklad vrátí následující objekt při nasazení do globálního Azure:

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

Další kroky

• Pokud chcete získat hodnoty z prostředků, skupin prostředků nebo předplatných, podívejte se na funkce prostředků.