no-resource-name-conflict

Id

@azure-tools/typespec-azure-resource-manager/no-resource-name-conflict

ARM resources must have unique logical resource names.

Resources must have unique logical names across all ARM services in a program.

The same model can describe several resource occurrences at different scopes or paths. Give each occurrence a unique name when instantiating its operations.

Incorrect

The following example describes RunCommand resources under a VM and under a VM in a scale set. The ARM resource types are Microsoft.Compute/virtualMachines/runCommands and Microsoft.Compute/virtualMachineScaleSets/virtualMachines/runCommands. The legacy operation templates derive their default logical names from the last two resource-type segments, so both occurrences are named VirtualMachinesRunCommands.

These snippets assume VmParameters and ScaleSetVmParameters describe the respective parent paths, and RunCommandParameters adds the runCommands segment and command name parameter.

interface RunCommandOperations<ParentParameters extends {}>
  extends Legacy.LegacyOperations<ParentParameters, RunCommandParameters> {}

alias VmOperations = RunCommandOperations<VmParameters>;
alias ScaleSetVmOperations = RunCommandOperations<ScaleSetVmParameters>;

Correct

Keep the models and paths unchanged. Add a ResourceName parameter to the shared operations template and forward it to Legacy.LegacyOperations. Supply a distinct name when instantiating the template for each resource occurrence. This replaces the operations declarations above:

interface RunCommandOperations<ParentParameters extends {}, ResourceName extends valueof string>
  extends Legacy.LegacyOperations<
      ParentParameters,
      RunCommandParameters,
      ResourceName = ResourceName
    > {}

alias VmOperations = RunCommandOperations<VmParameters, "VmRunCommand">;
alias ScaleSetVmOperations = RunCommandOperations<ScaleSetVmParameters, "ScaleSetVmRunCommand">;

For standard resource operations, specific extensions, legacy templates, and resources at different scopes, see Authoring resource metadata.

Impact

• Area: Emitters, Bicep, provisioning libraries

Downstream consumers use logical resource names as generated type names, file names, or lookup keys. Duplicate names can overwrite or drop resource declarations, producing incorrect Bicep resource metadata, templates, and provisioning libraries even when the HTTP paths are distinct.

Suppression

Do not suppress this rule. Duplicate metadata names make downstream resource consumers incorrect. Provide explicit, unique names on the resource operations instead; this fixes the metadata without changing the wire API.