Skip to content

lro-location-header

Id
@azure-tools/typespec-azure-resource-manager/lro-location-header

A 202 response should include a Location response header.

The header tells clients where to poll after a 202 response from a long-running operation.

Impact

Section titled “Impact”
  • Area: API

A long-running operation without the standard Location header violates the RPC contract.

LintDiff Equivalent

Section titled “LintDiff Equivalent”

This rule corresponds to the LintDiff rule LroLocationHeader.

❌ Incorrect

Section titled “❌ Incorrect”
@armResourceOperations
interface Employees {
  delete is ArmResourceDeleteWithoutOkAsync<Employee, EmployeeProperties, LroHeaders = {}>;
}

✅ Correct

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

Suppression

Section titled “Suppression”

Suppress per the RPC guidelines; otherwise use the standard Async templates.