You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-developer-cli/azd-schema.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ ms.service: azure-dev-cli
15
15
16
16
## Sample
17
17
18
-
Below is a generic example of an `azure.yaml` required for your `azd` template.
18
+
The following is a generic example of an `azure.yaml` required for your `azd` template.
19
19
20
20
```yaml
21
21
name: yourApp
@@ -52,13 +52,13 @@ services:
52
52
| Element Name | Required | Description |
53
53
| ------------ | -------- | ----------- |
54
54
| `name` | Y | _(string)_ Name of the application. |
55
-
| `resourceGroup` | N | _(string)_ Name of the Azure resource group. When specified, will override the resource group name used for infrastructure provisioning. |
55
+
| `resourceGroup` | N | _(string)_ Name of the Azure resource group. When specified, overrides the resource group name used for infrastructure provisioning. |
56
56
| `metadata` | N | _(object)_ See [metadata properties](#metadata-properties) for more details. |
57
57
| `infra` | N | _(object)_ Provides extra configuration for Azure infrastructure provisioning. See [infra properties](#infra-properties) for more details. |
58
58
| `services` | Y | _(object)_ Definition of services that comprise the application. See [services properties](#services-properties) for more details. |
59
59
| `pipeline` | N | _(object)_ Definition of continuous integration pipeline. See [pipeline properties](#pipeline-properties) for more details. |
60
-
| `hooks` | N | Command level hooks. Hooks should match `azd` command names prefixed with `pre` or `post` depending on when the script should execute. When specifying paths they should be relative to the project path. See [Customize your Azure Developer CLI workflows using command and event hooks](./azd-extensibility.md) for more details. |
61
-
| `requiredVersions` | N |A range of supported versions of `azd` for this project. If the version of `azd` is outside this range, the project will fail to load. Optional (allows all versions if absent). Example: `>= 0.6.0-beta.3`|
60
+
| `hooks` | N | Command level hooks. Hooks should match `azd` command names prefixed with `pre` or `post` depending on when the script should execute. When specifying paths, they should be relative to the project path. See [Customize your Azure Developer CLI workflows using command and event hooks](./azd-extensibility.md) for more details. |
61
+
| `requiredVersions` | N |A range of supported versions of `azd` for this project. If the version of `azd` is outside this range, the project fails to load. Optional (allows all versions if absent). Example: `>= 0.6.0-beta.3`|
62
62
63
63
### `metadata` properties
64
64
@@ -70,7 +70,7 @@ services:
70
70
71
71
| Element Name | Required | Description | Example |
72
72
| --- | --- | --- | --- |
73
-
| `provider` | N | _(string)_ The infrastructure provider for the application's Azure resources. (Default: bicep). | See the [Terraform sample](#terraform-as-iac-provider-sample) below. `bicep`, `terraform` |
73
+
| `provider` | N | _(string)_ The infrastructure provider for the application's Azure resources. (Default: bicep). | See the [Terraform sample](#terraform-as-iac-provider-sample). `bicep`, `terraform` |
74
74
| `path` | N | _(string)_ The relative folder path to the location containing Azure provisioning templates for the specified provider. (Default: infra). | |
75
75
| `module` | N | _(string)_ The name of the default module withing the Azure provisioning templates. (Default: main). | |
76
76
@@ -98,15 +98,15 @@ infra:
98
98
99
99
| Element Name | Required | Description | Example |
100
100
| --- | --- | --- | --- |
101
-
| `resourceName` | N | _(string)_ Name of the Azure resource that implements the service. If not specified, `azd` will look for a resource by `azd-env-name` and `azd-service-name` tags. If not found, it will look for a resource name constructed from the current environment name, concatenated with the service name (`<environment-name><resource-name>`). | `prodapi` |
101
+
| `resourceName` | N | _(string)_ Name of the Azure resource that implements the service. If not specified, `azd` looks for a resource by `azd-env-name` and `azd-service-name` tags. If not found, it looks for a resource name constructed from the current environment name, concatenated with the service name (`<environment-name><resource-name>`). | `prodapi` |
102
102
| `project` | Y | _(string)_ Path to the service source code directory. | |
103
-
| `host` | Y | _(string)_ Type of Azure resource used for service implementation. If omitted, App Service will be assumed. | `appservice`, `containerapp`, `function`, `staticwebapp`, `aks` (only for projects deployable via `kubectl apply -f`), `springapp` (when [enabled](https://aka.ms/azd-may-2023) - learn more about [alpha features](./feature-versioning.md#alpha-features)) |
103
+
| `host` | Y | _(string)_ Type of Azure resource used for service implementation. If omitted, App Service is assumed. | `appservice`, `containerapp`, `function`, `staticwebapp`, `aks` (only for projects deployable via `kubectl apply -f`), `springapp` (when [enabled](https://aka.ms/azd-may-2023) - learn more about [alpha features](./feature-versioning.md#alpha-features)) |
104
104
| `language` | Y | _(string)_ Service implementation language. | `dotnet`, `csharp`, `fsharp`, `py`, `python`, `js`, `ts`, `java` |
105
-
| `module` | Y | _(string)_ Path of the infrastructure module used to deploy the service relative to the root infra folder. If omitted, the CLI will assume the module name is the same as the service name. | |
106
-
| `dist` | Y | _(string)_ Relative path to the service deployment artifacts. The CLI will use files under this path to create the deployment artifact (.zip file). If omitted, all files under the service project directory will be included. | `build` |
107
-
| `docker` | N | Only applicable when `host` is `containerapp`. Can't contain extra properties. | See the [custom Docker sample](#docker-options-sample) below. `path` _(string)_: Path to the Dockerfile. Default: `./Dockerfile`; `context` _(string)_: The docker build context. When specified, overrides default context. Default: `.`; `platform` _(string)_: The platform target. Default: `amd64`; `remoteBuild` _(boolean)_: Enables remote ACR builds. Default: `false` |
108
-
| `k8s` | N | The Azure Kubernetes Service (AKS) configuration options. | See the [AKS sample](#aks-sample-with-service-level-hooks) below. `deploymentPath` _(string)_: Optional. The relative path from the service path to the k8s deployment manifests. When set, it will override the default deployment path location for k8s deployment manifests. Default: `manifests`; `namespace` _(string)_: Optional. The k8s namespace of the deployed resources. When specified, a new k8s namespace will be created if it does not already exist. Default: `Project name`; `deployment` _(object)_: See [deployment properties](#aks-deployment-properties); `service` _(object)_: See [service properties](#aks-service-properties); `ingress` _(object)_: See [ingress properties](#aks-ingress-properties). |
109
-
| `hooks` | N | Service level hooks. Hooks should match `service` event names prefixed with `pre` or `post` depending on when the script should execute. When specifying paths they should be relative to the service path. | See [Customize your Azure Developer CLI workflows using command and event hooks](./azd-extensibility.md) for more details. |
105
+
| `module` | Y | _(string)_ Path of the infrastructure module used to deploy the service relative to the root infra folder. If omitted, the CLI assumes the module name is the same as the service name. | |
106
+
| `dist` | Y | _(string)_ Relative path to the service deployment artifacts. The CLI uses files under this path to create the deployment artifact (.zip file). If omitted, all files under the service project directory are included. | `build` |
107
+
| `docker` | N | Only applicable when `host` is `containerapp`. Can't contain extra properties. | See the [custom Docker sample](#docker-options-sample). `path` _(string)_: Path to the Dockerfile. Default: `./Dockerfile`; `context` _(string)_: The docker build context. When specified, overrides default context. Default: `.`; `platform` _(string)_: The platform target. Default: `amd64`; `remoteBuild` _(boolean)_: Enables remote ACR builds. Default: `false` |
108
+
| `k8s` | N | The Azure Kubernetes Service (AKS) configuration options. | See the [AKS sample](#aks-sample-with-service-level-hooks). `deploymentPath` _(string)_: Optional. The relative path from the service path to the K8s deployment manifests. When set, it overrides the default deployment path location for K8s deployment manifests. Default: `manifests`; `namespace` _(string)_: Optional. The K8s namespace of the deployed resources. When specified, a new K8s namespace is created if it doesn't already exist. Default: `Project name`; `deployment` _(object)_: See [deployment properties](#aks-deployment-properties); `service` _(object)_: See [service properties](#aks-service-properties); `ingress` _(object)_: See [ingress properties](#aks-ingress-properties). |
109
+
| `hooks` | N | Service level hooks. Hooks should match `service` event names prefixed with `pre` or `post` depending on when the script should execute. When you specify paths, they should be relative to the service path. | See [Customize your Azure Developer CLI workflows using command and event hooks](./azd-extensibility.md) for more details. |
110
110
| `apiVersion` | N | Specify an explicit `api-version` when deploying services hosted by Azure Container Apps (ACA). This feature helps you avoid using an incompatible API version and makes deployment more loosely coupled to avoid losing custom configuration data during JSON marshaling to a hard-coded Azure SDK library version. | `apiVersion: 2024-02-02-preview` |
111
111
112
112
#### Docker options sample
@@ -137,20 +137,20 @@ services:
137
137
138
138
| Element Name | Required | Description | Example |
139
139
| --- | --- | --- | --- |
140
-
| `name` | N | _(string)_ Optional. The name of the k8s deployment resource to use during deployment. Used during deployment to ensure if the k8s deployment rollout has been completed. If not set, will search for a deployment resource in the same namespace that contains the service name. Default: `Service name`| `api` |
140
+
| `name` | N | _(string)_ Optional. The name of the K8s deployment resource to use during deployment. Used during deployment to ensure if the K8s deployment rollout completed. If not set, searches for a deployment resource in the same namespace that contains the service name. Default: `Service name`| `api` |
141
141
142
142
### AKS `service` properties
143
143
144
144
| Element Name | Required | Description | Example |
145
145
| --- | --- | --- | --- |
146
-
| `name` | N | _(string)_ Optional. The name of the k8s service resource to use as the default service endpoint. Used when determining endpoints for the default service resource. If not set, will search for a deployment resource in the same namespace that contains the service name. (Default: Service name) | `api` |
146
+
| `name` | N | _(string)_ Optional. The name of the K8s service resource to use as the default service endpoint. Used when determining endpoints for the default service resource. If not set, searches for a deployment resource in the same namespace that contains the service name. (Default: Service name) | `api` |
147
147
148
148
### AKS `ingress` properties
149
149
150
150
| Element Name | Required | Description | Example |
151
151
| --- | --- | --- | --- |
152
-
| `name` | N | _(string)_ Optional. The name of the k8s ingress resource to use as the default service endpoint. Used when determining endpoints for the default ingress resource. If not set, will search for a deployment resource in the same namespace that contains the service name. Default: `Service name`| `api` |
153
-
| `relativePath` | N | _(string)_ Optional. The relative path to the service from the root of your ingress controller. When set, will be appended to the root of your ingress resource path. | |
152
+
| `name` | N | _(string)_ Optional. The name of the K8s ingress resource to use as the default service endpoint. Used when determining endpoints for the default ingress resource. If not set, searches for a deployment resource in the same namespace that contains the service name. Default: `Service name`| `api` |
153
+
| `relativePath` | N | _(string)_ Optional. The relative path to the service from the root of your ingress controller. When set, appends to the root of your ingress resource path. | |
0 commit comments