Az Azure Developer CLI sémareferenciája

A azure.yaml fájl az Azure Developer CLI -projektekazd konfigurációs fájlja. Helyezze a projekt gyökeréhez az alkalmazást alkotó szolgáltatások, Azure-erőforrások, infrastruktúra, horgok és CI/CD-folyamatok definiálásához. Amikor olyan parancsokat futtat, azd upmint a azd provisionparancssori felület, azd deployolvassa be ezt a fájlt az alkalmazás szerkezetének és az Azure-ban való üzembe helyezésének megismeréséhez.

Ez a cikk az azure.yaml séma teljes hivatkozását ismerteti. A sablonok használatának első lépéseiért azd tekintse meg az Azure Developer CLI-sablonok áttekintését.

Minta

Az alábbiakban egy sablonhoz tartozó fájl általános példáját azure.yamlazd mutatjuk be. Valós példát a azure.yamlToDo NodeJs Mongo sablonban talál:

name: yourApp
metadata:
  template: yourApp@0.0.1-beta
services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: appservice
  api:
    project: ./src/api
    language: js
    host: appservice

Legfelső szintű tulajdonságok

Elem neve Szükséges Típus Leírás
name Y karakterlánc Az alkalmazás neve. Csak kisbetűk, számok és kötőjelek (-) engedélyezettek. A névnek betűvel vagy számmal kell kezdődnie és végződnie.
resourceGroup N karakterlánc Az Azure-erőforráscsoport neve. Ha meg van adva, felülbírálja az infrastruktúra kiépítéséhez használt erőforráscsoport-nevet. Támogatja a környezeti változók helyettesítését.
metadata N objektum Az alkalmazássablon metaadatai.
infra N objektum További konfigurációt biztosít az Azure-infrastruktúra kiépítéséhez.
services N objektum Az alkalmazást alkotó szolgáltatások meghatározása.
resources N objektum Az alkalmazás által használt Azure-erőforrások meghatározása.
pipeline N objektum A folyamatos integrációs folyamat definíciója.
hooks N objektum Parancsszintű horgok parancsokhoz azd .
requiredVersions N objektum További konfigurációt biztosít a szükséges verziókhoz azd és bővítményekhez.
state N objektum További konfigurációt biztosít az állapotkezeléshez.
platform N objektum További konfigurációt biztosít a platformspecifikus funkciókhoz, például az Azure Dev Centerhez.
workflows N objektum További konfigurációt biztosít a munkafolyamatokhoz, például a felülbírálási viselkedéshez azd up .
cloud N objektum További konfigurációt biztosít a szuverén felhőkben való üzembe helyezéshez. Az alapértelmezett felhő a .AzureCloud

name

(sztring, kötelező) Az alkalmazás neve. Csak kisbetűk, számok és kötőjelek (-) engedélyezettek. A névnek betűvel vagy számmal kell kezdődnie és végződnie. Minimális hossz: 2 karakter.

name: my-app

resourceGroup

(sztring) Azure-erőforráscsoport neve. Ha meg van adva, felülbírálja az infrastruktúra kiépítéséhez használt erőforráscsoport-nevet. Támogatja a környezeti változók helyettesítését. 3 és 64 karakter között kell lennie.

resourceGroup: rg-my-app-${AZURE_ENV_NAME}

metadata

(objektum) Az alkalmazássablon metaadatai.

Property Szükséges Típus Leírás
template N karakterlánc Annak a sablonnak az azonosítója, amelyből az alkalmazást létrehozták. 
metadata:
  template: todo-nodejs-mongo@0.0.1-beta

infra

(objektum) További konfigurációt biztosít az Azure-infrastruktúra kiépítéséhez.

Property Szükséges Típus Leírás
provider N karakterlánc Az azure-erőforrások alkalmazáshoz való kiépítéséhez használt infrastruktúra-kiépítési szolgáltató. A beépített értékek és bicepa terraform . A bővítmények további nevesített szolgáltatókat is regisztrálhatnak (például microsoft.foundry). Alapértelmezett: bicep.
path N karakterlánc A megadott szolgáltató Azure-kiépítési sablonjainak relatív mappa elérési útja. Alapértelmezett: infra.
module N karakterlánc Az Alapértelmezett modul neve az Azure kiépítési sablonjaiban. Alapértelmezett: main.
layers N tömb Rétegek az Azure-infrastruktúra kiépítéséhez. Lásd a(z) infra.layers.

Note

Ha layers legalább egy elem van megadva, a tulajdonságok és path a module tulajdonságok nem használhatók. Használjon inkább rétegspecifikus path és module értékeket.

infra.layers

(objektumtömb) Meghatározza az Azure-infrastruktúra kiépítési rétegeit. Minden réteg egy független kiépítési egységet jelöl.

Property Szükséges Típus Leírás
name Y karakterlánc A kiépítési réteg neve.
path Y karakterlánc A megadott szolgáltató Azure-kiépítési sablonjainak relatív mappa elérési útja.
module N karakterlánc Az erőforrások kiépítésekor használt Azure-kiépítési modul neve. Alapértelmezett: main.
dependsOn N sztringek tömbje A réteg többi rétegének neve függ. Olyan függőségek deklarálásához használható, amelyekből azda statikus elemző nem tud következtetni, például a horog által közvetített függőségek (például amikor egy másik rétegben lévő postprovision horog ír egy környezeti változót, amelyet a réteg bicepparamja a kiosztáskor olvas be).
hooks N objektum Réteghogok kiépítése. Támogatja preprovision és postprovision horgok. Az elérési utak megadásakor az elérési utaknak a réteg elérési úthoz viszonyítottnak kell lenniük. Lásd : Hook-definíció.

Note

