search

Azure / azure-dev

A developer CLI that reduces the time it takes for you to get started on Azure. The Azure Developer CLI (azd) provides a set of developer-friendly commands that map to key stages in your workflow - code, build, deploy, monitor, repeat.
https://aka.ms/azd
MIT License
416 stars 205 forks source link

fix persist with default value params in aspire #4524

Closed vhvb1989 closed 2 weeks ago

vhvb1989 commented 3 weeks ago

fix: https://github.com/Azure/azure-dev/issues/4523

This PR adds a new azd metadata type NeedForDeploy which is automatically set to bicep input parameters using a default value in the AppHost.

With this metadata, azd makes a copy of the defaultValue (or the value if overriden with one ENV VAR) and persists it into the azd configuration. This allows azd to find the value for the parameter if it is needed during deployment as an Argument.

ellismg commented 3 weeks ago

With this metadata, azd makes a copy of the defaultValue (or the value if overriden with one ENV VAR) and persists it into the azd configuration. This allows azd to find the value for the parameter if it is needed during deployment as an Argument.

Must we persist the value in the config like this? Naively it feels to me that we could fetch it from the manifest or something when we needed it.

I think this is an okay solution to this problem - but I'm still trying to wrap my head around the full scope of things and how it interacts with where we are moving long term. I'm not 100% sure exactly how this all hangs together when the thing that references the value is a project.v1 and brings its own IaC. Do we expect in that world that this thing would be a parameter on the module for the container app and everything would have "just worked" as before?

This feels like a place where our strategy of "push all prompting for all values across all deployments for the app into the main.bicep at the root" might be leading us astray. Maybe long term we need to attack that problem as well?

I'm not sure if I love neededForDeploy as a type here, but I guess I also don't love 'generate' as the type here - so maybe it's not the end of the world. I do think it would be nice if the type information and the generation/wiring information were separate pieces of metadata.

vhvb1989 commented 3 weeks ago

With this metadata, azd makes a copy of the defaultValue (or the value if overriden with one ENV VAR) and persists it into the azd configuration. This allows azd to find the value for the parameter if it is needed during deployment as an Argument.

Must we persist the value in the config like this? Naively it feels to me that we could fetch it from the manifest or something when we needed it.

I think this is an okay solution to this problem - but I'm still trying to wrap my head around the full scope of things and how it interacts with where we are moving long term. I'm not 100% sure exactly how this all hangs together when the thing that references the value is a project.v1 and brings its own IaC. Do we expect in that world that this thing would be a parameter on the module for the container app and everything would have "just worked" as before?

This feels like a place where our strategy of "push all prompting for all values across all deployments for the app into the main.bicep at the root" might be leading us astray. Maybe long term we need to attack that problem as well?

I'm not sure if I love neededForDeploy as a type here, but I guess I also don't love 'generate' as the type here - so maybe it's not the end of the world. I do think it would be nice if the type information and the generation/wiring information were separate pieces of metadata.

I did consider adding a new way for azd to search for parameters (when need it), but that would lead us into having 2 ways of looking for params: 1) Those parames which azd needs to prompt for. Currently persisted in azd.config.json. Currently supporting secured and non-secured params. 2) Parameters defined in AppHost with a default-value. We could try to detect if those parameters are required or not as inputs to other bicep modules and if not, skip adding them in main.bicep. Then make azd deploy to find its value from the manifest, probably after trying to search for it in azd.config.json anyway, as there's no way to know, during deploy, if a parameter has a defaultValue or not (unless we start deploy by pulling all the parameters from the manifest to see how to get its value).

I think adding 2) increases the complexity v/s using the same pattern we are currently using.

The only thing I had to make in this PR is to tell azd when to persist the values, as we don't want to persist everything in azd.config.json by default.

