@azure-tools/typespec-azure-resource-manager 0.71.0-dev.1 → 0.71.0-dev.11

package/lib/legacy-types/extension.tsp

@@ -94,7 +94,7 @@ interface ExtensionOperations<
 
   /**
    * A long-running resource Update (PATCH)
-   * @template Resource the resource being created or updated
+   * @template Resource the resource being updated
    * @template PatchModel the PATCH request model
    * @template LroHeaders Optional.  Allows overriding the lro headers returned on resource create
    * @template Parameters Optional. Additional parameters after the path parameters
@@ -134,7 +134,7 @@ interface ExtensionOperations<
 
   /**
    * A synchronous resource Update (PATCH)
-   * @template Resource the resource being created or updated
+   * @template Resource the resource being updated
    * @template PatchModel the PATCH request model
    * @template Parameters Optional. Additional parameters after the path parameters
    * @template Response Optional. The success response(s) for the PATCH operation

package/lib/legacy-types/operations.tsp

@@ -13,7 +13,7 @@ using Rest;
  * is accessible at multiple, fixed resource paths.
  * @template ParentParameters The path parameters for the resource parent
  * @template ResourceTypeParameter The path parameter for the resource name
- * @template ErrorType Optional. The type of error models used in operations created form this template
+ * @template ErrorType Optional. The type of error models used in operations created from this template
  * @template ResourceName Optional. The name of the resource type described in this template
  */
 interface LegacyOperations<
@@ -34,7 +34,7 @@ interface LegacyOperations<
  * is accessible at multiple, fixed resource paths. Can be used with static routes.
  * @template ParentParameters The path parameters for the resource parent
  * @template ResourceTypeParameter The path parameter for the resource name
- * @template ErrorType Optional. The type of error models used in operations created form this template
+ * @template ErrorType Optional. The type of error models used in operations created from this template
  * @template ResourceRoute Optional. The resource route to use for operations in the interface.
  * @template RoutedResourceName Optional. The name of the resource type described in this template
  */