azdA rétegfüggőségek automatikusan következtetnek Bicep rétegekre és egyéni vagy bővítményszolgáltatókra (például microsoft.foundry) a környezeti változók és .parameters.json a rétegkimeneti hivatkozások fájljainak vizsgálatával.bicep.bicepparam. A beépített, nem Bicep szolgáltatók (Terraform, Pulumi, ARM és a tesztszolgáltató) átlátszatlanok ehhez az elemzéshez, ezért adjon hozzá explicit dependsOn módon, amikor ezekhez a rétegekhez rendel. Explicitre dependsOn akkor is szükség van, ha egy függőség nem vonható le paraméterhivatkozásokból, például egy másik réteg által egy horogon keresztül előállított értékből.

infra:
  provider: bicep
  layers:
    - name: core
      path: ./infra/core
    - name: services
      path: ./infra/services
      dependsOn:
        - core
      hooks:
        postprovision:
          shell: sh
          run: ./scripts/post-provision.sh

Terraform mint IaC-szolgáltatói minta

Ha a Terraformot szeretné használni Bicep helyett, állítsa a provider következőre terraform: . További információ: A Terraform használata IaC-szolgáltatóként.

name: yourApp-terraform
metadata:
  template: yourApp-terraform@0.0.1-beta
services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: appservice
  api:
    project: ./src/api
    language: js
    host: appservice
infra:
  provider: terraform

services

(objektum) az alkalmazást alkotó szolgáltatások definícióját. Minden kulcs egy szolgáltatásnév, az érték pedig egy szolgáltatáskonfigurációs objektum.

Szolgáltatás tulajdonságai

Property Szükséges Típus Leírás
host Y karakterlánc A szolgáltatás implementálásához használt Azure-erőforrás típusa. Lásd : Gazdagéptípusok.
project Conditional karakterlánc A szolgáltatás forráskódkönyvtárának elérési útja. A legtöbb gazdagéptípushoz szükséges.
image Conditional karakterlánc A tárolórendszerképhez használandó forráslemezkép forrásból való létrehozása helyett. Támogatja a környezeti változók helyettesítését. Csak gazdagépre containerapp érvényes.
language N karakterlánc A szolgáltatás implementálási nyelve. Engedélyezett értékek: dotnet, csharp, fsharp, py, pythonjs, ts, javago, , golang, . docker
module N karakterlánc A szolgáltatás központi telepítéséhez használt infrastruktúramodul elérési útja a gyökér inframappához viszonyítva. Ha nincs megadva, a parancssori felület feltételezi, hogy a modul neve megegyezik a szolgáltatás nevével.
dist N karakterlánc A szolgáltatás üzembehelyezési összetevőinek relatív elérési útja.
resourceName N karakterlánc A szolgáltatást megvalósító Azure-erőforrás neve. Alapértelmezés szerint a parancssori felület felderíti az Azure-erőforrást az aktuális szolgáltatás nevére beállított címkével azd-service-name . Támogatja a környezeti változók helyettesítését.
resourceGroup N karakterlánc Az erőforrást tartalmazó Azure-erőforráscsoport neve. Ha meg van adva, a parancssori felület megkeresi az Azure-erőforrást a megadott erőforráscsoporton belül. Támogatja a környezeti változók helyettesítését.
remoteBuild N boolean Távoli build használata a függvényalkalmazás üzembe helyezéséhez. Csak akkor érvényes, ha host az function. Ha be van trueállítva, az üzembehelyezési csomag távolról, az Oryx használatával lesz felépítve. JavaScript-, TypeScript- és Python-függvényalkalmazások true alapértelmezett értéke.
docker N objektum Docker-konfiguráció. Csak tárolóalapú gazdagépekre alkalmazható. Lásd a(z) docker.
k8s N objektum Az AKS konfigurációs beállításai. Csak akkor érvényes, ha host az aks. Lásd a(z) k8s.
config N objektum További konfigurációs lehetőségek a szolgáltatáshoz.
uses N tömb Azoknak a szolgáltatásneveknek és erőforrásneveknek a listája, amelyektől a szolgáltatás függ.
env N objektum Környezeti változók nevének térképe értékekre. Támogatja a környezeti változók helyettesítését.
apiVersion N karakterlánc Erőforrás-szolgáltatói API-verzió az üzemelő példányokhoz. Csak akkor érvényes, ha host az containerapp.
hooks N objektum Szolgáltatási szintű horgok. Lásd : Szolgáltatáshookok.

Tip

A különböző szolgáltatáskonfigurációk teljes YAML-példáiért tekintse meg a szolgáltatásmintákat .

Gazdagéptípusok

A host tulajdonság határozza meg a szolgáltatás implementálásához használt Azure-erőforrás típusát, és meghatározza, hogy mely egyéb tulajdonságok érvényesek.

Gazdagép értéke Leírás Megköveteli project Támogatja image Támogatja docker Támogatja k8s Támogatja env Támogatja apiVersion
appservice Azure App Service N Y Y N Y N
containerapp Azure Container Apps project vagy image (nem mindkettő) Y Y N Y Y
function Azure Functions Y N N N N N
staticwebapp Azure Static Web Apps Y N N N N N
springapp Azure Spring Apps Y N N N N N
aks Azure Kubernetes Service N N Y Y N N
ai.endpoint Azure AI online végpont Y N Y N N N
azure.ai.agent Azure AI-ügynök Y Y Y N Y N
microsoft.foundry Microsoft Foundry (örökölt) N N N N N N
azure.ai.project Microsoft Foundry-projekt N N N N N N
azure.ai.connection Microsoft Foundry-kapcsolat N N N N N N
azure.ai.toolbox Microsoft Öntödei eszközkészlet N N N N N N
azure.ai.skill Microsoft Öntödei képesség N N N N N N
azure.ai.routine Microsoft Foundry rutin N N N N N N

Note

springapp A támogatáshoz az alfafunkciókhoz való bejelentkezés szükséges. További információ: Alfa funkciók.

Note

Ha host igen containerapp, meg kell adnia vagy imageproject, de mindkettőt nem. Ha image be van állítva, a tároló a megadott rendszerképből lesz üzembe helyezve. Ha project be van állítva, a tároló lemezképe forrásból jön létre.

Note

Ha host igenappservice, akkor a forrásból is üzembe helyezheti a beállítástproject, vagy tárolóból a beállítás és imagea tároló docker használatával.