Another NOTE: To get a parameter value defined with DefaultValue in the AppHost, we don't ONLY need to read the default value from the Manifest. We also need to check if the value is not overridden by the user using an ENV VAR. AZD is currently handling this with 1). A Parameter foo can have a default value bar in the manifest but folks can set AZURE_FOO=non-bar in system env (or azd env). We would need to duplicate the logic in the approach 2)

azure-sdk commented 2 weeks ago

Azure Dev CLI Install Instructions

Install scripts

MacOS/Linux

May elevate using sudo on some platforms and configurations

bash:

curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/uninstall-azd.sh | bash;
curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/install-azd.sh | bash -s -- --base-url https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524 --version '' --verbose --skip-verify

pwsh:

Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/uninstall-azd.ps1' -OutFile uninstall-azd.ps1; ./uninstall-azd.ps1
Invoke-RestMethod 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/install-azd.ps1' -OutFile install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524' -Version '' -SkipVerify -Verbose

Windows

PowerShell install

powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/uninstall-azd.ps1' > uninstall-azd.ps1; ./uninstall-azd.ps1;"
powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/install-azd.ps1' > install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524' -Version '' -SkipVerify -Verbose;"

MSI install

powershell -c "irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/4524/azd-windows-amd64.msi' -OutFile azd-windows-amd64.msi; msiexec /i azd-windows-amd64.msi /qn"

Standalone Binary

MSI

Documentation

