Support sovereign clouds #2897

danieljurek · 2023-10-19T21:55:08Z

Fixes #973

Some decisions to be aware of:

Only support well-known clouds (Azure Public, China Cloud, US Gov Cloud)
Passing of pkg/cloud.Cloud is done as a pointer to follow our normal convention.
Configuration panics if a clouds name is unknown so the cloud name must be precise... another approach would be to fall back to public cloud and/or log an error message. I'm adding this in.
SCM hostname for zip deployment is retrieved from ARM to avoid hardcoding additional suffixes
The bulk of configuration business logic is in cmd/container.go because putting it in pkg/cloud would result in an import cycle and, since we're only doing it in one place we should do that here.
Some templates needed minor changes to support sovereign clouds

UX change (@Austinauth): If a user sets an incorrect cloud name and attempts to run a command that interacts with the cloud the user will see an error -

Safe default "AzureCloud" is always assumed if cloud.name is not set.

Docs updates: https://github.com/MicrosoftDocs/azure-dev-docs-pr/pull/5353

Here is a candidate for simplifying injection of client options: https://github.com/Azure/azure-dev/pull/3270/files

azure-pipelines · 2024-01-08T02:58:14Z

Commenter does not have sufficient privileges for PR 2897 in repo Azure/azure-dev

v-xuto · 2024-01-08T03:05:00Z

/azp run azure-dev - cli

azure-pipelines · 2024-01-08T03:05:13Z

Azure Pipelines successfully started running 1 pipeline(s).

v-xuto · 2024-01-10T02:28:49Z

/azp run azure-dev - cli

azure-pipelines · 2024-01-10T02:29:03Z

Azure Pipelines successfully started running 1 pipeline(s).

cli/azd/pkg/cloud/cloud.go

Austinauth · 2024-01-17T18:19:55Z

Hey @danieljurek I recommend a couple of quick style tweaks for consistency (see below).

Regarding the message itself, is there anyway we could be more specific? When we say "use valid names", what does the user to do? Run the command again?

danieljurek · 2024-01-17T22:56:35Z

Hey @danieljurek I recommend a couple of quick style tweaks for consistency (see below).

Regarding the message itself, is there anyway we could be more specific? When we say "use valid names", what does the user to do? Run the command again?

The user can set the cloud in one of 3 places:

User settings ~/.azd/config.json
Project settings azure.yaml
Environment <project>/.azure/<environment>/config.json

The command to modify would be different based on the configuration used. We could probably include the used config type which could make this error message more useful.

Will need to explore how one can do formatting for the error.

danieljurek · 2024-01-18T04:51:12Z

@Austinauth -- We do have some precedent for formatting the error message and providing suggestions... Following that pattern I get:

Note that "Error:" is different from your proposed red "ERROR:" ... If we change formatting for that it changes across azd... something to discuss.

I'll work some more on using the config context to provide useful suggestions.

Austinauth · 2024-01-18T14:24:16Z

@Austinauth -- We do have some precedent for formatting the error message and providing suggestions... Following that pattern I get:

Note that "Error:" is different from your proposed red "ERROR:" ... If we change formatting for that it changes across azd... something to discuss.

I'll work some more on using the config context to provide useful suggestions.

Here's the current guidance for error message styling. This has been the guidance for the last year or so, but somewhere along the way we've been inconsistent in our application of it.

(see: Azure Developer CLI Design Dashboard)

We've discussed tweaking the format (casing, color application), but we've never made any formal change to the formatting since defining the above as far as I am aware.

The command to modify would be different based on the configuration used. We could probably include the used config type which could make this error message more useful.

Ahh I see. It's difficult for me to rewrite the suggestion without having a strong technical understanding of what is the root cause of the error and how to resolve it. But basically if the user wants to resolve the issue we need them to go into either their user settings, project settings, or environment and change the "cloud" name to something we accept?

Is there an easy way for the user to understand what is a valid cloud name so they can modify theirs?

Is there a docs link on the subject? Perhaps we could link to it.

danieljurek · 2024-01-18T19:40:44Z

@Austinauth -- I can produce 3 types of error messages now:

Global azd config:

azure.yml file config:

environment config:

danieljurek · 2024-01-19T00:32:36Z

cli/azd/cmd/cobra_builder.go

+			var suggestionErr *azcli.ErrorWithSuggestion
+			if errors.As(err, &suggestionErr) {
+				cmd.SilenceErrors = true
+				cb.container.Invoke(func(console input.Console) {
+					console.Message(ctx, color.RedString("ERROR: %s", err.Error()))
+					console.Message(ctx, (*azcli.ErrorWithSuggestion)(suggestionErr).Suggestion)
+				})
+				return err
+			}