Note

Ha host igen azure.ai.agent, a config tulajdonság elavult. Az ügynökbeállítások átkerültek a szolgáltatási szintre, de az előző config alakzat érvényes marad.

Note

A microsoft.foundry, azure.ai.project, azure.ai.connection, azure.ai.toolboxazure.ai.skillés azure.ai.routine gazdagépek deklaratív Microsoft Foundry-erőforrás-gazdagépek. Nem hozhat létre és nem helyezhet üzembe alkalmazáskódot a számukra. Ehelyett mindegyik deklarál egy támogató öntödei erőforrást, amely azd kiépít és konfigurál. A konfiguráció a forráskód helyett a megfelelő azd bővítményekből származik, így az olyan tulajdonságok, mint a project, imageés docker nem érvényesek. Új projektekhez használható azure.ai.project ; microsoft.foundry régi kompatibilitási gazdagép. A tulajdonság részleteiért lásd Microsoft Foundry-gazdagépeket.

ai.endpoint Config

(objektum, szükség esetén hostai.endpoint) További konfigurációt biztosít az Azure AI online végpont üzembe helyezéséhez.

Property Szükséges Típus Leírás
workspace N karakterlánc Az AI Studio projekt munkaterületének neve. Ha nincs megadva, azd a környezeti változóban AZUREAI_PROJECT_NAME megadott értéket használja. Támogatja a környezeti változók helyettesítését.
flow N objektum Az Azure AI Studio Prompt Flow-konfigurációja. Ha nincs megadva, a rendszer nem hoz létre parancssori folyamatot. Lásd : AI-összetevő konfigurációja.
environment N objektum Az Azure AI Studio egyéni környezetkonfigurációja. Ha nincs megadva, a rendszer nem hoz létre egyéni környezetet. Lásd : AI-összetevő konfigurációja.
model N objektum Az Azure AI Studio modellkonfigurációja. Ha nincs megadva, a modell nem jön létre. Lásd : AI-összetevő konfigurációja.
deployment Y objektum Az Azure AI Studio online végpont üzembe helyezési konfigurációja. Létrejön egy új online végpont üzembe helyezése, és a forgalom a sikeres befejezés után automatikusan az új üzembe helyezésre kerül. Lásd az AI üzembe helyezési konfigurációjának megtekintését.

Note

Ha host igenai.endpoint, akkor project mindkettőre config szükség van. Tekintse meg ai.endpoint a szükséges konfigurációs tulajdonságok konfigurációját.

AI-összetevő konfigurációja
Property Szükséges Típus Leírás
name N karakterlánc Az AI-összetevő neve. Ha nincs megadva, azd létrehoz egy nevet az összetevő típusa és a szolgáltatásnév alapján. Támogatja a környezeti változók helyettesítését.
path Y karakterlánc Az AI-összetevő konfigurációs fájljának vagy forráskódjának elérési útja.
overrides N objektum Az AI-összetevő konfigurációjának felülbírálásához használt kulcsértékpárok térképe. Támogatja a környezeti változók helyettesítését.
AI üzembe helyezési konfigurációja

Az AI-összetevő konfigurációjának összes tulajdonságát örökli, valamint:

Property Szükséges Típus Leírás
environment N objektum A kulcs-érték párok térképe, amely környezeti változóként van beállítva az üzembe helyezéshez. Az értékek támogatják az operációs rendszer és a azd környezeti változók helyettesítését. 
services:
  myendpoint:
    project: ./src/endpoint
    host: ai.endpoint
    config:
      workspace: my-ai-project
      deployment:
        path: ./deployment
        environment:
          MODEL_NAME: ${AZURE_OPENAI_MODEL}

docker

(objektum) Docker-konfiguráció egy szolgáltatáshoz. Csak a tárolókat támogató gazdagépekre (appservice, , containerapp, aks, ai.endpoint). azure.ai.agent

Property Szükséges Típus Leírás
path N karakterlánc A Dockerfile elérési útja a szolgáltatáshoz képest. Alapértelmezett: ./Dockerfile.
context N karakterlánc A Docker buildkörnyezete. Ha meg van adva, felülbírálja az alapértelmezett környezetet. Alapértelmezett: ..
platform N karakterlánc A platform célja. Alapértelmezett: amd64.
registry N karakterlánc A lemezkép leküldéséhez használt tárolóregisztrációs adatbázis. Ha nincs megadva, alapértelmezés szerint a környezeti változó értéke AZURE_CONTAINER_REGISTRY_ENDPOINT lesz. Támogatja a környezeti változók helyettesítését.
image N karakterlánc A beépített tárolórendszerképre alkalmazott név. Ha nincs megadva, az alapértelmezett érték a .{appName}/{serviceName}-{environmentName} Támogatja a környezeti változók helyettesítését.
tag N karakterlánc A beépített tárolórendszerképre alkalmazott címke. Ha nincs megadva, az alapértelmezett érték a .azd-deploy-{unix time (seconds)} Támogatja a környezeti változók helyettesítését.
buildArgs N sztringek tömbje A docker buildelési parancsnak továbbítandó argumentumok összeállítása.
network N karakterlánc A DOCKER buildelése során a RUN-utasítások hálózati módja. --network Át lett adva a Docker-buildhez. Például lehetővé teszi a host buildtároló számára, hogy hozzáférjen a gazdagéphálózathoz.
remoteBuild N boolean A rendszerkép távoli buildelése. Ha be truevan állítva, a rendszerkép távolról készül az Azure Container Registry távoli buildelési funkciójával. Ha a távoli build sikertelen, azd automatikusan visszaesik a helyi építésbe a Docker vagy a Podman használatával, ha elérhető.

k8s

(objektum) Az Azure Kubernetes Service (AKS) konfigurációs beállításai. Csak akkor érvényes, ha host az aks.

