Skip to content

arm-common-types-version

Full name
@azure-tools/typespec-azure-resource-manager/arm-common-types-version

ARM services must specify the ARM common-types version using the @armCommonTypesVersion decorator. This decorator should be applied either on the service namespace or on each version enum member.

@armProviderNamespace
namespace Microsoft.Contoso;

Apply @armCommonTypesVersion on the namespace:

@armProviderNamespace
@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5)
namespace Microsoft.Contoso;

Apply @armCommonTypesVersion on each version enum member:

@armProviderNamespace
namespace Microsoft.Contoso;
enum Versions {
@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v4)
v1,
@armCommonTypesVersion(Azure.ResourceManager.CommonTypes.Versions.v5)
v2,
}