@@ -660,7 +660,7 @@ op CreateOrReplaceSync<
 
 /**
  * A resource list operation, at the subscription scope, that lists only a single page
- * @template Resource the resource being patched
+ * @template Resource the resource being listed
  * @template Parameters Optional. Additional parameters after the path parameters
  * @template Response Optional. The success response for the list operation
  * @template Error Optional. The error response, if non-standard.
@@ -681,7 +681,7 @@ op ArmListSinglePageBySubscription<
 
 /**
  * A resource list operation, at the scope of the resource's parent that lists only a single page.
- * @template Resource the resource being patched
+ * @template Resource the resource being listed
  * @template BaseParameters Optional. Allows overriding the operation parameters
  * @template ParentName Optional. The name of the parent resource
  * @template ParentFriendlyName Optional. The friendly name of the parent resource

package/lib/legacy-types/private-endpoints.tsp

@@ -12,8 +12,6 @@ using Rest;
  * @template ParentResource the parent resource of the PrivateEndpointConnection
  * @template Resource Optional. The PrivateEndpointConnection resource being listed
  * @template BaseParameters Optional. Allows overriding the operation parameters
- * @template ParentName Optional. The name of the parent resource
- * @template ParentFriendlyName Optional. The friendly name of the parent resource
  * @template Parameters Optional. Additional parameters after the path parameters
  * @template Response Optional. The success response for the list operation
  * @template Error Optional. The error response, if non-standard.

package/lib/operations.tsp

@@ -885,7 +885,7 @@ op ArmResourceActionNoContentSync<
 /**
  * Adds check global name availability operation, normally used if
  * a resource name must be globally unique (for example, if the resource
- * exposes and endpoint that uses the resource name in the url)
+ * exposes an endpoint that uses the resource name in the url)
  * @template Request the availability request, defaults to the standard request, containing name and resource type
  * @template Response the availability response, default to the standard response
  * @template AdditionalParams A model specifying additional non-path parameters to the availability request
@@ -905,7 +905,7 @@ op checkGlobalNameAvailability<
 /**
  * Adds check location-specific name availability operation, normally used if
  * a resource name must be globally unique (for example, if the resource
- * exposes and endpoint that uses the resource name in the url)
+ * exposes an endpoint that uses the resource name in the url)
  * @template Request the availability request, defaults to the standard request, containing name and resource type
  * @template Response the availability response, default to the standard response
  * @template AdditionalParams A model specifying additional non-path parameters to the availability request

package/lib/responses.tsp

@@ -246,7 +246,7 @@ model ArmLroLocationHeader<
  * @template StatusMonitor The type of the polling StatusMonitor when following the Azure-AsyncOperation url
  * @template FinalResult The type of the logical result when following the location header
  * @template PollingUrlValue The value type of the link to the status monitor
- * @template FinalUrlValue The value type fo the link to the final result
+ * @template FinalUrlValue The value type of the link to the final result
  *
  * @example
  * ```typespec
@@ -320,7 +320,7 @@ model ArmResourceUpdatedResponse<Resource extends Azure.ResourceManager.Foundati
 
 /**
  * Resource create operation succeeded
- * @template Resource The resource being updated
+ * @template Resource The resource being created
  * @template LroHeaders Optional. The lro headers returned with a Created response
  *
  * @example
@@ -350,7 +350,7 @@ model ArmResourceCreatedResponse<
 
 /**
  * Resource synchronous create operation succeeded
- * @template Resource The resource being updated
+ * @template Resource The resource being created
  *
  * @example
  * ```typespec

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.71.0-dev.1",
+  "version": "0.71.0-dev.11",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -47,33 +47,33 @@
     "pluralize": "^8.0.0"
   },
   "peerDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.70.0 || >=0.71.0-dev <0.71.0",
+    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.4",
     "@typespec/compiler": "^1.14.0",
     "@typespec/http": "^1.14.0",
-    "@typespec/rest": "^0.84.0 || >=0.85.0-dev <0.85.0",
+    "@typespec/rest": "^0.84.0",
     "@typespec/openapi": "^1.14.0",
-    "@typespec/versioning": "^0.84.0 || >=0.85.0-dev <0.85.0"
+    "@typespec/versioning": "^0.84.0"
   },
   "devDependencies": {
-    "@azure-tools/typespec-azure-core": "^0.70.0 || >=0.71.0-dev <0.71.0",
+    "@azure-tools/typespec-azure-core": "^0.70.0 || >= 0.71.0-dev.4",
     "@types/node": "^26.0.0",
     "@types/pluralize": "^0.0.33",
-    "@typespec/compiler": "^1.14.0",
-    "@typespec/http": "^1.14.0",
-    "@typespec/library-linter": "^0.84.0 || >=0.85.0-dev <0.85.0",
-    "@typespec/rest": "^0.84.0 || >=0.85.0-dev <0.85.0",
-    "@typespec/tspd": "^0.76.0 || >=0.77.0-dev <0.77.0",
-    "@typespec/versioning": "^0.84.0 || >=0.85.0-dev <0.85.0",
-    "@typespec/openapi": "^1.14.0",
     "@vitest/coverage-v8": "^4.1.3",
     "@vitest/ui": "^4.1.3",
     "rimraf": "^6.1.3",
     "typescript": "~6.0.2",
-    "vitest": "^4.1.3"
+    "vitest": "^4.1.3",
+    "@typespec/compiler": "^1.14.0",
+    "@typespec/library-linter": "^0.84.0",
+    "@typespec/http": "^1.14.0",
+    "@typespec/versioning": "^0.84.0",
+    "@typespec/rest": "^0.84.0",
+    "@typespec/tspd": "^0.76.0",
+    "@typespec/openapi": "^1.14.0"
   },
   "scripts": {
     "clean": "rimraf ./dist ./temp",
-    "build": "npm run gen-extern-signature && tsc -p tsconfig.build.json && npm run lint-typespec-library",
+    "build": "pnpm gen-extern-signature && tsc -p tsconfig.build.json && pnpm lint-typespec-library",
     "watch": "tsc -p tsconfig.build.json --watch",
     "gen-extern-signature": "tspd --enable-experimental gen-extern-signature .",
     "lint-typespec-library": "tsp compile . --warn-as-error --import @typespec/library-linter --no-emit",
@@ -83,6 +83,6 @@
     "test:ci": "vitest run --coverage  --reporter=junit --reporter=default",
     "lint": "oxlint . --deny-warnings",
     "lint:fix": "oxlint . --fix",
-    "regen-docs": "tspd doc .  --enable-experimental --llmstxt  --output-dir ../../website/src/content/docs/docs/libraries/azure-resource-manager/reference"
+    "regen-docs": "tspd doc .  --enable-experimental --llmstxt --rules-dir ../rules  --output-dir ../../website/src/content/docs/docs/libraries/azure-resource-manager/reference"
   }
 }

package/dist/src/rules/core-operations.d.ts

@@ -1,6 +0,0 @@
-export declare const coreOperationsRule: import("@typespec/compiler").LinterRuleDefinition<"arm-resource-operation", {
-    readonly 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.";
-    readonly opOutsideInterface: "All operations must be inside an interface declaration.";
-    readonly opMissingDecorator: import("@typespec/compiler").CallableMessage<["verb", "decorator"]>;
-}, Record<string, never>>;
-//# sourceMappingURL=core-operations.d.ts.map

package/dist/src/rules/core-operations.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-operations.d.ts","sourceRoot":"","sources":["../../../src/rules/core-operations.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,kBAAkB;;;;yBA6D7B,CAAC"}

package/dist/src/rules/core-operations.js

@@ -1,104 +0,0 @@
-import { createRule, isTemplateInstance, paramMessage, } from "@typespec/compiler";
-import { SyntaxKind } from "@typespec/compiler/ast";
-import { getOperationVerb } from "@typespec/http";
-import { getSegment } from "@typespec/rest";
-import { getNamespaceName, getSourceModel, isSourceOperationResourceManagerInternal, isTemplatedInterfaceOperation, } from "./utils.js";
-export const coreOperationsRule = createRule({
-    name: "arm-resource-operation",
-    severity: "warning",
-    description: "Validate ARM Resource operations.",
-    url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/arm-resource-operation",
-    messages: {
-        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.",
-        opOutsideInterface: "All operations must be inside an interface declaration.",
-        opMissingDecorator: paramMessage `Resource ${"verb"} operation must be decorated with ${"decorator"}.`,
-    },
-    create(context) {
-        return {
-            operation: (operation) => {
-                if (!isSourceOperationResourceManagerInternal(operation) &&
-                    !isTemplateInstance(operation)) {
-                    const verb = getOperationVerb(context.program, operation);
-                    if (!isTemplatedInterfaceOperation(operation) &&
-                        (!operation.node?.parent ||
-                            operation.node.parent.kind !== SyntaxKind.InterfaceStatement)) {
-                        context.reportDiagnostic({
-                            messageId: "opOutsideInterface",
-                            target: operation,
-                        });
-                    }
-                    const parameters = operation.parameters;
-                    if (parameters === undefined ||
-                        parameters === null ||
-                        !hasApiParameter(context.program, parameters)) {
-                        context.reportDiagnostic({
-                            target: operation,
-                        });
-                    }
-                    if (verb) {
-                        const requiredDecorators = resourceOperationDecorators[verb];
-                        if (requiredDecorators?.length > 0) {
-                            const decorator = operation.decorators.find((d) => requiredDecorators.indexOf(d.decorator.name) >= 0);
-                            if (!decorator && !isArmProviderOperation(context.program, operation)) {
-                                context.reportDiagnostic({
-                                    messageId: "opMissingDecorator",
-                                    target: operation,
-                                    format: {
-                                        verb: verb.toUpperCase(),
-                                        decorator: requiredDecorators.map((d) => `@${d.substring(1)}`).join(" or "),
-                                    },
-                                });
-                            }
-                        }
-                    }
-                }
-            },
-        };
-    },
-});
-const resourceOperationDecorators = {
-    put: ["$armResourceCreateOrUpdate"],
-    get: ["$armResourceRead", "$armResourceList"],
-    patch: ["$armResourceUpdate"],
-    delete: ["$armResourceDelete"],
-    post: ["$armResourceAction", "$armResourceCollectionAction"],
-    head: [],
-};
-function isApiParameter(program, property) {
-    if (property.type.kind !== "Scalar")
-        return false;
-    if (!property.sourceProperty)
-        return false;
-    const sourceModel = getSourceModel(property.sourceProperty);
-    if (sourceModel === undefined)
-        return false;
-    return (sourceModel.name === "ApiVersionParameter" &&
-        getNamespaceName(program, sourceModel) === "Azure.ResourceManager.CommonTypes");
-}
-function hasApiParameter(program, model) {
-    if (model.properties === undefined || model.properties.size === 0)
-        return false;
-    const apiVersionParams = [...model.properties.values()].filter((i) => isApiParameter(program, i));
-    return apiVersionParams !== null && apiVersionParams.length === 1;
-}
-function isStaticSegment(segment, property) {
-    return segment === undefined || segment === "locations";
-}
-function isArmProviderOperation(program, operation) {
-    let isProviderAction = false;
-    for (const [index, [, property]] of [...operation.parameters.properties].entries()) {
-        const segment = getSegment(program, property);
-        if (segment === "providers") {
-            isProviderAction = true;
-        }
-        else if (isProviderAction && !isStaticSegment(segment, property)) {
-            return false;
-        }
-        const isLastSegment = index === operation.parameters.properties.size - 1;
-        if (isLastSegment && !segment) {
-            return true;
-        }
-    }
-    return false;
-}
-//# sourceMappingURL=core-operations.js.map

package/dist/src/rules/core-operations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-operations.js","sourceRoot":"","sources":["../../../src/rules/core-operations.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,UAAU,EACV,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,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"}