Property Szükséges Típus Leírás
deploymentPath N karakterlánc A szolgáltatás elérési útjának relatív elérési útja a k8s üzembehelyezési jegyzékekhez. Alapértelmezett: manifests.
namespace N karakterlánc Az üzembe helyezett erőforrások k8s névtere. Ha meg van adva, létrejön egy új k8s névtér, ha még nem létezik. Alapértelmezett: projektnév.
deployment N objektum A k8s üzembehelyezési konfigurációja. Lásd az üzembehelyezési konfigurációt.
service N objektum A k8s szolgáltatás konfigurációja. Lásd : Szolgáltatáskonfiguráció.
ingress N objektum A k8s bejövő konfiguráció. Lásd : Bejövő forgalom konfigurációja.
helm N objektum A helm konfigurációja. Lásd : Helm-konfiguráció.
kustomize N objektum A kustomize konfiguráció. Lásd a Kustomize konfigurációt.
Üzembehelyezési konfiguráció
Property Szükséges Típus Leírás
name N karakterlánc Az üzembe helyezés során használni kívánt k8s üzembehelyezési erőforrás neve. Ha nincs beállítva, egy üzembehelyezési erőforrást keres ugyanabban a névtérben, amely tartalmazza a szolgáltatás nevét. Alapértelmezett: szolgáltatásnév.
Szolgáltatáskonfiguráció
Property Szükséges Típus Leírás
name N karakterlánc Az alapértelmezett szolgáltatásvégpontként használni kívánt k8s szolgáltatáserőforrás neve. Ha nincs beállítva, egy szolgáltatáserőforrást keres ugyanabban a névtérben, amely tartalmazza a szolgáltatásnevet. Alapértelmezett: szolgáltatásnév.
Bejövő forgalom konfigurációja
Property Szükséges Típus Leírás
name N karakterlánc Az alapértelmezett szolgáltatásvégpontként használni kívánt k8s bejövő erőforrás neve. Ha nincs beállítva, egy bejövő erőforrást keres ugyanabban a névtérben, amely tartalmazza a szolgáltatásnevet. Alapértelmezett: szolgáltatásnév.
relativePath N karakterlánc A szolgáltatás relatív elérési útja a bejövőforgalom-vezérlő gyökerétől. Ha be van állítva, a rendszer hozzáfűzi a bejövő erőforrás elérési útjának gyökeréhez.
Helm-konfiguráció
Property Szükséges Típus Leírás
repositories N tömb A hozzáadni kívánt helm-adattárak.
releases N tömb A helm a telepítéshez szükséges kiadásokat adja ki.

repositories tömbelemek:

Property Szükséges Típus Leírás
name Y karakterlánc A helm-adattár neve.
url Y karakterlánc A helm-adattár URL-címe.

releases tömbelemek:

Property Szükséges Típus Leírás
name Y karakterlánc A helm kiadás neve.
chart Y karakterlánc A helm-diagram neve.
version N karakterlánc A helm-diagram verziója.
namespace N karakterlánc A helm-diagram telepítéséhez szükséges k8s névtér. A szolgáltatásnévtér alapértelmezett értéke.
values N karakterlánc Relatív elérési út a szolgáltatástól az a-hoz values.yaml a helm-diagramnak való továbbításhoz.
Kustomize konfiguráció
Property Szükséges Típus Leírás
dir N karakterlánc A kustomize könyvtár relatív elérési útja. Támogatja a környezeti változók helyettesítését.
edits N sztringek tömbje Az üzembe helyezés előtt alkalmazandó kustomize-módosítások. Támogatja a környezeti változók helyettesítését.
env N objektum A kustomize könyvtárban lévő fájl létrehozásához .env használt környezeti kulcs/érték párok. Az értékek támogatják a környezeti változók helyettesítését.

Microsoft Foundry-gazdagépek

A azure.ai.agent gazdagép és a deklaratív Foundry-erőforrás-gazdagépek (microsoft.foundry, azure.ai.project, , azure.ai.connection, azure.ai.toolboxés azure.ai.skillazure.ai.routine) Microsoft Foundry-erőforrásokkal működnek együtt. A azure.ai.agent gazdagép egy mappából project buildelt alkalmazáskódot helyez üzembe, míg a deklaratív gazdagépek nem foglalnak magukban semmilyen buildelt kódot. Minden deklaratív gazdagép egy támogató Foundry-erőforrást ír le, amely azd kiépít és konfigurál. A beállításokat ai.endpointfészkelő gazdagépekkel ellentétben configezek a gazdagépek a gazdagépspecifikus tulajdonságait a következők egyszerű testvéreiként hosthatározzák meg. Az egyes gazdagépek tulajdonságai az alapséma azd helyett egy azure.yaml bővítménysémából származnak, ezért a bővítményt telepíteni kell a tulajdonságok érvényesítéséhez. A deklaratív gazdagépek esetében a szolgáltatáskulcs az erőforrás neve (például a kapcsolat, az eszközkészlet, a szakértelem vagy a rutin neve).

azure.ai.agent Config

(szolgáltatásszinten lévő tulajdonságok, ha host vanazure.ai.agent) Üzemeltetett Microsoft Foundry-ügynök konfigurálása. A szolgáltatáshoz szükség van projecta . A teljes tulajdonságkészletet a azure.ai.agent bővítményséma határozza meg.