learn.microsoft.com documentation --- title: Azure Developer CLI reference description: This article explains the syntax and parameters for the various Azure Developer CLI commands. author: alexwolfmsft ms.author: alexwolf ms.date: 11/09/2024 ms.service: azure-dev-cli ms.topic: conceptual ms.custom: devx-track-azdevcli --- # Azure Developer CLI reference This article explains the syntax and parameters for the various Azure Developer CLI commands. ## azd The Azure Developer CLI (`azd`) is an open-source tool that helps onboard and manage your application on Azure ### Options ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --docs Opens the documentation for azd in your web browser. -h, --help Gets help for azd. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd auth](#azd-auth): Authenticate with Azure. * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [azd deploy](#azd-deploy): Deploy the application's code to Azure. * [azd down](#azd-down): Delete Azure resources for an application. * [azd env](#azd-env): Manage environments. * [azd hooks](#azd-hooks): Develop, test and run hooks for an application. (Beta) * [azd init](#azd-init): Initialize a new application. * [azd monitor](#azd-monitor): Monitor a deployed application. (Beta) * [azd package](#azd-package): Packages the application's code to be deployed to Azure. (Beta) * [azd pipeline](#azd-pipeline): Manage and configure your deployment pipelines. (Beta) * [azd provision](#azd-provision): Provision the Azure resources for an application. * [azd restore](#azd-restore): Restores the application's dependencies. (Beta) * [azd show](#azd-show): Display information about your app and its resources. * [azd template](#azd-template): Find and view template details. (Beta) * [azd up](#azd-up): Provision Azure resources, and deploy your project with a single command. * [azd version](#azd-version): Print the version number of Azure Developer CLI. ## azd auth Authenticate with Azure. ### Options ```azdeveloper --docs Opens the documentation for azd auth in your web browser. -h, --help Gets help for auth. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd auth login](#azd-auth-login): Log in to Azure. * [azd auth logout](#azd-auth-logout): Log out of Azure. * [Back to top](#azd) ## azd auth login Log in to Azure. ### Synopsis Log in to Azure. When run without any arguments, log in interactively using a browser. To log in using a device code, pass --use-device-code. To log in as a service principal, pass --client-id and --tenant-id as well as one of: --client-secret, --client-certificate, or --federated-credential-provider. To log in using a managed identity, pass --managed-identity, which will use the system assigned managed identity. To use a user assigned managed identity, pass --client-id in addition to --managed-identity with the client id of the user assigned managed identity you wish to use. ```azdeveloper azd auth login [flags] ``` ### Options ```azdeveloper --check-status Checks the log-in status instead of logging in. --client-certificate string The path to the client certificate for the service principal to authenticate with. --client-id string The client id for the service principal to authenticate with. --client-secret string The client secret for the service principal to authenticate with. Set to the empty string to read the value from the console. --docs Opens the documentation for azd auth login in your web browser. --federated-credential-provider string The provider to use to acquire a federated token to authenticate with. -h, --help Gets help for login. --managed-identity Use a managed identity to authenticate. --redirect-port int Choose the port to be used as part of the redirect URI during interactive login. --tenant-id string The tenant id or domain name to authenticate with. --use-device-code[=true] When true, log in by using a device code instead of a browser. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd auth](#azd-auth): Authenticate with Azure. * [Back to top](#azd) ## azd auth logout Log out of Azure. ### Synopsis Log out of Azure ```azdeveloper azd auth logout [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd auth logout in your web browser. -h, --help Gets help for logout. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd auth](#azd-auth): Authenticate with Azure. * [Back to top](#azd) ## azd config Manage azd configurations (ex: default Azure subscription, location). ### Synopsis Manage the Azure Developer CLI user configuration, which includes your default Azure subscription and location. Available since `azure-dev-cli_0.4.0-beta.1`. The easiest way to configure `azd` for the first time is to run [`azd init`](#azd-init). The subscription and location you select will be stored in the `config.json` file located in the config directory. To configure `azd` anytime afterwards, you'll use [`azd config set`](#azd-config-set). The default value of the config directory is: * $HOME/.azd on Linux and macOS * %USERPROFILE%\.azd on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable. ### Options ```azdeveloper --docs Opens the documentation for azd config in your web browser. -h, --help Gets help for config. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config get](#azd-config-get): Gets a configuration. * [azd config list-alpha](#azd-config-list-alpha): Display the list of available features in alpha stage. * [azd config reset](#azd-config-reset): Resets configuration to default. * [azd config set](#azd-config-set): Sets a configuration. * [azd config show](#azd-config-show): Show all the configuration values. * [azd config unset](#azd-config-unset): Unsets a configuration. * [Back to top](#azd) ## azd config get Gets a configuration. ### Synopsis Gets a configuration in the configuration path. The default value of the config directory is: * `$HOME/.azd` on Linux and macOS * `%USERPROFILE%\.azd` on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable. ```azdeveloper azd config get [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd config get in your web browser. -h, --help Gets help for get. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd config list-alpha Display the list of available features in alpha stage. ```azdeveloper azd config list-alpha [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd config list-alpha in your web browser. -h, --help Gets help for list-alpha. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd config reset Resets configuration to default. ### Synopsis Resets all configuration in the configuration path. The default value of the config directory is: * `$HOME/.azd` on Linux and macOS * `%USERPROFILE%\.azd` on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable to the default. ```azdeveloper azd config reset [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd config reset in your web browser. -f, --force Force reset without confirmation. -h, --help Gets help for reset. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd config set Sets a configuration. ### Synopsis Sets a configuration in the configuration path. The default value of the config directory is: * `$HOME/.azd` on Linux and macOS * `%USERPROFILE%\.azd` on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable. ```azdeveloper azd config set [flags] ``` ### Examples ```azdeveloper azd config set defaults.subscription azd config set defaults.location eastus ``` ### Options ```azdeveloper --docs Opens the documentation for azd config set in your web browser. -h, --help Gets help for set. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd config show Show all the configuration values. ### Synopsis Show all configuration values in the configuration path. The default value of the config directory is: * `$HOME/.azd` on Linux and macOS * `%USERPROFILE%\.azd` on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable. ```azdeveloper azd config show [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd config show in your web browser. -h, --help Gets help for show. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd config unset Unsets a configuration. ### Synopsis Removes a configuration in the configuration path. The default value of the config directory is: * `$HOME/.azd` on Linux and macOS * `%USERPROFILE%\.azd` on Windows The configuration directory can be overridden by specifying a path in the AZD_CONFIG_DIR environment variable. ```azdeveloper azd config unset [flags] ``` ### Examples ```azdeveloper azd config unset defaults.location ``` ### Options ```azdeveloper --docs Opens the documentation for azd config unset in your web browser. -h, --help Gets help for unset. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd config](#azd-config): Manage azd configurations (ex: default Azure subscription, location). * [Back to top](#azd) ## azd deploy Deploy the application's code to Azure. ```azdeveloper azd deploy [flags] ``` ### Options ```azdeveloper --all Deploys all services that are listed in azure.yaml --docs Opens the documentation for azd deploy in your web browser. -e, --environment string The name of the environment to use. --from-package string Deploys the application from an existing package. -h, --help Gets help for deploy. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd down Delete Azure resources for an application. ```azdeveloper azd down [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd down in your web browser. -e, --environment string The name of the environment to use. --force Does not require confirmation before it deletes resources. -h, --help Gets help for down. --purge Does not require confirmation before it permanently deletes resources that are soft-deleted by default (for example, key vaults). ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd env Manage environments. ### Options ```azdeveloper --docs Opens the documentation for azd env in your web browser. -h, --help Gets help for env. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env get-value](#azd-env-get-value): Get specific environment value. * [azd env get-values](#azd-env-get-values): Get all environment values. * [azd env list](#azd-env-list): List environments. * [azd env new](#azd-env-new): Create a new environment and set it as the default. * [azd env refresh](#azd-env-refresh): Refresh environment settings by using information from a previous infrastructure provision. * [azd env select](#azd-env-select): Set the default environment. * [azd env set](#azd-env-set): Manage your environment settings. * [Back to top](#azd) ## azd env get-value Get specific environment value. ```azdeveloper azd env get-value [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env get-value in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for get-value. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env get-values Get all environment values. ```azdeveloper azd env get-values [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env get-values in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for get-values. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env list List environments. ```azdeveloper azd env list [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env list in your web browser. -h, --help Gets help for list. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env new Create a new environment and set it as the default. ```azdeveloper azd env new [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env new in your web browser. -h, --help Gets help for new. -l, --location string Azure location for the new environment --subscription string Name or ID of an Azure subscription to use for the new environment ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env refresh Refresh environment settings by using information from a previous infrastructure provision. ```azdeveloper azd env refresh [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env refresh in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for refresh. --hint string Hint to help identify the environment to refresh ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env select Set the default environment. ```azdeveloper azd env select [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env select in your web browser. -h, --help Gets help for select. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd env set Manage your environment settings. ```azdeveloper azd env set [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd env set in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for set. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd env](#azd-env): Manage environments. * [Back to top](#azd) ## azd hooks Develop, test and run hooks for an application. (Beta) ### Options ```azdeveloper --docs Opens the documentation for azd hooks in your web browser. -h, --help Gets help for hooks. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd hooks run](#azd-hooks-run): Runs the specified hook for the project and services * [Back to top](#azd) ## azd hooks run Runs the specified hook for the project and services ```azdeveloper azd hooks run [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd hooks run in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for run. --platform string Forces hooks to run for the specified platform. --service string Only runs hooks for the specified service. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd hooks](#azd-hooks): Develop, test and run hooks for an application. (Beta) * [Back to top](#azd) ## azd init Initialize a new application. ```azdeveloper azd init [flags] ``` ### Options ```azdeveloper -b, --branch string The template branch to initialize from. Must be used with a template argument (--template or -t). --docs Opens the documentation for azd init in your web browser. -e, --environment string The name of the environment to use. -f, --filter strings The tag(s) used to filter template results. Supports comma-separated values. --from-code Initializes a new application from your existing code. -h, --help Gets help for init. -l, --location string Azure location for the new environment -s, --subscription string Name or ID of an Azure subscription to use for the new environment -t, --template string Initializes a new application from a template. You can use Full URI, /, or if it's part of the azure-samples organization. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd monitor Monitor a deployed application. (Beta) ```azdeveloper azd monitor [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd monitor in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for monitor. --live Open a browser to Application Insights Live Metrics. Live Metrics is currently not supported for Python apps. --logs Open a browser to Application Insights Logs. --overview Open a browser to Application Insights Overview Dashboard. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd package Packages the application's code to be deployed to Azure. (Beta) ```azdeveloper azd package [flags] ``` ### Options ```azdeveloper --all Packages all services that are listed in azure.yaml --docs Opens the documentation for azd package in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for package. --output-path string File or folder path where the generated packages will be saved. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd pipeline Manage and configure your deployment pipelines. (Beta) ### Options ```azdeveloper --docs Opens the documentation for azd pipeline in your web browser. -h, --help Gets help for pipeline. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd pipeline config](#azd-pipeline-config): Configure your deployment pipeline to connect securely to Azure. (Beta) * [Back to top](#azd) ## azd pipeline config Configure your deployment pipeline to connect securely to Azure. (Beta) ```azdeveloper azd pipeline config [flags] ``` ### Options ```azdeveloper -m, --applicationServiceManagementReference string Service Management Reference. References application or service contact information from a Service or Asset Management database. This value must be a Universally Unique Identifier (UUID). You can set this value globally by running azd config set pipeline.config.applicationServiceManagementReference . --auth-type string The authentication type used between the pipeline provider and Azure for deployment (Only valid for GitHub provider). Valid values: federated, client-credentials. --docs Opens the documentation for azd pipeline config in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for config. --principal-id string The client id of the service principal to use to grant access to Azure resources as part of the pipeline. --principal-name string The name of the service principal to use to grant access to Azure resources as part of the pipeline. --principal-role stringArray The roles to assign to the service principal. By default the service principal will be granted the Contributor and User Access Administrator roles. (default [Contributor,User Access Administrator]) --provider string The pipeline provider to use (github for Github Actions and azdo for Azure Pipelines). --remote-name string The name of the git remote to configure the pipeline to run on. (default "origin") ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd pipeline](#azd-pipeline): Manage and configure your deployment pipelines. (Beta) * [Back to top](#azd) ## azd provision Provision the Azure resources for an application. ```azdeveloper azd provision [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd provision in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for provision. --no-state Do not use latest Deployment State (bicep only). --preview Preview changes to Azure resources. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd restore Restores the application's dependencies. (Beta) ```azdeveloper azd restore [flags] ``` ### Options ```azdeveloper --all Restores all services that are listed in azure.yaml --docs Opens the documentation for azd restore in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for restore. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd show Display information about your app and its resources. ```azdeveloper azd show [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd show in your web browser. -e, --environment string The name of the environment to use. -h, --help Gets help for show. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [Back to top](#azd) ## azd template Find and view template details. (Beta) ### Options ```azdeveloper --docs Opens the documentation for azd template in your web browser. -h, --help Gets help for template. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd template list](#azd-template-list): Show list of sample azd templates. (Beta) * [azd template show](#azd-template-show): Show details for a given template. (Beta) * [azd template source](#azd-template-source): View and manage template sources. (Beta) * [Back to top](#azd) ## azd template list Show list of sample azd templates. (Beta) ```azdeveloper azd template list [flags] ``` ### Options ```azdeveloper --docs Opens the documentation for azd template list in your web browser. -f, --filter strings The tag(s) used to filter template results. Supports comma-separated values. -h, --help Gets help for list. -s, --source string Filters templates by source. ``` ### Options inherited from parent commands ```azdeveloper -C, --cwd string Sets the current working directory. --debug Enables debugging and diagnostics logging. --no-prompt Accepts the default value instead of prompting, or it fails if there is no default. ``` ### See also * [azd template](#azd-template): Find and view template details. (Beta) * [Back to top](#azd) ## azd template show Show details for a given template. (Beta) ```azdeveloper azd template show