Udostępnij za pośrednictwem

Używanie i nieużywanie instrukcji 'none'

Deklaracja using lub using none musi być obecna we wszystkich plikach parametrów Bicep.

Plik parametrów Bicep zwykle używa using instrukcji, aby powiązać plik z plikiem Bicep, szablonem usługi Azure Resource Manager w formacie JSON (szablon arm),modułem Bicep lub specyfikacją szablonu. To połączenie umożliwia serwerowi języka Bicep i kompilatorowi zweryfikowanie pliku parametrów — sprawdzanie poprawności nazw, typów i wymaganych wartości na podstawie danych wejściowych szablonu.

Z kolei instrukcja jawnie wskazuje, using none że plik parametrów nie jest powiązany z żadnym konkretnym szablonem w czasie kompilacji. Oznacza to, że parametry nie są weryfikowane względem określonego szablonu i są przeznaczone do bardziej ogólnego użycia — na przykład używane przez narzędzia zewnętrzne lub pełniące rolę udostępnionych zestawów parametrów wielokrotnego użytku.

Uwaga

Pliki parametrów Bicep są obsługiwane tylko w Bicep CLI w wersji 0.18.4 lub nowszej, Azure CLI w wersji 2.47.0 lub nowszej oraz Azure PowerShell w wersji 9.7.1 lub nowszej. Ta funkcja jest obsługiwana using none w interfejsie wiersza polecenia Bicep w wersji 0.31.0 lub nowszej .

Aby użyć instrukcji z szablonami ARM JSON, modułami Bicep i specyfikacjami szablonów, musisz mieć Bicep CLI w wersji 0.22.6 lub nowszej oraz Azure CLI w wersji 2.53.0 lub nowszej.

Instrukcja "using"

Składnia using instrukcji:

  • Aby użyć plików Bicep:

    using '<path>/<file-name>.bicep'

  • Aby użyć szablonów usługi ARM w formacie JSON:

    using '<path>/<file-name>.json'

  • Aby użyć modułów publicznych:

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

    Na przykład:

    using 'br/public:avm/res/storage/storage-account:0.9.0' 

param name = 'mystorage'

  • Aby użyć modułów prywatnych:

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

    Na przykład:

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

    Aby użyć modułu prywatnego z aliasem zdefiniowanym w pliku bicepconfig.json :

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

    Na przykład:

    using 'br/storageModule:storage:v1'

  • Aby użyć specyfikacji szablonu:

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

    Na przykład:

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

    Aby użyć specyfikacji szablonu z aliasem zdefiniowanym w pliku bicepconfig.json :

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

    Na przykład:

    using 'ts/myStorage:storageSpec:1.0'

Instrukcja "using none"

Instrukcja using none w pliku parametrów Bicep (.bicepparam) wskazuje, że plik nie jest powiązany z określonym szablonem Bicep podczas tworzenia lub kompilacji. Spowoduje to oddzielenie pliku parametrów z określonego szablonu, co zapewnia większą elastyczność w sposobie definiowania i użycia parametrów we wszystkich wdrożeniach.

Składnia using none instrukcji:

using none

Ta instrukcja jest umieszczana na początku pliku parametrów Bicep, aby zasygnalizować, że nie ma odwołania do określonego szablonu.

Główną zaletą using none aplikacji Bicep są scenariusze, w których pliki parametrów są uogólnione, współużytkowane lub dynamicznie zintegrowane z szablonami. Typowe przypadki użycia to:

  • Scentralizowane repozytoria parametrów

    Organizacje często utrzymują standardowe wartości parametrów — takie jak regiony domyślne, konwencje nazewnictwa lub tagi globalne — używane w wielu wdrożeniach Bicep. Plik parametrów Bicep przy użyciu opcji none może pełnić rolę centralnego magazynu dla tych wspólnych wartości, poprawiając spójność i minimalizując duplikację. Te parametry można następnie programowo scalić z wartościami specyficznymi dla szablonu w czasie wdrażania.

    Na przykład udostępniony plik parametrów Bicep może definiować:

    using none

param location = 'westus2'
param environmentTag = 'production'
param projectName = 'myApp'

  • Dynamiczne generowanie i integracja środowiska uruchomieniowego

    W potokach CI/CD lub skryptach automatyzacji pliki parametrów mogą być tworzone dynamicznie lub skojarzone z szablonami w trakcie wykonywania. Pominięcie stałego odwołania using none do szablonu umożliwia zachowanie elastyczności i dostosowania tych plików do różnych kontekstów wdrażania.

Jeśli using none parametr jest określony w pliku parametrów Bicep, kompilator nie weryfikuje parametrów względem określonego szablonu Bicep, co oznacza, że nie są wywoływane żadne ostrzeżenia lub błędy w czasie kompilacji dla niezgodnych nazw lub typów z powodu braku połączonego szablonu. Jednak to oddzielenie ma zastosowanie tylko podczas tworzenia i kompilacji — w czasie wdrażania usługa Azure Resource Manager (ARM) nadal wymaga zarówno szablonu Bicep, jak i pliku parametrów. Aparat usługi ARM przeprowadza walidację podczas wdrażania, rozpoznając parametry w pliku względem parametrów zdefiniowanych w szablonie docelowym.

Następne kroki