Property Szükséges Típus Leírás
name N karakterlánc Az ügynök neve.
displayName N karakterlánc Az ügynök emberbarát megjelenítendő neve.
description N karakterlánc Az ügynök leírása.
kind N karakterlánc Az ügynök típusa. Kizárólag az hosted támogatott.
env N objektum Környezeti változók kulcs/érték párként. A változóneveknek egyeznie ^[A-Za-z_][A-Za-z0-9_]*$kell .
deployments N tömb Modelltelepítések az ügynökhöz. Lásd az ügynökmodell üzembe helyezését.
codeConfiguration N objektum Helyezze üzembe az ügynököt a forrásból tárolólemezkép helyett. Lásd az ügynökkód konfigurációját.
container N objektum Az ügynök tárolóerőforrás-beállításai. Lásd : Ügynöktároló-erőforrások.
startupCommand N karakterlánc Az ügynökkiszolgálót helyileg elindító parancs, például python main.py. Használja: azd ai agent run.
resources N tömb Külső erőforrások az ügynök végrehajtásához. Minden elem rendelkezik azonosítóval resource és egy connectionName.
toolConnections N tömb A kiépítés során létrehozott külső szolgáltatásokkal (MCP-eszközökkel, A2A-kkal, egyéni API-kkal) létesített kapcsolatok. Tekintse meg a bővítménysémát.
toolboxes N tömb Üzembe helyezendő eszközkészletek (Foundry Toolsets). Tekintse meg a bővítménysémát.
connections N tömb Project Bicep kiépítésen keresztül létrehozandó kapcsolatokat. Tekintse meg a bővítménysémát.
memoryStores N tömb Az öntödei memóriatárolók lehetővé teszik, hogy az ügynök a munkamenetek során megőrizze a környezetet. Tekintse meg a bővítménysémát.
policies N tömb Az ügynökhöz csatolt irányítási szabályzatok, például a Felelős AI. Tekintse meg a bővítménysémát.
protocols N tömb Az ügynök által implementálható meghívási protokollok, például responses: vagy invocationsa2a.
agentEndpoint N objektum Ügynökvégpont konfigurációja, például protokollok, verzióválasztás és hitelesítés.
agentCard N objektum Az ügynök A2A felderítési metaadatai.
metadata N objektum Az ügynök metaadatkulcs-/értékpárjai.
inputSchema N objektum Az ügynök bemeneti sémája.
outputSchema N objektum Az ügynök kimeneti sémája.
Ügynökmodell üzembe helyezései

A upsert minden eleme deployments modelltelepítést készít.

Property Szükséges Típus Leírás
name Y karakterlánc A modell üzembe helyezésének neve.
model Y objektum A modell konfigurációja: name, formatés version (minden szükséges).
sku Y objektum A termékváltozat konfigurációja: name és capacity (mindkettő szükséges).
Ügynökkód konfigurálása

Ha codeConfiguration jelen van, az ügynök a tárolórendszerkép helyett a forrásból (ZIP) lesz üzembe helyezve.

Property Szükséges Típus Leírás
runtime Y karakterlánc A futtatókörnyezet azonosítója, például python_3_12 vagy dotnet_9.
entryPoint Y karakterlánc Az ügynök forrásának belépési pontja.
dependencyResolution N karakterlánc A függőségfeloldási mód, például bundled a remote_build.
Ügynöktároló erőforrásai

Az container objektum beágyazott objektumon keresztül állítja be a resources számítási erőforrásokat.

Property Szükséges Típus Leírás
cpu N karakterlánc A CPU-foglalás, például 1 vagy 500m.
memory N karakterlánc A memória lefoglalása, például 1Gi vagy 512Mi. 
services:
  myagent:
    project: ./src/agent
    host: azure.ai.agent
    language: python
    name: support-agent
    displayName: Support Agent
    kind: hosted
    env:
      LOG_LEVEL: info
    deployments:
      - name: gpt-4o
        model:
          name: gpt-4o
          format: OpenAI
          version: "2024-08-06"
        sku:
          name: GlobalStandard
          capacity: 50
    codeConfiguration:
      runtime: python_3_12
      entryPoint: main.py
      dependencyResolution: remote_build
    container:
      resources:
        cpu: "1"
        memory: 2Gi

Egyéb Microsoft Öntödei gazdagépek

Az alábbi deklaratív gazdagépek a bővítménysémákból azd veszik át a tulajdonságaikat. Nem hozhat létre és nem telepíthet hozzájuk kódot. Mindegyik deklarál egy támogató öntödei erőforrást, amely kiépít azd . A szolgáltatáskulcs az erőforrás neve. A teljes tulajdonságkészletért tekintse meg az egyes gazdagépek sémáját.

Host Kulcstulajdonságok Schema
microsoft.foundry (örökölt) endpoint, deployments, connections, toolboxesskills, routinesagents microsoft.foundry.json
azure.ai.project \, \, \ azure.ai.project.json
azure.ai.connection category, target, authType, credentialsmetadata azure.ai.connection.json
azure.ai.toolbox description, tools azure.ai.toolbox.json
azure.ai.skill \, \, \ azure.ai.skill.json
azure.ai.routine description, enabled, triggersaction azure.ai.routine.json 
services:
  # Foundry project that owns model deployments
  project:
    host: azure.ai.project
    deployments:
      - name: gpt-4o
        model:
          name: gpt-4o
          format: OpenAI
          version: "2024-08-06"
        sku:
          name: GlobalStandard
          capacity: 50
  # Connection referenced by tools (service key is the connection name)
  my-search:
    host: azure.ai.connection
    uses:
      - project
    category: CognitiveSearch
    target: https://my-search.search.windows.net
    authType: ApiKey

Szolgáltatási kapcsolók

A szolgáltatásszintű horgok a szolgáltatás életciklus-eseményei során futnak. A horgoknak meg kell egyeznie a szolgáltatásesemények előtagjával vagy pre.post Az elérési utak megadásakor a szolgáltatás elérési úthoz kell viszonyítani. További részletekért lásd Azure Developer CLI-munkafolyamatok testreszabása parancs- és eseményhookok használatával.

Támogatott szolgáltatáshookok: prerestore, postrestore, prebuild, postbuild, prepackage, postpackageprepublish, postpublish, , predeploy. postdeploy

Minden horog a Hook definíciós formátumot használja.

Szolgáltatásminták

Tárolóalkalmazások Docker-beállításokkal
services:
  api:
    project: ./src/api
    language: js
    host: containerapp
    docker:
      path: ./Dockerfile
      context: ../
  web:
    project: ./src/web
    language: js
    host: containerapp
    docker:
      remoteBuild: true
Tárolóalkalmazások előre összeállított rendszerképből
services:
  api:
    image: myregistry.azurecr.io/myapp:latest
    host: containerapp
