Strange error deploying API revision

Question

Strange error deploying API revision

Muriuki, Levi M 266

I'm trying to deploy a new revision for an API using bicep. The apiVersion, apiVersionSetId, and apiVersionDescription, are set to null as you can see below, but it keeps failing with this error.

Can't change property ApiVersion for non-current revision.

I really don't understand, this has been working fine until now. I even tried with Rest API and seeing same error..

Here are the API properties that I'm passing:

properties: {
    name: 'Invoices.Services.sandbox;rev=3'
    displayName: 'Invoices.Services.sandbox',
    apiRevision: 3,
    apiVersion: null,
    apiVersionSetId: null,
    apiVersionDescription: null,
    format: swagger-link-json,
    value: <swagger doc link>,
    subscriptionRequired: true,
    serviceUrl: <service url>,
    path: 'sandbox.Invoices',
    protocols: [
        https
    ],
    authenticationSettings: {
        oAuth2: null,
        openid: null
    },
    subscriptionKeyParameterNames: {
        header: 'Ocp-Apim-Subscription-Key',
        query: 'subscription-key'
    },
    isCurrent: false
}

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-15T14:31:38.0833333+00:00

Muriuki, Levi M Just a follow up on the answer below and see if you have any questions. Please accept as "Yes" if the answer is helpful.

Muriuki, Levi M 266

I found a workaround by using union in Bicep, since there's currently no way to check if a property is defined. Here's what worked for me:

``

@description('Optional. Indicates the Version identifier of the API if the API is versioned.')
param apiVersion string = '%empty%' // this can be set to string? once nullable feature is released => https://github.com/Azure/bicep/pull/9454

resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  name: apiRevision > 1 ? '${name};rev=${apiRevision}' : name
  parent: service
  properties: union({
    apiRevision: string(apiRevision)
    apiRevisionDescription: !empty(apiRevisionDescription) ? apiRevisionDescription : null
    apiType: !empty(apiType) ? apiType : null
    authenticationSettings: authenticationSettings
    description: apiDescription
    displayName: displayName
    format: !empty(value) ? format : null
    isCurrent: isCurrent
    path: path
    protocols: protocols
    serviceUrl: !empty(serviceUrl) ? serviceUrl : null
    sourceApiId: !empty(sourceApiId) ? sourceApiId : null
    subscriptionKeyParameterNames: !empty(subscriptionKeyParameterNames) ? subscriptionKeyParameterNames : null
    subscriptionRequired: subscriptionRequired
    type: type
    value: !empty(value) ? value : null
    wsdlSelector: wsdlSelector
  }, apiVersion != '%empty%' ? {
    apiVersion: apiVersion
    apiVersionDescription: apiVersionDescription
    apiVersionSetId: apiVersionSetId
  } : {})
}

``

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-24T03:37:16.7766667+00:00

Muriuki, Levi M Thank you for sharing it with us.

Accepted answer

0 additional answers

Your answer

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-15T14:31:38.0833333+00:00

Muriuki, Levi M Just a follow up on the answer below and see if you have any questions. Please accept as "Yes" if the answer is helpful.
Muriuki, Levi M 266 Reputation points

2023-02-24T02:50:19.1866667+00:00

I found a workaround by using union in Bicep, since there's currently no way to check if a property is defined. Here's what worked for me:

``

@description('Optional. Indicates the Version identifier of the API if the API is versioned.') param apiVersion string = '%empty%' // this can be set to string? once nullable feature is released => https://github.com/Azure/bicep/pull/9454 resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = { name: apiRevision > 1 ? '${name};rev=${apiRevision}' : name parent: service properties: union({ apiRevision: string(apiRevision) apiRevisionDescription: !empty(apiRevisionDescription) ? apiRevisionDescription : null apiType: !empty(apiType) ? apiType : null authenticationSettings: authenticationSettings description: apiDescription displayName: displayName format: !empty(value) ? format : null isCurrent: isCurrent path: path protocols: protocols serviceUrl: !empty(serviceUrl) ? serviceUrl : null sourceApiId: !empty(sourceApiId) ? sourceApiId : null subscriptionKeyParameterNames: !empty(subscriptionKeyParameterNames) ? subscriptionKeyParameterNames : null subscriptionRequired: subscriptionRequired type: type value: !empty(value) ? value : null wsdlSelector: wsdlSelector }, apiVersion != '%empty%' ? { apiVersion: apiVersion apiVersionDescription: apiVersionDescription apiVersionSetId: apiVersionSetId } : {}) }

``
MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-24T03:37:16.7766667+00:00

Muriuki, Levi M Thank you for sharing it with us.

Answer 1

Muriuki, Levi M Thank you for posting your question in Microsoft Q&A. Based on error message Can't change property ApiVersion for non-current revision., it appears that you are trying to modify ApiVersion property in non-current revision (isCurrent as false) with bicep.

API version cannot be edited for a non-current revision and please review Revision descriptions for the list of the properties that cannot be edited (similar thread: https://learn.microsoft.com/en-us/answers/questions/1062269/cannot-update-api-description-for-an-api-revision posted by you).

Validate if Invoices.Services.sandbox is versioned API for which API version is not null using https://learn.microsoft.com/en-us/rest/api/apimanagement/current-ga/apis/get?tabs=HTTP. If the value is null, and still face the issue, we might have to review the payload to understand more and investigate the issue (I couldn't repro this issue in my APIM). In such case, you would have to create a ticket to support team to share the payload info/details.

I hope this helps your question and feel free to add a comment for any other questions. Would be happy to answer if any.

MuthuKumaranMurugaachari-MSFT 22,416 Reputation points

2023-02-23T16:35:29.86+00:00

Muriuki, Levi M I'm reaching out to see if you have any questions regarding the information provided. If you found the answer helpful, please consider marking it as "Yes".

Share via

Strange error deploying API revision

0 additional answers

Your answer