Add non-interactive mode for `azd add` command

[kristenwomack]

Problem

Developers need to automate the creation of Azure resources in their CI/CD pipelines and scripts without interactive interaction. The current azd add command requires interactive input, making it difficult to use in automation scenarios. This creates friction for developers who want to script or automate their Azure resource creation workflows.

User Story

I want to add Azure resources to my project using non-interactive commands. I might use this in a repetitive template.

Proposed Solution

Implement a non-interactive mode for the azd add command that allows specifying all required parameters via command-line flags.

Example usage:

azd add --type ai.project --name search-agent --sub MySub

Acceptance Criteria

• CLI

  • The azd add command accepts the following flags:
    • --type: the type of resource to add (e.g., ai.project)
    • --name: the name of the resource
    • --sub: the subscription to use
    • --non-interactive: flag to enable non-interactive mode (optional, defaults to false)
    • --optional: azd add --resource_id [full resource ID] as copied from azure portal

• Functionality

  • When all required parameters are provided via flags:
    • Command executes without prompting for user input
    • Updates azure.yaml with the new resource configuration
    • Returns appropriate exit code

• Error Handling

  • Clear error messages when required parameters are missing
  • Validation of resource type, name, and subscription
  • Checks for naming conflicts with existing resources

• Documentation updates

  • Update CLI documentation to include non-interactive mode
  • Add examples for common automation scenarios
  • Document all supported resource types for non-interactive mode

• Test coverage

  • Unit tests for non-interactive mode
  • Integration tests with mock Azure resources
  • Test cases for error conditions and parameter validation

• Out of Scope

  • Changes to existing interactive mode behavior
  • Adding new resource types
  • Changes to the resource provisioning process

• Additional Context

  • This feature will initially support the ai.project resource type
  • Future iterations may add support for additional resource types

[jfomhover]

optional: also support azd add --resource_id [full resource ID] as copied from azure portal

[vhvb1989]

There is a side effect of using flags to support this because azd add is supposed to be not only for resources (infra).

Here is an example of how to use an azd extension (in go) that programmatically calls the azd client for composing (the functionality under azd add): https://github.com/Azure/azure-dev/blob/main/cli/azd/extensions/microsoft.azd.ai.builder/internal/cmd/start.go#L452

Similar to azd pipeline config, I don't think that azd add was ever designed to support non-interactive flows (@weikanglim to confirm). There are options which comes after adding resources which depends on previously added resources. Like adding a DB would ask you about which service will use the DB based on the existing services.

The simplest alternative is to manually write the resources you want to add to the azure.yaml directly, following the yaml-schema for composability. But this is still hard to imagine in a CI/CD world where you want to repeat the same pipeline every time.

[weikanglim]

The CI/CD scenario is an interesting angle that isn't something I am familiar of or have heard about before. Like @vhvb1989 said, the primary goals of IaC is to encourage repeatability. Dynamically adding resources would be counter-productive to the goal.

I'm not fully understanding the scripting part of the scenario and cannot offer immediate recommendations.

Do we have a concrete scenario in mind?

With a more concrete scenario, there are many options available for non-interactive support that I have available from my backpocket notes:

• azd add --type <type> -- This would be good for documenting and walking the user through a setup scenario, assuming this is pertinent
• azd add --type <type> --resource-id <resource-id> --uses <name> -- Existing resources, bindings
• azd add --type <type> --yaml <resource-definition> -- This would make LLMs happy, but would be a longer term investment.

[jfomhover]

I would not advocate for this azd add --type to be something used within CI/CD scripts. That would bypass all the value add of having azd with infra in biceps. I am approaching this more as a manual composition feature, because editing directly in azure.yaml isn't documented enough (in my own experience), while having this simple command we could surface it in-portal to explain to users how to attach their existing projects

[jfomhover]

With a more concrete scenario, there are many options available for non-interactive support that I have available from my backpocket notes:

• azd add --type <type> -- This would be good for documenting and walking the user through a setup scenario, assuming this is pertinent
• azd add --type <type> --resource-id <resource-id> --uses <name> -- Existing resources, bindings
• azd add --type <type> --yaml <resource-definition> -- This would make LLMs happy, but would be a longer term investment.

this first scenario, of documenting and walking the user through a setup scenario, is exactly what I'd like non-interactive mode to support

[weikanglim]

@jfomhover Thanks for chiming in!

Is the non-interactive mode a hard requirement from your lens?

I'm only asking since in many cases, interactively guiding the user and applying subscription-specific filters may end up delivering a more personalized and successful experience for the user.

Here's a comparison:

• If we are okay with interaction mode, the walkthrough could document "Pick model version Foo-2024-08-17". In this case, the user follows through with interactive prompts, the prompts will only display a filtered-down list 9f quota and locations available in the user's subscription.
• If we made non-interactive mode a hard requirement, the walkthrough documentsazd add --type ai.project --model Foo-2024-08-17 --yaml <additional resource definition>. When the user runs this in a subscription, this ends up validating and failing.

In some ways, the interactive prompts act as "a minimal level of roadbump" to make sure the user stays on the happy path.