AKS szolgáltatási szintű horgokkal
services:
  web:
    project: ./src/web
    dist: build
    language: js
    host: aks
    hooks:
      postdeploy:
        shell: sh
        run: azd env set REACT_APP_WEB_BASE_URL ${SERVICE_WEB_ENDPOINT_URL}
  api:
    project: ./src/api
    language: js
    host: aks
    k8s:
      ingress:
        relativePath: api
    hooks:
      postdeploy:
        shell: sh
        run: azd env set REACT_APP_API_BASE_URL ${SERVICE_API_ENDPOINT_URL}

resources

(objektum) Az alkalmazás által használt Azure-erőforrások meghatározása. Minden kulcs egy erőforrásnév, az érték pedig egy erőforráskonfigurációs objektum. Az erőforrásokra a szolgáltatások a uses tulajdonságon keresztül hivatkozhatnak.

Gyakori erőforrás-tulajdonságok

Property Szükséges Típus Leírás
type Y karakterlánc Az erőforrás típusa. Lásd : Erőforrástípusok.
uses N tömb Egyéb erőforrások, amelyektől ez az erőforrás függ.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

Tip

A több erőforrástípust kombináló teljes YAML-példáért tekintse meg az Erőforrások mintát .

Erőforrástípusok

A type tulajdonság határozza meg az Azure-erőforrás fajtáját, és meghatározza, hogy mely további tulajdonságok érhetők el.

Típusérték Leírás További tulajdonságok
host.appservice Azure App Service webalkalmazás Lásd ahost.appservice tulajdonságokat.
host.containerapp Docker-alapú tárolóalkalmazás Lásd ahost.containerapp tulajdonságokat.
ai.openai.model Üzembe helyezett, használatra kész AI-modell Lásd aai.openai.model tulajdonságokat.
ai.project Microsoft Foundry-projekt modellekkel Lásd aai.project tulajdonságokat.
ai.search Azure AI Keresés Lásd aai.search tulajdonságokat.
db.postgres Azure Database for PostgreSQL Nincs további tulajdonság.
db.mysql Azure Database for MySQL Nincs további tulajdonság.
db.redis Azure Cache for Redis Nincs további tulajdonság.
db.mongo Azure Cosmos DB for MongoDB Nincs további tulajdonság.
db.cosmos Azure Cosmos DB for NoSQL Lásd adb.cosmos tulajdonságokat.
messaging.eventhubs Azure Event Hubs névtér Lásd amessaging.eventhubs tulajdonságokat.
messaging.servicebus Azure Service Bus névtér Lásd amessaging.servicebus tulajdonságokat.
storage Azure Storage fiók Lásd astorage tulajdonságokat.
keyvault Azure Key Vault Lásd akeyvault tulajdonságokat.

host.appservice tulajdonságok

Property Szükséges Típus Leírás
port N egész szám Port, amelyen a webalkalmazás figyel. Alapértelmezett: 80.
runtime Y objektum A nyelvi futtatókörnyezet konfigurációja. Lásd alább.
env N tömb Környezeti változók. Minden elem rendelkezik name (kötelező) valueés secret tulajdonságokkal. Támogatja a környezeti változók helyettesítését.
startupCommand N karakterlánc A webalkalmazás indításakor futó indítási parancs.
uses N sztringek tömbje Az erőforrás által használt egyéb erőforrások.

runtime Objektum:

Property Szükséges Típus Leírás
stack Y karakterlánc A nyelvi futtatókörnyezeti verem. Engedélyezett értékek: node, python.
version Y karakterlánc A nyelvi futtatókörnyezet verziója. A formátum verem szerint változik (például 22-lts a Node esetében a 3.13 Python esetében). 
resources:
  web:
    type: host.appservice
    port: 8080
    runtime:
      stack: node
      version: 22-lts
    uses:
      - db

host.containerapp tulajdonságok

Property Szükséges Típus Leírás
port N egész szám Port, amelyen a tárolóalkalmazás figyel. Alapértelmezett: 80.
env N tömb Környezeti változók. Minden elem rendelkezik name (kötelező) valueés secret tulajdonságokkal. Támogatja a környezeti változók helyettesítését.
uses N sztringek tömbje Az erőforrás által használt egyéb erőforrások.

ai.openai.model tulajdonságok

Property Szükséges Típus Leírás
model Conditional objektum A mögöttes AI-modell. Kötelező, ha existing van false.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

model Objektum:

Property Szükséges Típus Leírás
name Y karakterlánc Az AI-modell neve.
version Y karakterlánc Az AI-modell verziója. 
resources:
  chatModel:
    type: ai.openai.model
    model:
      name: gpt-4o
      version: "2024-08-06"

ai.project tulajdonságok

Property Szükséges Típus Leírás
models N tömb Az AI-projekt részeként üzembe helyezendő AI-modellek.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

models tömbelemek:

Property Szükséges Típus Leírás
name Y karakterlánc Az AI-modell neve.
version Y karakterlánc Az AI-modell verziója.
format Y karakterlánc Az AI-modell formátuma (például Microsoft, OpenAI).
sku Y objektum Az AI-modell termékváltozat-konfigurációja.

sku Objektum:

Property Szükséges Típus Leírás
name Y karakterlánc A termékváltozat neve (például GlobalStandard).
usageName Y karakterlánc A termékváltozat számlázási célú használati neve (például OpenAI.GlobalStandard.gpt-4o-mini).
capacity Y egész szám A termékváltozat kapacitása.

ai.search tulajdonságok

Property Szükséges Típus Leírás
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

db.cosmos tulajdonságok

Property Szükséges Típus Leírás
containers N tömb Tárolók az adatok tárolásához. Minden tároló egy-egy elemgyűjteményt tárol.

containers tömbelemek:

Property Szükséges Típus Leírás
name Y karakterlánc A tároló neve.
partitionKeys Y tömb Az adatok partíciók közötti elosztásához használt partíciókulcs(ok). Legfeljebb 3 kulcs. Alapértelmezett: /id.

messaging.eventhubs tulajdonságok

Property Szükséges Típus Leírás
hubs N sztringek tömbje Az Event Hubs-névtérben létrehozandó hubnevek.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

messaging.servicebus tulajdonságok

