Implementatiefuncties voor Bicep

In dit artikel worden de Bicep-functies beschreven voor het ophalen van waarden die betrekking hebben op de huidige implementatie.

deployer

deployer()

Retourneert de informatie over de huidige implementatie-principal.

Naamruimte: az.

Retourwaarde

Deze functie retourneert de informatie over de huidige implementatie-principal, inclusief tenant-id en object-id.

{
  "objectId": "",
  "tenantId": ""
}

Opmerking

Het volgende voorbeeld van het Bicep-bestand retourneert het deployer-object.

output deployer object = deployer()

In het voorgaande voorbeeld wordt het volgende object geretourneerd:

{
  "objectId":"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "tenantId":"aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e"
}

implementatie

deployment()

Retourneert informatie over de huidige implementatiebewerking.

Naamruimte: az.

Retourwaarde

Met deze functie wordt het object geretourneerd dat tijdens de implementatie wordt doorgegeven. De eigenschappen in het geretourneerde object verschillen op basis van of u:

• een lokaal Bicep-bestand implementeren.
• implementeren in een resourcegroep of implementeren in een van de andere bereiken (Azure-abonnement, beheergroep of tenant).

Wanneer u een lokaal Bicep-bestand implementeert in een resourcegroep, retourneert de functie de volgende indeling:

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

Wanneer u implementeert in een Azure-abonnement, beheergroep of tenant, bevat het retourobject een location eigenschap. De location eigenschap is niet opgenomen bij het implementeren van een lokaal Bicep-bestand. De indeling is:

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

Opmerking

In het volgende voorbeeld wordt het implementatieobject geretourneerd:

output deploymentOutput object = deployment()

In het voorgaande voorbeeld wordt het volgende object geretourneerd:

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

omgeving

environment()

Retourneert informatie over de Azure-omgeving die wordt gebruikt voor implementatie. De environment() functie is niet op de hoogte van resourceconfiguraties. Er kan slechts één standaard DNS-achtervoegsel worden geretourneerd voor elk resourcetype.

Naamruimte: az.

Opmerkingen

Als u een lijst met geregistreerde omgevingen voor uw account wilt zien, gebruikt u az cloud list of Get-AzEnvironment.

Retourwaarde

Deze functie retourneert eigenschappen voor de huidige Azure-omgeving. In het volgende voorbeeld ziet u de eigenschappen voor globale Azure. Onafhankelijke clouds kunnen enigszins verschillende eigenschappen retourneren.

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

Opmerking

Het volgende voorbeeld van het Bicep-bestand retourneert het omgevingsobject.

output environmentOutput object = environment()

In het voorgaande voorbeeld wordt het volgende object geretourneerd wanneer het wordt geïmplementeerd in globale 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"
  }
}

Volgende stappen

• Als u waarden wilt ophalen uit resources, resourcegroepen of abonnementen, raadpleegt u Resourcefuncties.