Skip to content

arm-post-operation-response-codes

Id
@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes

Ensure post operations have the appropriate status codes.

Impact

Section titled “Impact”
  • Area: API

The POST operation returns response codes that violate the RPC contract.

LintDiff Equivalent

Section titled “LintDiff Equivalent”

This rule corresponds to the LintDiff rule PostResponseCodes.

Synchronous

Section titled “Synchronous”

Synchronous post operations should have one of the following combinations of responses - 200 and default, or 204 and default. They must have no other responses.

❌ Incorrect

Section titled “❌ Incorrect”
@armResourceOperations
interface Employees {
  @armResourceDelete(Employee)
  delete(...ApiVersionParameter): {
    @statusCode _: 200;
    result: boolean;
  };
}

✅ Correct

Section titled “✅ Correct”
@armResourceOperations
interface Employees {
  delete is ArmResourceDeleteSync<Employee>;
}

Asynchronous

Section titled “Asynchronous”

Long-running (LRO) post operations should have 202 and default responses. The must also have a 200 response only if the final response is intended to have a schema. They must have no other responses. The 202 response must not have a response schema specified.

❌ Incorrect

Section titled “❌ Incorrect”
@armResourceOperations
interface Employees {
  delete is ArmResourceDeleteAsync<Employee>;
}

✅ Correct

Section titled “✅ Correct”
@armResourceOperations
interface Employees {
  delete is ArmResourceDeleteWithoutOkAsync<Employee>;
}

Suppression

Section titled “Suppression”

Suppress only when required to match an existing API; otherwise use the standard resource action or provider action templates.