Property Szükséges Típus Leírás
queues N sztringek tömbje A Service Bus-névtérben létrehozandó üzenetsornevek.
topics N sztringek tömbje A Service Bus-névtérben létrehozandó témakörnevek.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

storage tulajdonságok

Property Szükséges Típus Leírás
containers N sztringek tömbje Azure Storage-fiók tárolónevei.
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

keyvault tulajdonságok

Property Szükséges Típus Leírás
existing N boolean Ha be van trueállítva, ez az erőforrás nem jön létre, hanem hivatkozási célokra lesz használva. Alapértelmezett: false.

Erőforrásminta

resources:
  db:
    type: db.postgres
  cache:
    type: db.redis
  chatModel:
    type: ai.openai.model
    model:
      name: gpt-4o
      version: "2024-08-06"
  web:
    type: host.containerapp
    port: 3100
    uses:
      - db
      - chatModel

pipeline

(objektum) folyamatos integrációs folyamat definíciója.

Property Szükséges Típus Leírás
provider N karakterlánc A folyamatos integrációhoz használandó folyamatszolgáltató. Alapértelmezett: github. Engedélyezett értékek: github, azdo.
variables N sztringek tömbje azd A folyamatban változóként használandó környezeti változók listája.
secrets N sztringek tömbje azd A folyamatban titkos kódként használandó környezeti változók listája. 
pipeline:
  provider: azdo
  variables:
    - CUSTOM_SETTING
  secrets:
    - API_KEY

hooks

(objektum) Parancsszintű horgok. A horgoknak azd parancsneveknek pre vagy post előtaggal kell egyeznie attól függően, hogy mikor kell végrehajtani a szkriptet. Az elérési utak megadásakor a projekt elérési úthoz kell viszonyítani. További részletekért lásd Azure Developer CLI-munkafolyamatok testreszabása parancs- és eseményhookok használatával.

Támogatott parancshookok: preprovision, postprovision, preinfracreate, postinfracreate, preinfradelete, postinfradelete, predownpostdown, , preup, , postupprepackage, postpackageprepublishpostpublishpredeploypostdeployprerestore. postrestore

Minden horog a Hook definíciós formátumot használja.

Tip

A teljes YAML-példákért tekintse meg a horogmintákat , beleértve a platformspecifikus horgokat, a gépelt végrehajtókat és az eseményenként több horogot.

hooks:
  preprovision:
    shell: sh
    run: ./scripts/setup.sh
  postdeploy:
    shell: sh
    run: azd env set APP_URL ${SERVICE_WEB_ENDPOINT_URL}

Horogdefiníció

A horog lehet egyetlen horogobjektum vagy egy horogobjektum tömbje. Minden horogobjektum a következő tulajdonságokkal rendelkezik:

Property Szükséges Típus Leírás
run Conditional karakterlánc A szkript beágyazott szkriptje vagy relatív elérési útja. A , , shellkinddirinteractivecontinueOnErrorvagy .secretsconfig A fájlelérési utak esetében a rendszer automatikusan a fájlkiterjesztésből következtet a rendszerhéjra.
shell N karakterlánc Szkriptek végrehajtásához a rendszerhéj típusa. Opcionális. Ha nincs megadva, azd az operációs rendszer alapján kiválaszt egy alapértelmezettet: pwsh Windows sh és Linux és macOS rendszeren, és egy explicit értéket javasoló figyelmeztetést nyomtat ki. Engedélyezett értékek: sh, pwsh.
kind N karakterlánc Végrehajtó típusú a horog szkript. Ha nincs megadva, a rendszer automatikusan észleli a típust az run elérési út fájlkiterjesztéséből (például .py válik, python válik.ps1).pwsh Engedélyezett értékek: sh, pwsh, js, ts, python, dotnet.
dir N karakterlánc Munkakönyvtár a horogvégrehajtáshoz. A függőségek telepítésének projektgyökérként és munkakönyvtárként használatos a szkript futtatásakor. A relatív elérési utak feloldása a projekt vagy a szolgáltatás gyökeréből lesz feloldva. Ha nincs megadva, a szkriptfájlt tartalmazó könyvtár alapértelmezett értéke.
continueOnError N boolean Azt jelzi, hogy egy szkripthiba leállítja-e a azd parancsot. Alapértelmezett: false.
interactive N boolean Azt jelzi, hogy a szkript interaktív módban fut-e, a kötés a következőhöz stdinstdoutés stderr a futó konzolhoz. Alapértelmezett: false.
windows N objektum Ha meg van adva, felülbírálja a horogkonfigurációt a Windows-környezetekben történő végrehajtáskor. Ugyanazt a horogobjektum-formátumot használja.
posix N objektum Ha meg van adva, felülbírálja a horogkonfigurációt a POSIX (Linux és macOS) környezetekben történő végrehajtáskor. Ugyanazt a horogobjektum-formátumot használja.
secrets N objektum A környezeti változók térképe azd a titkos kulcsok összekapcsolásához. Ha egy változót titkos kódként állítottak be a környezetben, a titkos érték a horognak lesz átadva.
config N objektum Végrehajtóspecifikus konfiguráció. Az elérhető tulajdonságok az kind értéktől függenek. Lásd : Hook-végrehajtó konfigurációja.

Note

Ha mindkettő windows meg posix van adva, a run, shell, kind, dir, interactive, continueOnError, secretsés config tulajdonságok nem használhatók a legfelső szinten. Használja inkább a platformspecifikus objektumokat.

A hook-végrehajtó konfigurációja

A config tulajdonság az értéktől függően kind különböző tulajdonságokat fogad el.

JavaScript és TypeScript (js, ts) konfiguráció

Property Szükséges Típus Leírás
packageManager N karakterlánc A függőségek telepítéséhez használni kívánt csomagkezelő. Felülbírálja a zárolási fájlok automatikus észlelését. Engedélyezett értékek: npm, pnpm, yarn.

Python-konfiguráció

Property Szükséges Típus Leírás
virtualEnvName N karakterlánc A Python virtuális környezet könyvtárneve. Az automatikus észlelés (.venv, venv) vagy {baseName}_enva .

