Condividi tramite

Funzioni di distribuzione per Bicep

Questo articolo descrive le funzioni Bicep per ottenere i valori correlati alla distribuzione corrente.

Distributore

deployer()

Restituisce informazioni sull'entità (identità) che ha avviato la distribuzione corrente. L'entità può essere un utente, un'entità servizio o un'identità gestita, a seconda della modalità di avvio della distribuzione.

Spazio dei nomi: az.

Valore restituito

Questa funzione restituisce un oggetto con informazioni dettagliate sull'entità di distribuzione, tra cui:

  • objectId: ID oggetto Microsoft Entra ID dell'entità.
  • tenantId: ID tenant di Microsoft Entra ID.
  • userPrincipalName: nome dell'entità utente (UPN) se disponibile. Per le entità servizio o le identità gestite, questa proprietà può essere vuota.

Annotazioni

I valori restituiti dipendono dal contesto di distribuzione. Ad esempio, userPrincipalName può essere vuoto per le entità servizio o le identità gestite.

{
  "objectId": "<principal-object-id>",
  "tenantId": "<tenant-id>",
  "userPrincipalName": "<[email protected] or empty>"
}

Esempio

Nell'esempio seguente il file Bicep restituisce l'oggetto deployer.

output deployer object = deployer()

Output di esempio (i valori differiscono in base alla distribuzione):

{
  "objectId":"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "tenantId":"aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
  "userPrincipalName":"[email protected]"
}

Per altre informazioni sulle identità di Azure, vedere Che cos'è un'identità di Azure Active Directory?

distribuzione

deployment()

Restituisce informazioni sull'operazione di distribuzione corrente.

Spazio dei nomi: az.

Valore restituito

Questa funzione restituisce l'oggetto che viene passato durante la distribuzione. Le proprietà nell'oggetto restituito variano a seconda che si stia eseguendo:

Se si distribuisce un file Bicep locale in un gruppo di risorse, la funzione restituisce il formato seguente:

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

Se la distribuzione avviene in una sottoscrizione di Azure, in un gruppo di gestione o in un tenant, l'oggetto restituito include una proprietà location. La location proprietà non è inclusa durante la distribuzione di un file Bicep locale. Il formato è:

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

Esempio

L'esempio seguente restituisce l'oggetto di distribuzione:

output deploymentOutput object = deployment()

L'esempio precedente restituisce l'oggetto seguente:

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

dell'ambiente di

environment()

Restituisce informazioni sull'ambiente di Azure usato per la distribuzione. La environment() funzione non è in grado di conoscere le configurazioni delle risorse. Può restituire solo un singolo suffisso DNS predefinito per ogni tipo di risorsa.

Spazio dei nomi: az.

Osservazioni:

Per visualizzare un elenco di ambienti registrati per l'account, usare az cloud list o Get-AzEnvironment.

Valore restituito

Questa funzione restituisce le proprietà per l'ambiente Azure corrente. L'esempio seguente mostra le proprietà per Azure globale. I cloud sovrani potrebbero restituire proprietà leggermente diverse.

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

Esempio

Nell'esempio seguente il file Bicep restituisce l'oggetto ambiente.

output environmentOutput object = environment()

L'esempio precedente restituisce l'oggetto seguente quando è distribuito in Azure globale:

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

Passaggi successivi