get-operation-must-not-be-long-running.md

GetOperationMustNotBeLongRunning

Category

ARM Error

Applies to

ARM OpenAPI(swagger) specs

Related ARM Guideline Code

• RPC-Get-V1-14

Output Message

The GET operation cannot be long running. It must not have the x-ms-long-running-operation and x-ms-long-running-operation-options properties defined.

Description

Only asynchronous(i.e. Long Running Operation) can have x-ms-long-running-operation-options property. The GET calls are synchronous and it MUST NOT have - x-ms-long-running-operation-options property block - x-ms-long-running-operation set to true

How to fix the violation

Ensure that the GET operation does not have x-ms-long-running-operation and x-ms-long-running-operation-options properties defined.

Please remove the following invalid block:

...
 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MyNameSpace/MyResourceType/{Name}": {
    "get": {
      ...
      ...
      "responses": {
        "200": {
            ...
            }
          }
      // Remove
      "x-ms-long-running-operation": true,
      // Remove this block
      "x-ms-long-running-operation-options": {
        "final-state-via": "azure-async-operation",
      },
    }
 }
...
...

The following is Valid

```json
...
 "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MyNameSpace/MyResourceType/{Name}": {
    "get": {
      ...
      ...
      "responses": {
        "200": {
            ...
            }
          }
      "x-ms-long-running-operation": false,
    }
 }
...
...