Add completed as teminal state in sdk/azcore

[duncan485]

When working with the sdk/resourcemanager/costmanagement/armcostmanagement v1.0.0 package I encountered a bug when polling the result of NewGenerateDetailedCostReportClient.BeginCreateOperation.

When the report is succesfully generated by this function, it returns a status of 'Completed', however, 'Completed is not recognized as a terminal state in the underlying sdk/azcore package. This leads to an infinite loop in the PollUntilDone function. The bug can be replicated by taking the example of NewGenerateDetailedCostReportClient.BeginCreateOperation from docs

This PR adds 'Completed' as a recognized terminal state.

package main

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement"
)

func main() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armcostmanagement.NewGenerateDetailedCostReportClient(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOperation(ctx,
		"providers/Microsoft.Billing/billingAccounts/12345",
		armcostmanagement.GenerateDetailedCostReportDefinition{
			BillingPeriod: to.Ptr("202008"),
			Metric:        to.Ptr(armcostmanagement.GenerateDetailedCostReportMetricTypeActualCost),
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil) // INFINITE LOOP HERE
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

• [ x] The purpose of this PR is explained in this or a referenced issue.
• [ x] The PR does not update generated files.
  • These files are managed by the codegen framework at Azure/autorest.go.
• [x ] Tests are included and/or updated for code changes.
• Updates to CHANGELOG.md are included.
• MIT license headers are included in each file.

[ghost]

Thank you for your contribution duncan485! We will review the pull request and get back to you soon.

[ghost]

All CLA requirements met.

[jhendrixMSFT]

While I'm not opposed to adding this, I believe this is in violation of the ARM RPC spec. Let me follow up on that.

[duncan485]

Thanks, I was unaware of the spec. Just encountered the bug and tried to solve it this way :) . Let me know if there is a more elegant solution.

[duncan485]

Hi @jhendrixMSFT , any update on this?

If there is a better way we can fix the issue please let me know.

[jhendrixMSFT]

Sorry for the delay, I just pinged the owners again to get their input on this.

[jhendrixMSFT]

The service is in error here, it shouldn't be returned Completed. I'm following up with the service team to get this fixed.

[ghost]

Hi @duncan485. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[ghost]

Hi @duncan485. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing "/reopen" if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the "no-recent-activity" label; otherwise, this is likely to be closed again with the next cleanup pass.