@wbreza -- ActionResult doesn't fit here because we're determining the cloud configuration before executing actions. ErrorWithSuggestion works and this formats all encountered ErrorWithSuggestions accordingly:

@Austinauth right... need to add you to this discussion :)

Just to be clear - at this point we're getting an error when resolving the action because there was some cloud configuration error which internally uses ErrorWithSuggestion.

This seems correct, but also feel that the handling of this special error scenario should be somewhere else but we have not invoked an action and therefore cannot be handled by a middleware. Feels like maybe this should be in root/main.go when we get the error back from the root level cobra command invocation.

Message and suggestion look great @danieljurek. The suggestion is clear and actionable, and the execution is visually consistent.

wbreza

This is a great start but going to stop here for now:

Overall feedback:

Love the bootstrapping configuration style from the various config options
Not a fan of having to have cloud as a member on so many of our components
Would prefer us to move the injection of the SDK ClientOptions and SDK clients into the container. This would allow us to inject those which is already handing the cloud concerns for the most part.

Goal: Only need to inject cloud into our components if we need to get an URL prefix or service url.

wbreza · 2024-01-23T21:50:44Z

cli/azd/cmd/cobra_builder.go

+			var suggestionErr *azcli.ErrorWithSuggestion
+			if errors.As(err, &suggestionErr) {
+				cmd.SilenceErrors = true
+				cb.container.Invoke(func(console input.Console) {
+					console.Message(ctx, color.RedString("ERROR: %s", err.Error()))
+					console.Message(ctx, (*azcli.ErrorWithSuggestion)(suggestionErr).Suggestion)
+				})
+				return err
+			}


Just to be clear - at this point we're getting an error when resolving the action because there was some cloud configuration error which internally uses ErrorWithSuggestion.

This seems correct, but also feel that the handling of this special error scenario should be somewhere else but we have not invoked an action and therefore cannot be handled by a middleware. Feels like maybe this should be in root/main.go when we get the error back from the root level cobra command invocation.

cli/azd/cmd/container.go

wbreza · 2024-01-23T22:05:37Z

cli/azd/cmd/container.go

+		}
+
+		// Project Configuration
+		projConfig, _ := lazyProjectConfig.GetValue()


You likely should check for an error here in the event there is no project / azure.yaml file.

wbreza · 2024-01-23T22:10:07Z

cli/azd/cmd/container.go