.NET (dotnet) konfiguráció

Property Szükséges Típus Leírás
configuration N karakterlánc Az MSBuild konfigurációja a horogszkript létrehozásához (például Debug, Release).
framework N karakterlánc A horogszkript létrehozására és futtatására szolgáló cél-keretrendszer-moniker (például net8.0, net10.0).

Rendszerhéj (sh, pwsh) konfigurációja

A rendszerhéj-végrehajtók jelenleg nem támogatják a config tulajdonságokat.

Horogminták

Platformspecifikus horgok

hooks:
  preprovision:
    windows:
      shell: pwsh
      run: ./scripts/setup.ps1
    posix:
      shell: sh
      run: ./scripts/setup.sh

Python-horog kedvesen

hooks:
  postprovision:
    kind: python
    run: ./scripts/seed-data.py
    dir: ./scripts
    config:
      virtualEnvName: .venv

Több horog egyetlen eseményhez

hooks:
  postprovision:
    - shell: sh
      run: ./scripts/step1.sh
    - shell: sh
      run: ./scripts/step2.sh

requiredVersions

(objektum) További konfigurációt biztosít a szükséges verziókhoz azd és bővítményekhez.

Property Szükséges Típus Leírás
azd N karakterlánc A projekthez tartozó azd számos támogatott verziója. Ha a verzió ezen azd a tartományon kívül esik, a projekt nem töltődik be. Támogatja a szemvertartomány szintaxisát.
extensions N objektum A projekthez szükséges bővítmények és verziókorlátozások térképe. Támogatja a szemver-korlátozásokat. Ha a verzió nincs megadva, a legújabb verzió lesz telepítve. 
requiredVersions:
  azd: ">= 0.6.0-beta.3"
  extensions:
    azure.ai.agents: ">=1.0.0-beta.8"
    my-extension: latest

state

(objektum) További konfigurációt biztosít az állapotkezeléshez.

Property Szükséges Típus Leírás
remote N objektum További konfigurációt biztosít a távoli állapotkezeléshez. Lásd a(z) state.remote.

state.remote

Property Szükséges Típus Leírás
backend Y karakterlánc A távoli állapot háttérrendszerének típusa. Alapértelmezett: AzureBlobStorage. Engedélyezett értékek: AzureBlobStorage.
config Conditional objektum Háttérspecifikus konfiguráció. Kötelező, ha backend van AzureBlobStorage. Lásd: Azure Blob Storage-konfiguráció.

Azure Blob Storage-konfiguráció

Property Szükséges Típus Leírás
accountName Y karakterlánc Az Azure Storage fiók neve.
containerName N karakterlánc Az Azure Storage-tároló neve. Ha nincs megadva, a projektnév alapértelmezett értéke.
endpoint N karakterlánc Az Azure Storage-végpont. Alapértelmezett: blob.core.windows.net. 
state:
  remote:
    backend: AzureBlobStorage
    config:
      accountName: mystorageaccount
      containerName: azd-state

platform

(objektum) További konfigurációt biztosít a platformspecifikus funkciókhoz, például az Azure Dev Centerhez.

Property Szükséges Típus Leírás
type Y karakterlánc A platform típusa. Engedélyezett értékek: devcenter.
config N objektum Platformspecifikus konfiguráció. Lásd a Dev Center konfigurációját.

Fejlesztői központ konfigurációja

Akkor érhető el, hatype:devcenter

Property Szükséges Típus Leírás
name N karakterlánc Az Azure Dev Center neve. A projekt alapértelmezett fejlesztői központjaként használatos.
project N karakterlánc Az Azure Dev Center-projekt neve.
catalog N karakterlánc Az Azure Dev Center-katalógus neve.
environmentDefinition N karakterlánc A Dev Center katalóguskörnyezet-definíciójának neve.
environmentType N karakterlánc Az üzembe helyezési környezethez használt Dev Center projektkörnyezet típusa. 
platform:
  type: devcenter
  config:
    name: my-devcenter
    project: my-project
    catalog: my-catalog
    environmentDefinition: my-env-def
    environmentType: dev

workflows

(objektum) További konfigurációt biztosít a munkafolyamatokhoz, például a felülbírálási viselkedéshez azd up .

Property Szükséges Típus Leírás
up N objektum vagy tömb Ha meg van adva, felülbírálja a munkafolyamat alapértelmezett viselkedését azd up .

Munkafolyamat lépései

A up munkafolyamat elfogad egy tömböt steps (vagy közvetlenül tömbként is megadható). Minden lépés futtat egy azd parancsot.

Property Szükséges Típus Leírás
azd Y sztring vagy objektum A azd végrehajtandó parancs. Lehet sztring (például provision) vagy tömböt tartalmazó args objektum.

Munkafolyamat-lépéssorrend konfigurálása

Az alábbi azure.yaml fájl megváltoztatja a lépés lépés utáni áthelyezésének azd upazd package alapértelmezett viselkedésétazd provision. Ezt a megközelítést olyan helyzetekben használhatja, ahol ismernie kell az erőforrások URL-címeit a buildelési vagy csomagolási folyamat során.

name: todo-nodejs-mongo
metadata:
  template: todo-nodejs-mongo@0.0.1-beta
workflows:
  up:
    steps:
      - azd: provision
      - azd: package
      - azd: deploy --all

cloud

(objektum) További konfigurációt biztosít a független felhőkben, például az Azure Governmentben való üzembe helyezéshez. Az alapértelmezett felhő a .AzureCloud

Property Szükséges Típus Leírás
name N karakterlánc A felhőkörnyezet neve. Engedélyezett értékek: AzureCloud, AzureChinaCloud, AzureUSGovernment. 
cloud:
  name: AzureUSGovernment

Segítség kérése

Ha tudni szeretné, hogyan nyújthat be hibát, kérhet segítséget vagy javasolhat új funkciót az Azure Developer CLI-hez, látogasson el a hibaelhárítási és támogatási oldalra.

Következő lépések

  • Last updated on