Skip to content

Commit 8544a59

Browse files
committed
fixes
1 parent eeefc2a commit 8544a59

File tree

2 files changed

+12
-16
lines changed

2 files changed

+12
-16
lines changed

articles/azure-developer-cli/environments-overview.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ The Azure Developer CLI (`azd`) lets you manage multiple deployment environments
1515

1616
## What are environments?
1717

18-
An environment in the Azure Developer CLI (`azd`) is a separate deployed copy of your application running in Azure. Different environments can configured with different values. Environments serve several important purposes:
18+
An environment in the Azure Developer CLI (`azd`) is a named set of configurations for a deployment of your app, such as dev, test, or prod. Different environments can be configured with different values. Environments serve several important purposes:
1919

20-
- **Isolation**: Keep development, testing, staging, and production deployments separate.
20+
- **Isolation**: Keep development, testing, and production deployments separate.
2121
- **Configuration management**: Maintain different settings for each environment.
2222
- **Collaboration**: Enable team members to work with their own environments.
23-
- **Resource organization**: Group and provision Azure resources by environment, such as using lower tier services for dev environments.
23+
- **Resource organization**: Group and provision Azure resources by environment.
2424
- **Reproducibility**: Ensure consistent deployments across different stages.
2525

2626
Each environment has its own Azure resource group and configuration settings. This environment isolation helps prevent changes in one environment from affecting others.
@@ -33,10 +33,10 @@ Azure Developer CLI (`azd`) environments live in a directory structure within yo
3333
├── .azure [Created when you run azd init or azd up]
3434
│ ├── <environment-name-1> [Directory for environment-specific configurations]
3535
│ │ ├── .env [Environment variables for this environment]
36-
│ │ └── main.parameters.json [Infrastructure parameters for this environment]
36+
│ │ └── config.json [Additional configuration parameters for this environment]
3737
│ ├── <environment-name-2> [Another environment]
3838
│ │ ├── .env
39-
│ │ └── main.parameters.json
39+
│ │ └── config.json
4040
│ └── config.json [Global azd configuration]
4141
```
4242

@@ -45,32 +45,30 @@ The key components of this structure are:
4545
1. **`.azure` directory**: The root directory for all environment configurations. Excluded from source control by the `.gitignore` file by default.
4646
2. **Environment-specific directories**: Directories named after your environments, such as `dev`, `test`, `prod`.
4747
3. **`.env` file**: Contains environment-specific variables used by your application and during deployment.
48-
4. **`main.parameters.json`**: Contains parameters commonly used during infrastructure provisioning with Bicep or Terraform, but can be used for any per-environment `azd` configuration. This file is not intended to be used directly by end users.
48+
4. **`config.json`**: Used to drive settings that influence `azd` command behavior and features. This file is not intended to be used directly by end users.
4949

5050
### Environment names
5151

52-
The environment name typically follows these patterns:
52+
Environment naming typically follows these patterns:
5353

5454
- Team projects: `<project-name-[dev/int/prod]>`
5555
- Personal projects: `<personal-unique-alias-[dev/int/prod]>`
5656

57-
Environment naming conventions are not enforced by `azd` and are configurable by the user.
57+
These naming conventions are not enforced by `azd` and are configurable by the user.
5858

5959
## Environment variables
6060

6161
Azure Developer CLI [Environment variables](manage-environment-variables.md) provide a way to store configuration settings that influence and might vary between environments. When you run Azure Developer CLI commands, these variables are used to:
6262

63-
- Configure your application's settings
64-
- Define infrastructure parameters
65-
- Store connection strings, endpoints, and secrets
63+
- Configure your application settings, such as endpoints for Azure services.
64+
- Define infrastructure parameters to influence the provisioning process.
6665

6766
The `.env` file contains these variables in a standard format:
6867

6968
```output
7069
AZURE_ENV_NAME=dev
7170
AZURE_LOCATION=eastus
7271
AZURE_SUBSCRIPTION_ID=00000000-0000-0000-0000-000000000000
73-
RESOURCE_TOKEN=12345
7472
AZURE_RESOURCE_GROUP=rg-dev-12345
7573
SERVICE_WEB_HOSTNAME=web-dev-12345.azurewebsites.net
7674
SERVICE_API_HOSTNAME=api-dev-12345.azurewebsites.net
@@ -112,9 +110,7 @@ Many programming frameworks and tools such as Node.js, Django, or React use `.en
112110
While both serve similar purposes, Azure Developer CLI's `.env` approach adds structure and tooling designed for managing multiple deployment environments and Azure resources.
113111

114112
> [!NOTE]
115-
> If your project already uses framework-specific `.env` files, you can keep both configuration systems without conflicts.
116-
>
117-
> `azd` environment variables override system environment variables of the same name for some operations.
113+
> If your project already uses framework-specific `.env` files, you can keep both configuration systems without conflicts. `azd` environment variables override system environment variables of the same name for some operations.
118114
119115
## Next steps
120116

articles/azure-developer-cli/work-with-environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ azd env select prod
7373

7474
The global configuration file `.azure/config.json` keeps track of your currently selected environment. When you run `azd init` and no environments exist yet, `azd` automatically creates your first environment and sets it as the default. If you already have one or more environments and run `azd env new <name>`, you'll be prompted to choose whether to make the new environment the default. If you decline, the new environment is created but your current selection remains unchanged.
7575

76-
You can temporarily override the default environment for a single command by using the `--environment` flag. This does not change the default for future commands—only for that specific
76+
You can temporarily override the default environment for a single command by using the `--environment` flag. This does not change the default for future commands.
7777

7878
## Refresh environment settings
7979

0 commit comments

Comments
 (0)