Skip to content

arm-resource-action-no-segment

Id
@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment

@armResourceAction should not be used with @segment.

If you need to rename the action, use @action(...) instead or omit the segment entirely.

Impact

Section titled “Impact”
  • Area: API, SDK

May indicate a resource action path that does not follow the standard segment layout.

LintDiff Equivalent

Section titled “LintDiff Equivalent”

This rule corresponds to the LintDiff rule PathForResourceAction (partial).

❌ Incorrect

Section titled “❌ Incorrect”
@armResourceAction(MyResource)
@segment("doSomething")
@post
op doAction(...ApiVersionParameter): void;

✅ Correct

Section titled “✅ Correct”
@armResourceAction(MyResource)
@post
op doAction(...ApiVersionParameter): void;

✅ Correct (with custom action name)

Section titled “✅ Correct (with custom action name)”
@armResourceAction(MyResource)
@action("doSomething")
@post
op doAction(...ApiVersionParameter): void;

Suppression

Section titled “Suppression”

Suppress when the resulting path is correct; otherwise use @action to define the final path segment with the standard resource action templates.