UNPKG

@azure-tools/typespec-azure-resource-manager

Version:

TypeSpec Azure Resource Manager library

313 lines 20.8 kB
export declare const $lib: import("@typespec/compiler").TypeSpecLibrary<{ "decorator-param-wrong-type": { readonly armUpdateProviderNamespace: "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."; readonly armIdentifiersIncorrectEntity: "The @identifiers decorator must be applied to a property that is an array of objects"; readonly armIdentifiersProperties: "The @identifiers decorator expects a parameter that is an array of strings or an empty array."; }; "arm-resource-circular-ancestry": { readonly 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."; }; "arm-resource-duplicate-base-parameter": { readonly default: "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-missing-name-property": { readonly default: "Resource types must include a string property called 'name'."; }; "arm-resource-missing-name-key-decorator": { readonly default: "Resource type 'name' property must have a @key decorator which defines its key name."; }; "arm-resource-missing-name-segment-decorator": { readonly default: "Resource type 'name' property must have a @segment decorator which defines its path fragment."; }; "arm-resource-missing-arm-namespace": { readonly default: "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-invalid-base-type": { readonly default: "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."; }; "arm-resource-missing": { readonly default: import("@typespec/compiler").CallableMessage<["type"]>; }; "arm-common-types-incompatible-version": { readonly default: import("@typespec/compiler").CallableMessage<["selectedVersion", "supportedVersions"]>; }; "arm-common-types-invalid-version": { readonly default: import("@typespec/compiler").CallableMessage<["versionString", "supportedVersions"]>; }; "decorator-in-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["decoratorName"]>; }; "parent-type": { readonly notResourceType: import("@typespec/compiler").CallableMessage<["parent", "type"]>; }; "resource-without-path-and-segment": { readonly default: "Resource types must have a property with '@path` and '@segment' decorators."; }; "resource-without-provider-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>; }; "template-type-constraint-no-met": { readonly default: import("@typespec/compiler").CallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>; }; "invalid-parameter-rename": { readonly overwrite: import("@typespec/compiler").CallableMessage<["oldName", "newName", "newName"]>; readonly missing: import("@typespec/compiler").CallableMessage<["oldName"]>; readonly notpath: import("@typespec/compiler").CallableMessage<["oldName"]>; }; "legacy-type-usage": { readonly default: "This type is meant for conversion of legacy service APIs. This type should not be used in new service APIs."; }; "invalid-version-for-common-type": { readonly default: import("@typespec/compiler").CallableMessage<["version", "resourceName", "requiredVersion"]>; }; }, Record<string, any>, never>; export declare const reportDiagnostic: <C extends "decorator-param-wrong-type" | "arm-resource-circular-ancestry" | "arm-resource-duplicate-base-parameter" | "arm-resource-missing-name-property" | "arm-resource-missing-name-key-decorator" | "arm-resource-missing-name-segment-decorator" | "arm-resource-missing-arm-namespace" | "arm-resource-invalid-base-type" | "arm-resource-missing" | "arm-common-types-incompatible-version" | "arm-common-types-invalid-version" | "decorator-in-namespace" | "parent-type" | "resource-without-path-and-segment" | "resource-without-provider-namespace" | "template-type-constraint-no-met" | "invalid-parameter-rename" | "legacy-type-usage" | "invalid-version-for-common-type", M extends keyof { "decorator-param-wrong-type": { readonly armUpdateProviderNamespace: "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."; readonly armIdentifiersIncorrectEntity: "The @identifiers decorator must be applied to a property that is an array of objects"; readonly armIdentifiersProperties: "The @identifiers decorator expects a parameter that is an array of strings or an empty array."; }; "arm-resource-circular-ancestry": { readonly 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."; }; "arm-resource-duplicate-base-parameter": { readonly default: "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-missing-name-property": { readonly default: "Resource types must include a string property called 'name'."; }; "arm-resource-missing-name-key-decorator": { readonly default: "Resource type 'name' property must have a @key decorator which defines its key name."; }; "arm-resource-missing-name-segment-decorator": { readonly default: "Resource type 'name' property must have a @segment decorator which defines its path fragment."; }; "arm-resource-missing-arm-namespace": { readonly default: "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-invalid-base-type": { readonly default: "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."; }; "arm-resource-missing": { readonly default: import("@typespec/compiler").CallableMessage<["type"]>; }; "arm-common-types-incompatible-version": { readonly default: import("@typespec/compiler").CallableMessage<["selectedVersion", "supportedVersions"]>; }; "arm-common-types-invalid-version": { readonly default: import("@typespec/compiler").CallableMessage<["versionString", "supportedVersions"]>; }; "decorator-in-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["decoratorName"]>; }; "parent-type": { readonly notResourceType: import("@typespec/compiler").CallableMessage<["parent", "type"]>; }; "resource-without-path-and-segment": { readonly default: "Resource types must have a property with '@path` and '@segment' decorators."; }; "resource-without-provider-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>; }; "template-type-constraint-no-met": { readonly default: import("@typespec/compiler").CallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>; }; "invalid-parameter-rename": { readonly overwrite: import("@typespec/compiler").CallableMessage<["oldName", "newName", "newName"]>; readonly missing: import("@typespec/compiler").CallableMessage<["oldName"]>; readonly notpath: import("@typespec/compiler").CallableMessage<["oldName"]>; }; "legacy-type-usage": { readonly default: "This type is meant for conversion of legacy service APIs. This type should not be used in new service APIs."; }; "invalid-version-for-common-type": { readonly default: import("@typespec/compiler").CallableMessage<["version", "resourceName", "requiredVersion"]>; }; }[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{ "decorator-param-wrong-type": { readonly armUpdateProviderNamespace: "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."; readonly armIdentifiersIncorrectEntity: "The @identifiers decorator must be applied to a property that is an array of objects"; readonly armIdentifiersProperties: "The @identifiers decorator expects a parameter that is an array of strings or an empty array."; }; "arm-resource-circular-ancestry": { readonly 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."; }; "arm-resource-duplicate-base-parameter": { readonly default: "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-missing-name-property": { readonly default: "Resource types must include a string property called 'name'."; }; "arm-resource-missing-name-key-decorator": { readonly default: "Resource type 'name' property must have a @key decorator which defines its key name."; }; "arm-resource-missing-name-segment-decorator": { readonly default: "Resource type 'name' property must have a @segment decorator which defines its path fragment."; }; "arm-resource-missing-arm-namespace": { readonly default: "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-invalid-base-type": { readonly default: "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."; }; "arm-resource-missing": { readonly default: import("@typespec/compiler").CallableMessage<["type"]>; }; "arm-common-types-incompatible-version": { readonly default: import("@typespec/compiler").CallableMessage<["selectedVersion", "supportedVersions"]>; }; "arm-common-types-invalid-version": { readonly default: import("@typespec/compiler").CallableMessage<["versionString", "supportedVersions"]>; }; "decorator-in-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["decoratorName"]>; }; "parent-type": { readonly notResourceType: import("@typespec/compiler").CallableMessage<["parent", "type"]>; }; "resource-without-path-and-segment": { readonly default: "Resource types must have a property with '@path` and '@segment' decorators."; }; "resource-without-provider-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>; }; "template-type-constraint-no-met": { readonly default: import("@typespec/compiler").CallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>; }; "invalid-parameter-rename": { readonly overwrite: import("@typespec/compiler").CallableMessage<["oldName", "newName", "newName"]>; readonly missing: import("@typespec/compiler").CallableMessage<["oldName"]>; readonly notpath: import("@typespec/compiler").CallableMessage<["oldName"]>; }; "legacy-type-usage": { readonly default: "This type is meant for conversion of legacy service APIs. This type should not be used in new service APIs."; }; "invalid-version-for-common-type": { readonly default: import("@typespec/compiler").CallableMessage<["version", "resourceName", "requiredVersion"]>; }; }, C, M>) => void, createDiagnostic: <C extends "decorator-param-wrong-type" | "arm-resource-circular-ancestry" | "arm-resource-duplicate-base-parameter" | "arm-resource-missing-name-property" | "arm-resource-missing-name-key-decorator" | "arm-resource-missing-name-segment-decorator" | "arm-resource-missing-arm-namespace" | "arm-resource-invalid-base-type" | "arm-resource-missing" | "arm-common-types-incompatible-version" | "arm-common-types-invalid-version" | "decorator-in-namespace" | "parent-type" | "resource-without-path-and-segment" | "resource-without-provider-namespace" | "template-type-constraint-no-met" | "invalid-parameter-rename" | "legacy-type-usage" | "invalid-version-for-common-type", M extends keyof { "decorator-param-wrong-type": { readonly armUpdateProviderNamespace: "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."; readonly armIdentifiersIncorrectEntity: "The @identifiers decorator must be applied to a property that is an array of objects"; readonly armIdentifiersProperties: "The @identifiers decorator expects a parameter that is an array of strings or an empty array."; }; "arm-resource-circular-ancestry": { readonly 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."; }; "arm-resource-duplicate-base-parameter": { readonly default: "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-missing-name-property": { readonly default: "Resource types must include a string property called 'name'."; }; "arm-resource-missing-name-key-decorator": { readonly default: "Resource type 'name' property must have a @key decorator which defines its key name."; }; "arm-resource-missing-name-segment-decorator": { readonly default: "Resource type 'name' property must have a @segment decorator which defines its path fragment."; }; "arm-resource-missing-arm-namespace": { readonly default: "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-invalid-base-type": { readonly default: "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."; }; "arm-resource-missing": { readonly default: import("@typespec/compiler").CallableMessage<["type"]>; }; "arm-common-types-incompatible-version": { readonly default: import("@typespec/compiler").CallableMessage<["selectedVersion", "supportedVersions"]>; }; "arm-common-types-invalid-version": { readonly default: import("@typespec/compiler").CallableMessage<["versionString", "supportedVersions"]>; }; "decorator-in-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["decoratorName"]>; }; "parent-type": { readonly notResourceType: import("@typespec/compiler").CallableMessage<["parent", "type"]>; }; "resource-without-path-and-segment": { readonly default: "Resource types must have a property with '@path` and '@segment' decorators."; }; "resource-without-provider-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>; }; "template-type-constraint-no-met": { readonly default: import("@typespec/compiler").CallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>; }; "invalid-parameter-rename": { readonly overwrite: import("@typespec/compiler").CallableMessage<["oldName", "newName", "newName"]>; readonly missing: import("@typespec/compiler").CallableMessage<["oldName"]>; readonly notpath: import("@typespec/compiler").CallableMessage<["oldName"]>; }; "legacy-type-usage": { readonly default: "This type is meant for conversion of legacy service APIs. This type should not be used in new service APIs."; }; "invalid-version-for-common-type": { readonly default: import("@typespec/compiler").CallableMessage<["version", "resourceName", "requiredVersion"]>; }; }[C]>(diag: import("@typespec/compiler").DiagnosticReport<{ "decorator-param-wrong-type": { readonly armUpdateProviderNamespace: "The parameter to @armUpdateProviderNamespace must be an operation with a 'provider' parameter."; readonly armIdentifiersIncorrectEntity: "The @identifiers decorator must be applied to a property that is an array of objects"; readonly armIdentifiersProperties: "The @identifiers decorator expects a parameter that is an array of strings or an empty array."; }; "arm-resource-circular-ancestry": { readonly 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."; }; "arm-resource-duplicate-base-parameter": { readonly default: "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-missing-name-property": { readonly default: "Resource types must include a string property called 'name'."; }; "arm-resource-missing-name-key-decorator": { readonly default: "Resource type 'name' property must have a @key decorator which defines its key name."; }; "arm-resource-missing-name-segment-decorator": { readonly default: "Resource type 'name' property must have a @segment decorator which defines its path fragment."; }; "arm-resource-missing-arm-namespace": { readonly default: "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-invalid-base-type": { readonly default: "The @armResourceInternal decorator can only be used on a type that ultimately extends TrackedResource, ProxyResource, or ExtensionResource."; }; "arm-resource-missing": { readonly default: import("@typespec/compiler").CallableMessage<["type"]>; }; "arm-common-types-incompatible-version": { readonly default: import("@typespec/compiler").CallableMessage<["selectedVersion", "supportedVersions"]>; }; "arm-common-types-invalid-version": { readonly default: import("@typespec/compiler").CallableMessage<["versionString", "supportedVersions"]>; }; "decorator-in-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["decoratorName"]>; }; "parent-type": { readonly notResourceType: import("@typespec/compiler").CallableMessage<["parent", "type"]>; }; "resource-without-path-and-segment": { readonly default: "Resource types must have a property with '@path` and '@segment' decorators."; }; "resource-without-provider-namespace": { readonly default: import("@typespec/compiler").CallableMessage<["resourceName"]>; }; "template-type-constraint-no-met": { readonly default: import("@typespec/compiler").CallableMessage<["sourceType", "entity", "constraintType", "actionMessage"]>; }; "invalid-parameter-rename": { readonly overwrite: import("@typespec/compiler").CallableMessage<["oldName", "newName", "newName"]>; readonly missing: import("@typespec/compiler").CallableMessage<["oldName"]>; readonly notpath: import("@typespec/compiler").CallableMessage<["oldName"]>; }; "legacy-type-usage": { readonly default: "This type is meant for conversion of legacy service APIs. This type should not be used in new service APIs."; }; "invalid-version-for-common-type": { readonly default: import("@typespec/compiler").CallableMessage<["version", "resourceName", "requiredVersion"]>; }; }, C, M>) => import("@typespec/compiler").Diagnostic; //# sourceMappingURL=lib.d.ts.map