@azure-tools/typespec-azure-resource-manager 0.71.0-dev.9 → 0.72.0-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/generated-defs/Azure.ResourceManager.BaseTypes.d.ts +1 -1
- package/dist/src/base-types.d.ts +1 -1
- package/dist/src/base-types.d.ts.map +1 -1
- package/dist/src/common-types.d.ts +4 -4
- package/dist/src/common-types.d.ts.map +1 -1
- package/dist/src/commontypes.private.decorators.d.ts +2 -2
- package/dist/src/commontypes.private.decorators.d.ts.map +1 -1
- package/dist/src/linter.d.ts.map +1 -1
- package/dist/src/linter.js +6 -2
- package/dist/src/linter.js.map +1 -1
- package/dist/src/namespace.d.ts +2 -2
- package/dist/src/namespace.d.ts.map +1 -1
- package/dist/src/operations.d.ts +4 -4
- package/dist/src/operations.d.ts.map +1 -1
- package/dist/src/operations.js.map +1 -1
- package/dist/src/private.decorators.d.ts +2 -2
- package/dist/src/private.decorators.d.ts.map +1 -1
- package/dist/src/resource.d.ts +4 -4
- package/dist/src/resource.d.ts.map +1 -1
- package/dist/src/rules/arm-agent-base-type-child-resources.js.map +1 -1
- package/dist/src/rules/arm-agent-base-type-lifecycle-operations.js.map +1 -1
- package/dist/src/rules/arm-common-types-version.js.map +1 -1
- package/dist/src/rules/arm-custom-resource-no-key.js.map +1 -1
- package/dist/src/rules/arm-custom-resource-usage-discourage.d.ts.map +1 -1
- package/dist/src/rules/arm-custom-resource-usage-discourage.js +1 -1
- package/dist/src/rules/arm-custom-resource-usage-discourage.js.map +1 -1
- package/dist/src/rules/arm-delete-response-codes.js.map +1 -1
- package/dist/src/rules/arm-feature-file-usage-discourage.js.map +1 -1
- package/dist/src/rules/arm-legacy-operations-discourage.js.map +1 -1
- package/dist/src/rules/arm-post-response-codes.js.map +1 -1
- package/dist/src/rules/arm-put-response-codes.js.map +1 -1
- package/dist/src/rules/arm-resource-action-no-segment.js.map +1 -1
- package/dist/src/rules/arm-resource-interfaces.js.map +1 -1
- package/dist/src/rules/arm-resource-invalid-action-verb.js.map +1 -1
- package/dist/src/rules/arm-resource-invalid-envelope-property.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-invalid-envelope-property.js +1 -1
- package/dist/src/rules/arm-resource-invalid-envelope-property.js.map +1 -1
- package/dist/src/rules/arm-resource-invalid-version-format.js.map +1 -1
- package/dist/src/rules/arm-resource-operation-response.js.map +1 -1
- package/dist/src/rules/arm-resource-path-invalid-chars.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-path-invalid-chars.js +1 -1
- package/dist/src/rules/arm-resource-path-invalid-chars.js.map +1 -1
- package/dist/src/rules/arm-resource-provisioning-state-rule.d.ts.map +1 -1
- package/dist/src/rules/arm-resource-provisioning-state-rule.js +1 -1
- package/dist/src/rules/arm-resource-provisioning-state-rule.js.map +1 -1
- package/dist/src/rules/beyond-nesting-levels.js.map +1 -1
- package/dist/src/rules/envelope-properties.js.map +1 -1
- package/dist/src/rules/improper-subscription-list-operation.js.map +1 -1
- package/dist/src/rules/lro-location-header.js.map +1 -1
- package/dist/src/rules/no-empty-model.js.map +1 -1
- package/dist/src/rules/no-reserved-resource-property.js.map +1 -1
- package/dist/src/rules/no-resource-delete-operation.js.map +1 -1
- package/dist/src/rules/no-response-body.d.ts.map +1 -1
- package/dist/src/rules/no-response-body.js +1 -1
- package/dist/src/rules/no-response-body.js.map +1 -1
- package/dist/src/rules/patch-envelope-properties.d.ts.map +1 -1
- package/dist/src/rules/patch-envelope-properties.js +1 -1
- package/dist/src/rules/patch-envelope-properties.js.map +1 -1
- package/dist/src/rules/retry-after.js.map +1 -1
- package/dist/src/rules/use-api-version.d.ts +4 -0
- package/dist/src/rules/use-api-version.d.ts.map +1 -0
- package/dist/src/rules/use-api-version.js +45 -0
- package/dist/src/rules/use-api-version.js.map +1 -0
- package/dist/src/rules/use-interface.d.ts +4 -0
- package/dist/src/rules/use-interface.d.ts.map +1 -0
- package/dist/src/rules/use-interface.js +29 -0
- package/dist/src/rules/use-interface.js.map +1 -0
- package/dist/src/rules/use-operation-decorator.d.ts +5 -0
- package/dist/src/rules/use-operation-decorator.d.ts.map +1 -0
- package/dist/src/rules/use-operation-decorator.js +133 -0
- package/dist/src/rules/use-operation-decorator.js.map +1 -0
- package/dist/src/rules/use-relationship-required-properties.d.ts.map +1 -1
- package/dist/src/rules/use-relationship-required-properties.js +1 -1
- package/dist/src/rules/use-relationship-required-properties.js.map +1 -1
- package/dist/src/rules/utils.d.ts +2 -2
- package/dist/src/rules/utils.d.ts.map +1 -1
- package/dist/src/rules/utils.js.map +1 -1
- package/dist/src/rules/version-progression.d.ts.map +1 -1
- package/dist/src/rules/version-progression.js +1 -1
- package/dist/src/rules/version-progression.js.map +1 -1
- package/dist/src/testing/index.d.ts +1 -1
- package/dist/src/testing/index.d.ts.map +1 -1
- package/lib/base-types/agent.tsp +3 -10
- package/lib/base-types/base-types.tsp +1 -1
- package/lib/common-types/billing-data.tsp +211 -0
- package/lib/common-types/common-types.tsp +1 -1
- package/lib/common-types/managed-identity-with-delegation.tsp +1 -0
- package/lib/common-types/network-security-perimeter.tsp +29 -0
- package/lib/common-types/types.tsp +5 -0
- package/lib/extension/parameters.tsp +2 -0
- package/lib/foundations/arm.foundations.tsp +1 -0
- package/lib/interfaces.tsp +2 -24
- package/lib/legacy-types/resource.tsp +1 -0
- package/lib/models.tsp +19 -1
- package/lib/private-endpoints.tsp +0 -2
- package/lib/private-links.tsp +0 -5
- package/package.json +15 -15
- package/dist/src/rules/core-operations.d.ts +0 -6
- package/dist/src/rules/core-operations.d.ts.map +0 -1
- package/dist/src/rules/core-operations.js +0 -105
- package/dist/src/rules/core-operations.js.map +0 -1
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
import { createRule, fileRef, isTemplateInstance, paramMessage, } from "@typespec/compiler";
|
|
2
|
-
import { SyntaxKind } from "@typespec/compiler/ast";
|
|
3
|
-
import { getOperationVerb } from "@typespec/http";
|
|
4
|
-
import { getSegment } from "@typespec/rest";
|
|
5
|
-
import { getNamespaceName, getSourceModel, isSourceOperationResourceManagerInternal, isTemplatedInterfaceOperation, } from "./utils.js";
|
|
6
|
-
export const coreOperationsRule = createRule({
|
|
7
|
-
name: "arm-resource-operation",
|
|
8
|
-
docs: fileRef.fromPackageRoot("src/rules/arm-resource-operation.md"),
|
|
9
|
-
severity: "warning",
|
|
10
|
-
description: "Validate ARM Resource operations.",
|
|
11
|
-
url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/arm-resource-operation",
|
|
12
|
-
messages: {
|
|
13
|
-
default: "All Resource operations must use an api-version parameter. Please include Azure.ResourceManager.ApiVersionParameter in the operation parameter list using the spread (...ApiVersionParameter) operator, or using one of the common resource parameter models.",
|
|
14
|
-
opOutsideInterface: "All operations must be inside an interface declaration.",
|
|
15
|
-
opMissingDecorator: paramMessage `Resource ${"verb"} operation must be decorated with ${"decorator"}.`,
|
|
16
|
-
},
|
|
17
|
-
create(context) {
|
|
18
|
-
return {
|
|
19
|
-
operation: (operation) => {
|
|
20
|
-
if (!isSourceOperationResourceManagerInternal(operation) &&
|
|
21
|
-
!isTemplateInstance(operation)) {
|
|
22
|
-
const verb = getOperationVerb(context.program, operation);
|
|
23
|
-
if (!isTemplatedInterfaceOperation(operation) &&
|
|
24
|
-
(!operation.node?.parent ||
|
|
25
|
-
operation.node.parent.kind !== SyntaxKind.InterfaceStatement)) {
|
|
26
|
-
context.reportDiagnostic({
|
|
27
|
-
messageId: "opOutsideInterface",
|
|
28
|
-
target: operation,
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
const parameters = operation.parameters;
|
|
32
|
-
if (parameters === undefined ||
|
|
33
|
-
parameters === null ||
|
|
34
|
-
!hasApiParameter(context.program, parameters)) {
|
|
35
|
-
context.reportDiagnostic({
|
|
36
|
-
target: operation,
|
|
37
|
-
});
|
|
38
|
-
}
|
|
39
|
-
if (verb) {
|
|
40
|
-
const requiredDecorators = resourceOperationDecorators[verb];
|
|
41
|
-
if (requiredDecorators?.length > 0) {
|
|
42
|
-
const decorator = operation.decorators.find((d) => requiredDecorators.indexOf(d.decorator.name) >= 0);
|
|
43
|
-
if (!decorator && !isArmProviderOperation(context.program, operation)) {
|
|
44
|
-
context.reportDiagnostic({
|
|
45
|
-
messageId: "opMissingDecorator",
|
|
46
|
-
target: operation,
|
|
47
|
-
format: {
|
|
48
|
-
verb: verb.toUpperCase(),
|
|
49
|
-
decorator: requiredDecorators.map((d) => `@${d.substring(1)}`).join(" or "),
|
|
50
|
-
},
|
|
51
|
-
});
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
},
|
|
57
|
-
};
|
|
58
|
-
},
|
|
59
|
-
});
|
|
60
|
-
const resourceOperationDecorators = {
|
|
61
|
-
put: ["$armResourceCreateOrUpdate"],
|
|
62
|
-
get: ["$armResourceRead", "$armResourceList"],
|
|
63
|
-
patch: ["$armResourceUpdate"],
|
|
64
|
-
delete: ["$armResourceDelete"],
|
|
65
|
-
post: ["$armResourceAction", "$armResourceCollectionAction"],
|
|
66
|
-
head: [],
|
|
67
|
-
};
|
|
68
|
-
function isApiParameter(program, property) {
|
|
69
|
-
if (property.type.kind !== "Scalar")
|
|
70
|
-
return false;
|
|
71
|
-
if (!property.sourceProperty)
|
|
72
|
-
return false;
|
|
73
|
-
const sourceModel = getSourceModel(property.sourceProperty);
|
|
74
|
-
if (sourceModel === undefined)
|
|
75
|
-
return false;
|
|
76
|
-
return (sourceModel.name === "ApiVersionParameter" &&
|
|
77
|
-
getNamespaceName(program, sourceModel) === "Azure.ResourceManager.CommonTypes");
|
|
78
|
-
}
|
|
79
|
-
function hasApiParameter(program, model) {
|
|
80
|
-
if (model.properties === undefined || model.properties.size === 0)
|
|
81
|
-
return false;
|
|
82
|
-
const apiVersionParams = [...model.properties.values()].filter((i) => isApiParameter(program, i));
|
|
83
|
-
return apiVersionParams !== null && apiVersionParams.length === 1;
|
|
84
|
-
}
|
|
85
|
-
function isStaticSegment(segment, property) {
|
|
86
|
-
return segment === undefined || segment === "locations";
|
|
87
|
-
}
|
|
88
|
-
function isArmProviderOperation(program, operation) {
|
|
89
|
-
let isProviderAction = false;
|
|
90
|
-
for (const [index, [, property]] of [...operation.parameters.properties].entries()) {
|
|
91
|
-
const segment = getSegment(program, property);
|
|
92
|
-
if (segment === "providers") {
|
|
93
|
-
isProviderAction = true;
|
|
94
|
-
}
|
|
95
|
-
else if (isProviderAction && !isStaticSegment(segment, property)) {
|
|
96
|
-
return false;
|
|
97
|
-
}
|
|
98
|
-
const isLastSegment = index === operation.parameters.properties.size - 1;
|
|
99
|
-
if (isLastSegment && !segment) {
|
|
100
|
-
return true;
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
return false;
|
|
104
|
-
}
|
|
105
|
-
//# sourceMappingURL=core-operations.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"core-operations.js","sourceRoot":"","sources":["../../../src/rules/core-operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,UAAU,EACV,OAAO,EACP,kBAAkB,EAClB,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAY,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,wCAAwC,EACxC,6BAA6B,GAC9B,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IAC3C,IAAI,EAAE,wBAAwB;IAC9B,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,qCAAqC,CAAC;IACpE,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,mCAAmC;IAChD,GAAG,EAAE,2GAA2G;IAChH,QAAQ,EAAE;QACR,OAAO,EACL,+PAA+P;QACjQ,kBAAkB,EAAE,yDAAyD;QAC7E,kBAAkB,EAAE,YAAY,CAAA,YAAY,MAAM,qCAAqC,WAAW,GAAG;KACtG;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,SAAS,EAAE,CAAC,SAAoB,EAAE,EAAE;gBAClC,IACE,CAAC,wCAAwC,CAAC,SAAS,CAAC;oBACpD,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAC9B,CAAC;oBACD,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;oBAC1D,IACE,CAAC,6BAA6B,CAAC,SAAS,CAAC;wBACzC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM;4BACtB,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,kBAAkB,CAAC,EAC/D,CAAC;wBACD,OAAO,CAAC,gBAAgB,CAAC;4BACvB,SAAS,EAAE,oBAAoB;4BAC/B,MAAM,EAAE,SAAS;yBAClB,CAAC,CAAC;oBACL,CAAC;oBACD,MAAM,UAAU,GAAU,SAAS,CAAC,UAAU,CAAC;oBAC/C,IACE,UAAU,KAAK,SAAS;wBACxB,UAAU,KAAK,IAAI;wBACnB,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,EAC7C,CAAC;wBACD,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,SAAS;yBAClB,CAAC,CAAC;oBACL,CAAC;oBACD,IAAI,IAAI,EAAE,CAAC;wBACT,MAAM,kBAAkB,GAAG,2BAA2B,CAAC,IAAI,CAAC,CAAC;wBAC7D,IAAI,kBAAkB,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;4BACnC,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CACzC,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CACzD,CAAC;4BACF,IAAI,CAAC,SAAS,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;gCACtE,OAAO,CAAC,gBAAgB,CAAC;oCACvB,SAAS,EAAE,oBAAoB;oCAC/B,MAAM,EAAE,SAAS;oCACjB,MAAM,EAAE;wCACN,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE;wCACxB,SAAS,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;qCAC5E;iCACF,CAAC,CAAC;4BACL,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,2BAA2B,GAAqC;IACpE,GAAG,EAAE,CAAC,4BAA4B,CAAC;IACnC,GAAG,EAAE,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAC7C,KAAK,EAAE,CAAC,oBAAoB,CAAC;IAC7B,MAAM,EAAE,CAAC,oBAAoB,CAAC;IAC9B,IAAI,EAAE,CAAC,oBAAoB,EAAE,8BAA8B,CAAC;IAC5D,IAAI,EAAE,EAAE;CACT,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB,EAAE,QAAuB;IAC/D,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAClD,IAAI,CAAC,QAAQ,CAAC,cAAc;QAAE,OAAO,KAAK,CAAC;IAC3C,MAAM,WAAW,GAAsB,cAAc,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC/E,IAAI,WAAW,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IAC5C,OAAO,CACL,WAAW,CAAC,IAAI,KAAK,qBAAqB;QAC1C,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,mCAAmC,CAC/E,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB,EAAE,KAAY;IACrD,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAChF,MAAM,gBAAgB,GAAoB,CAAC,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CACpF,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAC3B,CAAC;IACF,OAAO,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,SAAS,eAAe,CAAC,OAA2B,EAAE,QAAuB;IAC3E,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,WAAW,CAAC;AAC1D,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAgB,EAAE,SAAoB;IACpE,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAE7B,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC;QACnF,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE9C,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;YAC5B,gBAAgB,GAAG,IAAI,CAAC;QAC1B,CAAC;aAAM,IAAI,gBAAgB,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,aAAa,GAAG,KAAK,KAAK,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,CAAC;QACzE,IAAI,aAAa,IAAI,CAAC,OAAO,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
|