Skip to content

[V] $lib

const $lib: TypeSpecLibrary<object, Record<string, any>, never>;

Type declaration

NameTypeDefault value
arm-common-types-incompatible-versionobject-
arm-common-types-incompatible-version.defaultCallableMessage<["selectedVersion", "supportedVersions"]>-
arm-common-types-invalid-versionobject-
arm-common-types-invalid-version.defaultCallableMessage<["versionString", "supportedVersions"]>-
arm-resource-circular-ancestryobject-
arm-resource-circular-ancestry.default”There is a loop in the ancestry of this resource. Please ensure that the `@parentResource` decorator contains the correct parent resource, and that parentage contains no cycles.""There is a loop in the ancestry of this resource. Please ensure that the `@parentResource` decorator contains the correct parent resource, and that parentage contains no cycles.”
arm-resource-duplicate-base-parameterobject-
arm-resource-duplicate-base-parameter.default”Only one base parameter type is allowed per resource. Each resource may have only one of `@parentResource`, `@resourceGroupResource`, `@tenantResource`, `@locationResource`, or `@subscriptionResource` decorators.""Only one base parameter type is allowed per resource. Each resource may have only one of `@parentResource`, `@resourceGroupResource`, `@tenantResource`, `@locationResource`, or `@subscriptionResource` decorators.”
arm-resource-invalid-base-typeobject-
arm-resource-invalid-base-type.default"The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."”The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource.”
arm-resource-missingobject-
arm-resource-missing.defaultCallableMessage<["type"]>-
arm-resource-missing-arm-namespaceobject-
arm-resource-missing-arm-namespace.default"The @armProviderNamespace decorator must be used to define the ARM namespace of the service. This is best applied to the file-level namespace."”The @armProviderNamespace decorator must be used to define the ARM namespace of the service. This is best applied to the file-level namespace.”
arm-resource-missing-name-key-decoratorobject-
arm-resource-missing-name-key-decorator.default"Resource type 'name' property must have a @key decorator which defines its key name."”Resource type ‘name’ property must have a @key decorator which defines its key name.”
arm-resource-missing-name-propertyobject-
arm-resource-missing-name-property.default"Resource types must include a string property called 'name'."”Resource types must include a string property called ‘name’.”
arm-resource-missing-name-segment-decoratorobject-
arm-resource-missing-name-segment-decorator.default"Resource type 'name' property must have a @segment decorator which defines its path fragment."”Resource type ‘name’ property must have a @segment decorator which defines its path fragment.”
decorator-in-namespaceobject-
decorator-in-namespace.defaultCallableMessage<["decoratorName"]>-
decorator-param-wrong-typeobject-
decorator-param-wrong-type.armUpdateProviderNamespace"The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."”The parameter to @armUpdateProviderNamespace must be an operation with a ‘provider’ parameter.”
parent-typeobject-
parent-type.notResourceTypeCallableMessage<["parent", "type"]>-
resource-without-path-and-segmentobject-
resource-without-path-and-segment.default”Resource types must have a property with ‘@path` and ‘@segment’ decorators.""Resource types must have a property with ‘@path` and ‘@segment’ decorators.”
single-arm-providerobject-
single-arm-provider.default"Only one @armProviderNamespace can be declared in a typespec spec at once."”Only one @armProviderNamespace can be declared in a typespec spec at once.”
template-type-constraint-no-metobject-
template-type-constraint-no-met.defaultCallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>-