SubscriptionRequired on apimanagement.APICreateOrUpdateParameter does not seem to work as expected.

[codyseavey]

Bug Report

• github.com/Azure/azure-sdk-for-go/services/apimanagement/mgmt/2019-01-01/apimanagement

• versions:

  • github.com/Azure/azure-sdk-for-go v32.6.0
  • github.com/Azure/go-autorest/autorest/azure/auth v0.3.0
  • github.com/Azure/go-autorest/autorest/to v0.3.0 // indirect
  • github.com/Azure/go-autorest/autorest/validation v0.2.0 // indirect

• go version go1.12.5 linux/amd64

• What happened? API's in an APIM that are created with the following code require Subscriptions.

  // UpdateAPIM updates the target API in the APIM with the new openapi definition
  func UpdateAPIM(apiClient apimanagement.APIClient, resourceGroup, serviceName, content, apiName string) error {
  ctx, cancel := context.WithTimeout(context.Background(), 300*time.Second)
  defer cancel()
  
  apiParameters := &apimanagement.APICreateOrUpdateParameter{
      APICreateOrUpdateProperties: &apimanagement.APICreateOrUpdateProperties{
          DisplayName:          &apiName,
          Value:                &content,
          Format:               apimanagement.Openapijson,
          Path:                 &apiName,
          Protocols:            &[]apimanagement.Protocol{"https"},
          SubscriptionRequired: func() *bool { b := false; return &b }(),
      },
  }
  result, err := apiClient.CreateOrUpdate(ctx, resourceGroup, serviceName, apiName, *apiParameters, "*")
  if err != nil {
      klog.Errorf("failed to update/create apiName=%s : %v\n", apiName, err.Error())
      return err
  }
  
  err = result.Future.WaitForCompletionRef(ctx, apiClient.Client)
  if err != nil {
      klog.Errorf("failed to wait for completion of update/create of api %s : %v\n", apiName, err.Error())
      return err
  }
  
  apiContract, err := result.Result(apiClient)
  if err != nil {
      klog.Errorf("failed to get result of update/create of api %s : %v\n", apiName, err.Error())
      return err
  }
  klog.Infof("APIM update of api %s complete. APIM status: %s\n", apiName, apiContract.Status)
  
  return nil
  }

This is the setting that was expected to be unchecked in the API.

[ArcturusZhang]

Hi @codyseavey I just tried this api with similar code you posted here, everything is fine. I tweaked your code a little bit.

apiParameters := &apimanagement.APICreateOrUpdateParameter{
        APICreateOrUpdateProperties: &apimanagement.APICreateOrUpdateProperties{
            DisplayName:          &apiName,
            Value:                &content,
            // Format:               apimanagement.Openapijson, // I removed this to by pass the constraints
            Path:                 &apiName,
            Protocols:            &[]apimanagement.Protocol{"https"},
            SubscriptionRequired: to.BoolPtr(false), // you will need to import "github.com/Azure/go-autorest/autorest/to" here
        },
    }

After executed this piece of code, I use rest api GET to verify the SubscriptionRequired field, which is false. Please have a try. If you have further questions, please feel free to comment below, I will reopen this issue then.

[ghost]

Thanks for working with Microsoft on GitHub! Tell us how you feel about your experience using the reactions on this comment.