Sdílet prostřednictvím

Parametry a datové typy v environment.yaml

  • Článek

Definice prostředí ADE jsou infrastruktura jako kód (IaC), napsaná v Bicep nebo Terraformu, uložená v úložištích. Definice prostředí je možné upravit a přizpůsobit vašim konkrétním požadavkům a pak použít k vytvoření prostředí nasazení v Azure. Schéma environment.yaml definuje a popisuje typy prostředků Azure zahrnutých v definicích prostředí.

Co je environment.yaml?

Soubor environment.yaml funguje jako manifest, který popisuje použité prostředky a umístění šablony pro definici prostředí.

Ukázkové prostředí.yaml

Následující skript je obecný příklad souboru environment.yaml vyžadovaného pro vaši definici prostředí.

name: WebApp
version: 1.0.0
summary: Azure Web App Environment
description: Deploys a web app in Azure without a datastore
runner: ARM
templatePath: azuredeploy.json

Definice

Následující tabulka popisuje vlastnosti, které můžete použít v environment.yaml.

Vlastnost Typ Popis Povinní účastníci Příklady
name řetězec Zobrazovaný název položky katalogu. Ano
version řetězec Verze položky katalogu. 1.0.0
Souhrn řetězec Krátký souhrnný řetězec o položce katalogu.
description řetězec Popis položky katalogu.
Běžec řetězec Image kontejneru, která se má použít při provádění akcí. Šablona
ARM – Terraform
templatePath řetězec Relativní cesta k souboru šablony položky. Ano
main.tf main.bicep
azuredeploy.json
parameters pole Vstupní parametry, které se mají použít při vytváření prostředí a provádění akcí. #/definitions/Parameter

Parametry v environment.yaml

Parametry umožňují opakovaně používat definici prostředí v různých scénářích. Můžete například chtít, aby vývojáři v různých oblastech nasadí stejné prostředí. Můžete definovat parametr umístění, který vyzve vývojáře, aby při vytváření svého prostředí zadal požadované umístění.

Ukázkový environment.yaml s parametry

Následující skript je příkladem souboru environment.yaml, který obsahuje dva parametry; location a name:

name: WebApp
summary: Azure Web App Environment
description: Deploys a web app in Azure without a datastore
runner: ARM
templatePath: azuredeploy.json
parameters:
- id: "location"
  name: "location"
  description: "Location to deploy the environment resources"
  default: "[resourceGroup().location]"
  type: "string"
  required: false
- id: "name"
  name: "name"
  description: "Name of the Web App "
  default: ""
  type: "string"
  required: false

Definice parametrů

Následující tabulka popisuje datové typy, které můžete použít v environment.yaml. Názvy datových typů používané v souboru manifestu environment.yaml se liší od názvů použitých v šablonách ARM.

Každý parametr může používat některou z následujících vlastností:

Vlastnosti Typ Popis Další Nastavení
ID řetězec Jedinečné ID parametru.
name řetězec Zobrazovaný název parametru.
description řetězec Popis parametru
default array
boolean
integer
number
object
string		 Výchozí hodnota parametru.
type array
boolean
integer
number
object
string		 Datový typ parametru. Tento datový typ musí odpovídat datovému typu parametru v šabloně ARM, souboru BICEP nebo souboru Terraformu s odpovídajícím názvem parametru. Výchozí typ: řetězec
Readonly boolean Určuje, jestli je tento parametr jen pro čtení.
povinné boolean Určuje, zda je tento parametr povinný.
Povoleno pole Pole povolených hodnot. "items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true,

Schéma YAML

Pro soubory environment.yaml azure deployment environment.yaml je definované schéma, které může usnadnit úpravy těchto souborů. Definici schématu můžete přidat na začátek souboru environment.yaml:

# yaml-language-server: $schema=https://github.com/Azure/deployment-environments/releases/download/2022-11-11-preview/manifest.schema.json

Tady je příklad definice prostředí, která používá schéma:

# yaml-language-server: $schema=https://github.com/Azure/deployment-environments/releases/download/2022-11-11-preview/manifest.schema.json
name: FunctionApp
version: 1.0.0
summary: Azure Function App Environment
description: Deploys an Azure Function App, Storage Account, and Application Insights
runner: ARM
templatePath: azuredeploy.json

parameters:
  - id: name
    name: Name
    description: 'Name of the Function App.'
    type: string
    required: true

  - id: supportsHttpsTrafficOnly
    name: 'Supports Https Traffic Only'
    description: 'Allows https traffic only to Storage Account and Functions App if set to true.'
    type: boolean

  - id: runtime
    name: Runtime
    description: 'The language worker runtime to load in the function app.'
    type: string
    allowed:
      - 'dotnet'
      - 'dotnet-isolated'
      - 'java'
      - 'node'
      - 'powershell'
      - 'python'
    default: 'dotnet-isolated'

Související obsah