Freigeben über


Verwenden und Verwenden von None-Anweisungen

Eine using oder eine using none Deklaration muss in allen Bicep-Parameterdateien vorhanden sein.

Eine Bicep-Parameterdatei verwendet in der Regel eine using Anweisung, um die Datei mit einer Bicep-Datei, einer JSON Azure Resource Manager-Vorlage (ARM-Vorlage), einem Bicep-Modul oder einer Vorlagenspezifikation zu verknüpfen. Diese Verknüpfung ermöglicht es dem Bicep-Sprachserver und compiler, die Parameterdateiüberprüfung auf korrekte Namen, Typen und erforderliche Werte basierend auf den Eingaben der Vorlage zu überprüfen.

Im Gegensatz dazu gibt die using none Anweisung explizit an, dass die Parameterdatei zur Kompilierungszeit nicht an eine bestimmte Vorlage gebunden ist. Dies bedeutet, dass die Parameter nicht anhand einer bestimmten Vorlage überprüft werden und stattdessen für allgemeinere Verwendung vorgesehen sind, z. B. durch externe Tools oder als freigegebene, wiederverwendbare Parametersätze verwendet werden.

Hinweis

Bicep-Parameterdateien werden nur in Bicep CLI Version 0.18.4 oder höher, Azure CLI Version 2.47.0 oder höher und Azure PowerShell Version 9.7.1 oder höher unterstützt. Das using none Feature wird in Bicep CLI, Version 0.31.0 oder höher, unterstützt.

Um die Anweisung mit JSON ARM-Vorlagen, Bicep-Modulen und Vorlagenspezifikationen zu verwenden, müssen Sie über Bicep CLI Version 0.22.6 oder höher und Azure CLI Version 2.53.0 oder höher verfügen.

Die using-Anweisung

Die Syntax der using Anweisung:

  • So verwenden Sie Bicep-Dateien:

    using '<path>/<file-name>.bicep'
    
  • So verwenden Sie JSON-ARM-Vorlagen:

    using '<path>/<file-name>.json'
    
  • So verwenden Sie öffentliche Module:

    using 'br/public:<file-path>:<tag>'
    

    Beispiel:

    using 'br/public:avm/res/storage/storage-account:0.9.0' 
    
    param name = 'mystorage'
    
  • So verwenden Sie private Module:

    using 'br:<acr-name>.azurecr.io/bicep/<file-path>:<tag>'
    

    Beispiel:

    using 'br:myacr.azurecr.io/bicep/modules/storage:v1'
    

    So verwenden Sie ein privates Modul mit einem Alias, der in einer bicepconfig.json-Datei definiert ist:

    using 'br/<alias>:<file>:<tag>'
    

    Beispiel:

    using 'br/storageModule:storage:v1'
    
  • So verwenden Sie Vorlagenspezifikationen:

    using 'ts:<subscription-id>/<resource-group-name>/<template-spec-name>:<tag>
    

    Beispiel:

    using 'ts:00000000-0000-0000-0000-000000000000/myResourceGroup/storageSpec:1.0'
    

    So verwenden Sie eine Vorlagenspezifikation mit einem Alias, der in einer bicepconfig.json-Datei definiert ist:

    using 'ts/<alias>:<template-spec-name>:<tag>'
    

    Beispiel:

    using 'ts/myStorage:storageSpec:1.0'
    

Die using None-Anweisung

Die using none Anweisung in einer Bicep-Parameterdatei (Bicepparam) gibt an, dass die Datei während der Erstellung oder Kompilierung nicht an eine bestimmte Bicep-Vorlage gebunden ist. Dadurch wird die Parameterdatei von einer bestimmten Vorlage entkoppelt, wodurch eine größere Flexibilität bei der Definition und Verwendung von Parametern für bereitstellungsübergreifende Bereitstellungen ermöglicht wird.

Die Syntax der using none Anweisung:

using none

Diese Anweisung wird am Anfang einer Bicep-Parameterdatei platziert, um zu signalisieren, dass auf keine bestimmte Vorlage verwiesen wird.

Der Hauptvorteil von using none Bicep liegt in Szenarien, in denen Parameterdateien generalisiert, freigegeben oder dynamisch in Vorlagen integriert werden. Zu den gängigen Anwendungsfällen gehören:

  • Zentrale Parameterverzeichnisse

    Organisationen verwalten häufig Standardparameterwerte, z. B. Standardregionen, Benennungskonventionen oder globale Tags, die in mehreren Bicep-Bereitstellungen verwendet werden. Eine Bicep-Parameterdatei mit der Verwendung von "None" kann als zentrales Repository für diese geteilten Werte fungieren, die Konsistenz verbessern und Duplizierung minimieren. Diese Parameter können dann programmgesteuert mit vorlagenspezifischen Werten während der Bereitstellung zusammengeführt werden.

    Eine freigegebene Bicep-Parameterdatei kann z. B. Folgendes definieren:

    using none
    
    param location = 'westus2'
    param environmentTag = 'production'
    param projectName = 'myApp'
    
  • Dynamische Erstellung und Laufzeitintegration

    In CI/CD-Pipelines oder Automatisierungsskripts können Parameterdateien zur Laufzeit erstellt oder Vorlagen zugeordnet werden. Durch Weglassen eines festen Vorlagenverweises using none können diese Dateien flexibel und an verschiedene Bereitstellungskontexte angepasst werden.

Wenn using none in einer Bicep-Parameterdatei angegeben wird, überprüft der Compiler die Parameter nicht anhand einer bestimmten Bicep-Vorlage, was bedeutet, dass keine Kompilierungszeitwarnungen oder Fehler aufgrund des Fehlens einer verknüpften Vorlage für nicht übereinstimmende Namen oder Typen ausgelöst werden. Diese Entkopplung gilt jedoch nur während des Authorings und der Kompilierung; zur Bereitstellungszeit erfordert der Azure Resource Manager (ARM) weiterhin sowohl eine Bicep-Vorlage als auch eine Parameterdatei. Die ARM-Engine führt während der Bereitstellung eine Validierung durch, indem sie die Parameter in der Datei gegen die in der Zielvorlage definierten Parameter auflöst.

Nächste Schritte