Skip to content

Add suggestion text for resource group and Container App unmarshal errors during azd deploy #5518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JeffreyCA merged 6 commits into from
Jul 28, 2025
Merged

Add suggestion text for resource group and Container App unmarshal errors during azd deploy #5518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8fb47c5
Add suggestion text to Container App unmarshal errors during deployment
JeffreyCA Jul 23, 2025
d3c81c6
Fix lint error
JeffreyCA Jul 23, 2025
4aaa104
Simplify phrasing
JeffreyCA Jul 24, 2025
b1438b7
Add suggestion text to resourceGroup error during deploy
JeffreyCA Jul 24, 2025
45e4fdc
Revert for Aspire scenarios
JeffreyCA Jul 24, 2025
963be8f
Emphasize property in green
JeffreyCA Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions cli/azd/pkg/containerapps/container_app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,20 @@ import (
"log"
"net/http"
"slices"
"strings"

"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/streaming"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appcontainers/armappcontainers/v3"
"github.com/azure/azure-dev/cli/azd/internal"
"github.com/azure/azure-dev/cli/azd/pkg/account"
"github.com/azure/azure-dev/cli/azd/pkg/alpha"
"github.com/azure/azure-dev/cli/azd/pkg/config"
"github.com/azure/azure-dev/cli/azd/pkg/convert"
"github.com/azure/azure-dev/cli/azd/pkg/output"
"github.com/benbjohnson/clock"
"github.com/braydonk/yaml"
)
Expand Down Expand Up @@ -458,7 +461,11 @@ func (cas *containerAppService) getContainerApp(

_, err = appClient.Get(ctx, resourceGroupName, appName, nil)
if err != nil {
return nil, fmt.Errorf("getting container app: %w", err)
err = fmt.Errorf("getting container app: %w", err)
if strings.Contains(err.Error(), "unmarshalling type") {
err = withApiVersionSuggestion(err)
}
return nil, err
}

var containAppMap map[string]any
Expand Down Expand Up @@ -499,7 +506,7 @@ func (cas *containerAppService) updateContainerApp(
var containerAppResource armappcontainers.ContainerApp
if apiVersionPolicy == nil {
if err := json.Unmarshal(containerAppJson, &containerAppResource); err != nil {
return fmt.Errorf("failed to unmarshal container app: %w", err)
return withApiVersionSuggestion(fmt.Errorf("failed to unmarshal container app: %w", err))
}
}

Expand Down Expand Up @@ -603,3 +610,16 @@ func createApiVersionPolicy(options *ContainerAppOptions) *containerAppCustomApi
apiVersion: options.ApiVersion,
}
}

func withApiVersionSuggestion(err error) error {
suggestion := "Suggestion: set 'apiVersion' on your service in azure.yaml to match the API version " +
"in your IaC:\n\n" +
"services:\n" +
" your-service:\n" +
output.WithSuccessFormat(" apiVersion: 2025-02-02-preview")

return &internal.ErrorWithSuggestion{
Err: err,
Suggestion: suggestion,
}
}
25 changes: 17 additions & 8 deletions cli/azd/pkg/infra/azure_resource_manager.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@ import (

"github.com/Azure/azure-sdk-for-go/sdk/azcore/arm"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
"github.com/azure/azure-dev/cli/azd/internal"
"github.com/azure/azure-dev/cli/azd/pkg/azapi"
"github.com/azure/azure-dev/cli/azd/pkg/azure"
"github.com/azure/azure-dev/cli/azd/pkg/azureutil"
"github.com/azure/azure-dev/cli/azd/pkg/compare"
"github.com/azure/azure-dev/cli/azd/pkg/output"
)

type AzureResourceManager struct {
Expand Down Expand Up @@ -182,20 +184,27 @@ func (rm *AzureResourceManager) FindResourceGroupForEnvironment(
return rgs[0].Name, nil
}

var msg string

var findErr error
if len(rgs) > 1 {
// We found more than one RG
msg = "more than one possible resource group was found."
findErr = errors.New("more than one possible resource group was found")
} else {
// We didn't find any RGs
msg = "unable to find the environment resource group."
findErr = errors.New("unable to find the environment resource group")
}

return "", fmt.Errorf(
"%s explicitly specify your resource group in azure.yaml or the AZURE_RESOURCE_GROUP environment variable",
msg,
)
suggestion := "Suggestion: explicitly set the AZURE_RESOURCE_GROUP environment variable or specify " +
"your resource group in azure.yaml:\n\n" +
"resourceGroup: your-resource-group\n" +
"# or for a specific service\n" +
"services:\n" +
" your-service:\n" +
output.WithSuccessFormat(" resourceGroup: your-resource-group")

return "", &internal.ErrorWithSuggestion{
Err: findErr,
Suggestion: suggestion,
}
}

func (rm *AzureResourceManager) GetResourceTypeDisplayName(
Expand Down
Loading