+		if azdCtx, err := lazyAzdContext.GetValue(); err == nil {
+			if azdCtx != nil && localEnvStore != nil {
+				if defaultEnvName, err := azdCtx.GetDefaultEnvironmentName(); err == nil {
+					env, err := localEnvStore.Get(ctx, defaultEnvName)
+					if err == nil {
+						cloudConfigurationNode, exists := env.Config.Get(cloud.ConfigPath)
+						if exists {
+							value, err := cloud.ParseCloudConfig(cloudConfigurationNode)
+							if err == nil {
+								cloudConfig = value
+
+								// In the event of an error set the suggestion for updating the cloud configuration


Lots of nesting going on... Any way we can clean this up to short circuit return or similar?

wbreza · 2024-01-23T22:15:17Z

cli/azd/pkg/account/subscriptions.go

+	httpClient httputil.HttpClient,
+	cloud *cloud.Cloud,
+) *SubscriptionsService {


Is there any way we can avoid propagating this up through our exposed service? Maybe there is an opportunity to inject the *armsubscriptions.Client here instead and leave the internal cloud configuration to the IoC container.

wbreza · 2024-01-23T22:21:10Z

cli/azd/pkg/auth/manager.go

@@ -365,8 +379,10 @@ func (m *Manager) newCredentialFromClientSecret(
 	options := &azidentity.ClientSecretCredentialOptions{
 		ClientOptions: policy.ClientOptions{
 			Transport: m.httpClient,
+			Cloud:     m.cloud.Configuration,


Feels like we could move the policy.ClientOptions as injectable that automatically handles the cloud configuration vs have to specify this in multiple places.

wbreza · 2024-01-23T22:22:50Z

cli/azd/pkg/auth/manager_test.go

@@ -61,6 +64,7 @@ func TestServicePrincipalLoginClientSecret(t *testing.T) {
 		configManager:     newMemoryConfigManager(),
 		userConfigManager: newMemoryUserConfigManager(),
 		credentialCache:   credentialCache,
+		cloud:             publicCloud,


I'd like to really avoid having to support cloud as a top level member of our components and move to a model where it is an internal implementation detail of working with the Go SDK.

wbreza · 2024-01-23T22:35:03Z

schemas/v1.0/azure.yaml.json

+            "description": "Optional. Provides additional configuration for deploying to sovereign clouds such as Azure Government.",
+            "additionalProperties": false,
+            "properties": {
+                "name": { "enum": [ "AzureCloud", "AzureChinaCloud", "AzureUSGovernment" ] }


Feels like if the user is going to specify the cloud section then the name should be required.

… require the user to do that?

azure-sdk · 2024-01-29T22:13:30Z

azd init -t Azure-Samples/todo-python-mongo-terraform -b pr/2897

View Changes | Compare Changes

azure-sdk · 2024-01-29T22:45:00Z

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/2897/uninstall-azd.sh | bash;
curl -fsSL https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/2897/install-azd.sh | bash -s -- --base-url https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/2897 --version '' --verbose --skip-verify

pwsh:

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

Windows

PowerShell install

powershell -c "Set-ExecutionPolicy Bypass Process; irm 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/2897/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/2897/install-azd.ps1' > install-azd.ps1; ./install-azd.ps1 -BaseUrl 'https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/2897' -Version '' -SkipVerify -Verbose;"

MSI install

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

Standalone Binary

MSI

https://azuresdkreleasepreview.blob.core.windows.net/azd/standalone/pr/2897/azd-windows-amd64.msi

Container

docker run -it azdevcliextacr.azurecr.io/azure-dev:pr-2897

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: 01/29/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

  -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.

azd auth

Authenticate with Azure.

Options

      --docs   Opens the documentation for azd auth in your web browser.
  -h, --help   Gets help for auth.

Options inherited from parent commands

  -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.

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.

azd auth login [flags]

Options

      --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.
      --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

  -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.

azd auth logout

Log out of Azure.

Synopsis

Log out of Azure

azd auth logout [flags]

Options

      --docs   Opens the documentation for azd auth logout in your web browser.
  -h, --help   Gets help for logout.

Options inherited from parent commands

  -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.

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. 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.

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

      --docs   Opens the documentation for azd config in your web browser.
  -h, --help   Gets help for config.

Options inherited from parent commands

  -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.

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.

azd config get <path> [flags]

Options

      --docs   Opens the documentation for azd config get in your web browser.
  -h, --help   Gets help for get.

Options inherited from parent commands

  -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.

azd config list-alpha

Display the list of available features in alpha stage.

azd config list-alpha [flags]

Options

      --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

  -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.

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.

azd config reset [flags]

Options

      --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

  -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.

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.

azd config set <path> <value> [flags]

Examples

azd config set defaults.subscription <yourSubscriptionID>
azd config set defaults.location eastus

Options

      --docs   Opens the documentation for azd config set in your web browser.
  -h, --help   Gets help for set.

Options inherited from parent commands

  -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.

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.

azd config show [flags]

Options

      --docs   Opens the documentation for azd config show in your web browser.
  -h, --help   Gets help for show.

Options inherited from parent commands

  -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.

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.

azd config unset <path> [flags]

Examples

azd config unset defaults.location

Options

      --docs   Opens the documentation for azd config unset in your web browser.
  -h, --help   Gets help for unset.

Options inherited from parent commands

  -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.

azd deploy

Deploy the application's code to Azure.

azd deploy <service> [flags]

Options

      --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

  -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.

azd down

Delete Azure resources for an application.

azd down [flags]

Options

      --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

  -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.

azd env

Manage environments.

Options

      --docs   Opens the documentation for azd env in your web browser.
  -h, --help   Gets help for env.

Options inherited from parent commands

  -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.

azd env get-values

Get all environment values.

azd env get-values [flags]

Options

      --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

  -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.

azd env list

List environments.

azd env list [flags]

Options

      --docs   Opens the documentation for azd env list in your web browser.
  -h, --help   Gets help for list.

Options inherited from parent commands

  -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.

azd env new

Create a new environment and set it as the default.

azd env new <environment> [flags]

Options

      --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

  -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.

azd env refresh

Refresh environment settings by using information from a previous infrastructure provision.

azd env refresh <environment> [flags]

Options

      --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

  -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.

azd env select

Set the default environment.

azd env select <environment> [flags]

Options

      --docs   Opens the documentation for azd env select in your web browser.
  -h, --help   Gets help for select.

Options inherited from parent commands

  -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.

azd env set

Manage your environment settings.

azd env set <key> <value> [flags]

Options

      --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

  -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.

azd hooks

Develop, test and run hooks for an application. (Beta)

Options

      --docs   Opens the documentation for azd hooks in your web browser.
  -h, --help   Gets help for hooks.

Options inherited from parent commands

  -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.

azd hooks run

Runs the specified hook for the project and services

azd hooks run <name> [flags]

Options

      --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

  -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.

azd init

Initialize a new application.

azd init [flags]

Options

  -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.
  -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       The template to use when you initialize the project. You can use Full URI, <owner>/<repository>, or <repository> if it's part of the azure-samples organization.

Options inherited from parent commands

  -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.

azd monitor

Monitor a deployed application. (Beta)

azd monitor [flags]

Options

      --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

  -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.

azd package

Packages the application's code to be deployed to Azure. (Beta)

azd package <service> [flags]

Options

      --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

  -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.

azd pipeline

Manage and configure your deployment pipelines. (Beta)

Options

      --docs   Opens the documentation for azd pipeline in your web browser.
  -h, --help   Gets help for pipeline.

Options inherited from parent commands

  -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.

azd pipeline config

Configure your deployment pipeline to connect securely to Azure. (Beta)

azd pipeline config [flags]

Options

      --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

  -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.

azd provision

Provision the Azure resources for an application.

azd provision [flags]

Options

      --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

  -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.

azd restore

Restores the application's dependencies. (Beta)

azd restore <service> [flags]

Options

      --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

  -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.

azd show

Display information about your app and its resources.

azd show [flags]

Options

      --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

  -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.

azd template

Find and view template details. (Beta)

Options

      --docs   Opens the documentation for azd template in your web browser.
  -h, --help   Gets help for template.

Options inherited from parent commands

  -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.

azd template list

Show list of sample azd templates. (Beta)

azd template list [flags]

Options

      --docs            Opens the documentation for azd template list in your web browser.
  -h, --help            Gets help for list.
  -s, --source string   Filters templates by source.

Options inherited from parent commands

  -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.

azd template show

Show details for a given template. (Beta)

azd template show <template> [flags]

Options

      --docs   Opens the documentation for azd template show in your web browser.
  -h, --help   Gets help for show.

Options inherited from parent commands

  -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.

azd template source

View and manage template sources. (Beta)

Options

      --docs   Opens the documentation for azd template source in your web browser.
  -h, --help   Gets help for source.

Options inherited from parent commands

  -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.

azd template source add

Adds an azd template source at the specified key (Beta)

azd template source add <key> [flags]

Options

      --docs              Opens the documentation for azd template source add in your web browser.
  -h, --help              Gets help for add.
  -l, --location string   Location of the template source.
  -n, --name string       Display name of the template source.
  -t, --type string       Kind of the template source.

Options inherited from parent commands

  -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.

azd template source list

Lists the configured azd template sources. (Beta)

azd template source list [flags]

Options

      --docs   Opens the documentation for azd template source list in your web browser.
  -h, --help   Gets help for list.

Options inherited from parent commands

  -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.

azd template source remove

Removes the specified azd template source (Beta)

azd template source remove <key> [flags]

Options

      --docs   Opens the documentation for azd template source remove in your web browser.
  -h, --help   Gets help for remove.

Options inherited from parent commands

  -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.

azd up

Provision Azure resources, and deploy your project with a single command.

azd up [flags]

Options

      --docs                 Opens the documentation for azd up in your web browser.
  -e, --environment string   The name of the environment to use.
  -h, --help                 Gets help for up.

Options inherited from parent commands

  -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.

azd version

Print the version number of Azure Developer CLI.

azd version [flags]

Options

      --docs   Opens the documentation for azd version in your web browser.
  -h, --help   Gets help for version.

Options inherited from parent commands

  -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.

Support sovereign clouds #2897

Support sovereign clouds #2897

Conversation

danieljurek commented Oct 19, 2023 • edited Loading

azure-pipelines bot commented Jan 8, 2024

v-xuto commented Jan 8, 2024

azure-pipelines bot commented Jan 8, 2024

v-xuto commented Jan 10, 2024

azure-pipelines bot commented Jan 10, 2024

Austinauth commented Jan 17, 2024

danieljurek commented Jan 17, 2024 • edited Loading

danieljurek commented Jan 18, 2024

Austinauth commented Jan 18, 2024 • edited Loading

danieljurek commented Jan 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wbreza left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azure-sdk commented Jan 29, 2024

Repoman Generation Results

Project: azd-starter-terraform

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-csharp-cosmos-sql

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-csharp-sql-swa-func

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-csharp-sql

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-java-mongo-aca

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-java-mongo

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-java-postgresql-terraform

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-nodejs-mongo-aca

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-nodejs-mongo-aks

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-nodejs-mongo-swa-func

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-nodejs-mongo

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-nodejs-mongo-terraform

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-python-mongo-aca

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-python-mongo-swa-func

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-python-mongo

Remote: azure-samples-staging

Branch: pr/2897

Project: todo-python-mongo-terraform

Remote: azure-samples-staging

Branch: pr/2897

azure-sdk commented Jan 29, 2024

Azure Dev CLI Install Instructions

Install scripts

danieljurek commented Oct 19, 2023 •

edited

Loading

danieljurek commented Jan 17, 2024 •

edited

Loading

Austinauth commented Jan 18, 2024 •

edited

Loading

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: 01/29/2024
ms.service: azure-dev-cli
ms.topic: conceptual
ms.custom: devx-track-azdevcli