Skip to content

arm-resource-invalid-envelope-property

Full name
@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property

Resource envelope properties must originate from the Azure.ResourceManager namespace. Custom properties that are not part of the standard ARM resource envelope should be placed in the resource-specific property bag instead.

❌ Incorrect

Section titled “❌ Incorrect”
@armProviderNamespace
namespace MyService;


model FooResource is TrackedResource<{}> {
  ...ResourceNameParameter<FooResource>;
  disallowed?: string; // not valid in the resource envelope
}

✅ Correct

Section titled “✅ Correct”
@armProviderNamespace
namespace MyService;


model FooResource is TrackedResource<{}> {
  ...ResourceNameParameter<FooResource>;
  ...ManagedServiceIdentityProperty;
}

Reviewer advice

Section titled “Reviewer advice”

Impacts the API: this corresponds to the LintDiff rule BodyTopLevelProperties and causes an RPC violation. Ask the author to use standard property mix-ins. Do not accept a suppression unless it is needed to match existing APIs.