Praca z metadanymi interfejsu wiersza polecenia dla deweloperów platformy Azure dla parametrów wejściowych Bicep

Azure Developer CLI (azd) obsługuje szablony Bicep z dekoratorem @metadata. Dodaj metadane do parametrów wejściowych Bicep, aby ulepszyć wdrażanie poprzez inteligentne wartości domyślne, automatyczne generowanie wartości parametrów oraz lepsze monitowanie parametrów.

Dodawanie metadanych

Parametry wejściowe w Bicep obsługują @metadata jako obiekt bez schematu. Dodaj azd metadane, dołączając azd pole w metadanych parametru:

@metadata({
  azd: {}
})
param someInput <param-type>

Metadane interfejsu wiersza polecenia platformy Azure nie zależą od typu parametru i można dodać je do dowolnego parametru.

Obsługiwane metadane

Obsługiwane pola konfiguracji metadanych azd to:

Każde pole zostało szczegółowo opisane w poniższych sekcjach.

Typ

Ta konfiguracja definiuje sposób azd monitowania o parametr wejściowy. Obsługiwane typy obejmują:

• lokalizacja

  Użyj typu location, aby poinformować azd, że parametr wejściowy obsługuje lokalizację platformy Azure. Po tym jak azd znajdzie typ location w metadanych, wyświetla monit o wprowadzenie wartości za pomocą listy wyboru lokalizacji. Przykład:

  @metadata({
    azd: {
      type: 'location'
    }
  })
  param someInput string
  

  Przepływ monitu:

  

  Połącz typ location z polem default, aby kontrolować, która lokalizacja jest najpierw wyróżniona podczas sekwencji monitów. Przykład:

  @metadata({
    azd: {
      type: 'location'
      default: 'westus'
    }
  })
  param someInput string
  

  Przepływ monitowania:

  

  Wyróżniona opcja domyślna jest zgodna z polem default z metadanych. Takie podejście umożliwia autorom szablonów zalecenie lokalizacji, gdy użytkownicy mogą ją potwierdzić lub zmienić. Ustawienie wartości domyślnej parametru wejściowego w Bicep pomija przepływ monitu i używa wartości domyślnej bez potwierdzenia użytkownika.

• stworzyć

  Użyj typu generate, aby polecić azd, aby automatycznie utworzyć wartość dla parametru wejściowego. Ten typ jest często używany do generowania haseł lub unikatowych identyfikatorów:

  @metadata({
    azd: {
      type: 'generate'
      config: {
        length: 10
      }
    }
  })
  param someInput string
  

  Uwaga / Notatka

  Pole config jest wymagane wraz z type: 'generate'.

  Podczas działania azd generuje wartość o długości 10 znaków dla parametru wejściowego bez monitowania o podanie danych. Zobacz sekcję konfiguracji , aby uzyskać opcje konfigurowania wartości automatycznego generowania.

• resourceGroup

  resourceGroup Użyj typu , aby wyświetlić azd monit o podanie grupy zasobów dla tych danych wejściowych:

  @metadata({
    azd: {
      type: 'resourceGroup'
    }
  })
  param someInput string
  

  Przepływ monitu:

  

Config

Obiekt config jest wymagany z typem generate . Steruje opcjami automatycznego generowania. W poniższej tabeli opisano opcje generowania konfiguracji:

Na przykład wygeneruj wartość o długości 10, bez znaków specjalnych i bez liczb:

@metadata({
  azd: {
    type: 'generate'
    config: {
      length: 10
      noNumeric: true
      noSpecial: true
    }
  }
})
param someInput string

Default

Definiuje początkową wartość z listy do wyróżnienia. Połącz go z typem location lub zastosuj go bezpośrednio do danych wejściowych ze zdefiniowaną listą opcji:

@allowed(['foo', 'bar', 'baz'])
@metadata({
  azd: {
    default: 'baz'
  }
})
param someInput string

W tym przykładzie @allowed() użyto adnotacji z Bicep, aby zdefiniować listę obsługiwanych wartości parametru wejściowego. Podczas, gdy azd prosi o podanie tych danych wejściowych, używa listy dozwolonych wartości. Pole default w kontrolkach metadanych określa, która opcja jest ustawiana jako wybór początkowy:

Nazwa użycia

Pole usageName filtruje listę lokalizacji tylko do lokalizacji, w których dostępna jest dana jednostka SKU i pojemność sztucznej inteligencji:

@metadata({
  azd: {
    type: 'location'
    usageName: [
      'OpenAI.GlobalStandard.gpt-5-mini,10'
    ]
  }
})
param someInput string

W tym przykładzie azd pokazano tylko lokalizacje platformy Azure, w których model gpt-5-mini sztucznej inteligencji ma wystarczający limit przydziału (pojemność co najmniej 10).

Przepływ monitu:

Zrzut ekranu przedstawiający ustawienie usageName do wywołania monitu o lokalizację AI.