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

package/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

package/README.md

@@ -0,0 +1,346 @@
+# TypeSpec Azure Resource Manager Library
+
+This is a library that provides model types and interfaces which can be used to define an Azure Resource Manager service API.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Creating a project with `tsp init`](#creating-a-project-with-typespec-init)
+  - [Creating a project manually](#creating-a-project-manually)
+- [Concepts](#concepts)
+  - [Defining the Service](#defining-the-service)
+  - [Defining Resource Types](#defining-resource-types)
+- [Generating an OpenAPI Specification](#generating-an-openapi-specification)
+- [A Complete Example](#a-complete-example)
+
+## Getting Started
+
+To author an Azure Resource Manager service definition, you will first need to create a TypeSpec project for your service.
+The easiest way to do that is to follow the instructions on this page:
+
+https://github.com/Azure/typespec-azure/blob/main/packages/typespec-providerhub-templates/README.md#getting-started
+
+## Concepts
+
+Before using this library, you should familiarize yourself with the TypeSpec language and tools. You can do this by reading the [TypeSpec tutorial](https://github.com/microsoft/typespec/blob/main/docs/tutorial.md).
+
+### Defining the Service
+
+To define an Azure Resource Manager service, the first thing you will need to do is define the service namespace and decorate it with the `serviceTitle`, `serviceVersion` and `armProviderNamespace` decorators:
+
+```typespec
+@armProviderNamespace
+@service({title: "<service name>", version: "<service version>"})
+namespace <mynamespace>;
+```
+
+For example:
+
+```typespec
+@armProviderNamespace
+@service({
+  title: "Contoso User Service",
+  version: "2020-10-01-preview",
+})
+namespace Contoso.Users;
+```
+
+### The `using` keyword
+
+Just after the `namespace` declaration, you will also need to include a few `using` statements to pull in symbols from the namespaces of libraries you will for your specification.
+
+For example, these lines pull in symbols from the `@typespec/rest` and `@azure-tools/typespec-azure-resource-manager`:
+
+```
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using Azure.ResourceManager;
+```
+
+### Defining Resource Types
+
+A resource provider is composed of resources. The TypeSpec Azure Resource Manager library makes it much easier to define the structure and endpoints of such resources.
+
+There are three essential components of a resource defined with TypeSpec:
+
+- A model type representing the resource, derived from one of the [base resource types](#base-resource-types)
+- A model type defining the properties of the resource type
+- An interface that defines the operations that can be performed on the resource type, usually a combination of [standard resource operations](#standard-resource-operations) and [custom actions](#custom-actions)
+
+Read the [TypeSpec tutorial](https://github.com/Microsoft/typespec/blob/main/docs/tutorial.md) to learn the basics about TypeSpec model types and interfaces.
+
+#### 1. **Define a model representing the `properties` of the ARM resource**
+
+Each resource type must have a properties type which defines its custom properties. This type will be exposed as the `properties` property of the resource type.
+
+```typespec
+@doc("The properties of UserResource")
+model UserResourceProperties {
+  @doc("The user's full name")
+  fullName: string;
+
+  @doc("The user's email address.")
+  emailAddress: string;
+}
+```
+
+#### 2. **Define a model representing the resource type**
+
+Resource types are defined as plain models which pull in a standard resource type using the `is` keyword.
+
+You define a resource type, you need the following:
+
+- A `name` property which is marked with the following decorators
+  - `@key`: Specifies the parameter name for this resource type in the service URI hierarchy
+  - `@segment`: Specifies the name of the resource "collection", the URI segment that comes just before the parameter name which identifies the resource type
+- A second model type which defines the resource type's custom properties as we described in step 1
+
+Here we define a tracked resource called `UserResource`:
+
+```typespec
+@doc("A UserResource")
+model UserResource is TrackedResource<UserResourceProperties> {
+  @key("userName")
+  @segment("users")
+  name: string;
+}
+```
+
+#### 3. **Define an interface with operations for the resource type**
+
+```typespec
+@armResourceOperations
+interface Users extends TrackedResourceOperations<UserResource> {}
+```
+
+This will now produce all the endpoints(`get`, `post`, `put`, `patch` and `delete`, listByResourceGroup, listBySubscription) for a resource called `UserResources` and the `operations` endpoint for the service:
+
+| Method & Path                                                                                                        | Description                             |
+| -------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
+| `GET /providers/Contoso.Users/operations`                                                                            | List all operations for your service    |
+| `GET /subscriptions/{subscriptionId}/providers/Contoso.Users/users`                                                  | list all UserResource by subscription   |
+| `GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Contoso.Users/users`               | list all UserResource by resource group |
+| `GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Contoso.Users/users/{userName}`    | get item                                |
+| `PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Contoso.Users/users/{userName}`    | insert item                             |
+| `PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Contoso.Users/users/{userName}`  | patch item                              |
+| `DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Contoso.Users/users/{userName}` | delete item                             |
+
+#### Base Resource Types
+
+Here are the base resource types you can use when defining your own ARM resources:
+
+| Name                           | Description                                                                            |
+| ------------------------------ | -------------------------------------------------------------------------------------- |
+| TrackedResource<TProperties>   | Defines a normal ARM resource where `TProperties` is the model of the `properties`     |
+| ProxyResource<TProperties>     | Defines a proxy ARM resource where `TProperties` is the model of the `properties`      |
+| ExtensionResource<TProperties> | Defines an extension ARM resource where `TProperties` is the model of the `properties` |
+
+### Defining Child Resource Types
+
+You can create parent/child relationships between resource types by using the `@parentResource` decorator when defining a resource type.
+
+For example, here's how you could create a new `AddressResource` resource under the `UserResource` defined above:
+
+```typespec
+@doc("An address resource belonging to a user resource.")
+@parentResource(UserResource)
+model AddressResource is ProxyResource<AddressResourceProperties> {
+  @key("addressName")
+  @segment("addresses")
+  name: string;
+}
+
+@doc("The properties of AddressResource")
+model AddressResourceProperties {
+  @doc("The street address.")
+  streetAddress: string;
+
+  @doc("The city of the address.")
+  city: string;
+
+  @doc("The state of the address.")
+  state: string;
+
+  @doc("The zip code of the address.")
+  zip: int32;
+}
+
+@armResourceOperations
+interface Addresses extends ProxyResourceOperations<AddressResource> {}
+```
+
+### Defining Custom Actions
+
+Some resources will provide more than the standard CRUD operations and will need to define a custom action endpoint. Additional resource operations can be added to the `interface` where you pulled in standard resource operations.
+
+For example, to add an additional `POST` action called `/notify` to the standard operations of `UserResource`:
+
+```typespec
+@doc("The details of a user notification.")
+model NotificationDetails {
+  @doc("The notification message.")
+  message: string;
+
+  @doc("If true, the notification is urgent.")
+  urgent: boolean;
+}
+
+@armResourceOperations
+interface Users extends TrackedResourceOperations<UserResource, UserResourceProperties> {
+  @post
+  @doc("Send a notification to the user")
+  @segment("notify")
+  NotifyUser(
+    ...ResourceInstanceParameters<UserResource>,
+    @body notification: NotificationDetails
+  ): ArmResponse<string> | ErrorResponse;
+}
+```
+
+#### ARM Response Types
+
+Custom operations in ARM still need to respect the correct response schema. This library provides standard ARM response types to help with reusability and compliance.
+
+| Model                         | Code | Description                                   |
+| ----------------------------- | ---- | --------------------------------------------- |
+| `ArmResponse<T>`              | 200  | Base Arm 200 response.                        |
+| `ArmCreatedResponse<T>`       | 201  | Resource created response                     |
+| `ArmDeletedResponse`          | 200  | Resource deleted response                     |
+| `ArmDeleteAcceptedResponse`   | 202  | Resource deletion in progress response        |
+| `ArmDeletedNoContentResponse` | 204  | Resource deleted response                     |
+| `Page<T>`                     | 200  | Return a list of resource with ARM pagination |
+| `ErrorResponse<T>`            | x    | Error response                                |
+
+#### Common Operation Parameters
+
+There are a number of model types which specify common parameters which are used in resource type operations:
+
+| Model                        | In           | Description                                                        |
+| ---------------------------- | ------------ | ------------------------------------------------------------------ |
+| `ApiVersionParameter`        | query        | `api-version` parameter                                            |
+| `SubscriptionIdParameter`    | path         | Subscription ID path parameter                                     |
+| `ResourceGroupNameParameter` | path         | Resource Group Name path parameter                                 |
+| `CommonResourceParameters`   | path & query | Group of Api version, Subscription ID and Resource group parameter |
+| `ResourceUriParameter`       | path         | Resource uri path parameter                                        |
+| `OperationIdParameter`       | path         | Operation Id path parameter                                        |
+
+## Generating an OpenAPI Specification
+
+To generate an OpenAPI v2 (Swagger) specification from the service definition, run the following command inside of the project folder:
+
+```
+tsp compile . --emit @azure-tools/typespec-autorest
+```
+
+This will create a file in the `tsp-output` subfolder called `openapi.json`.
+
+## A Complete Example
+
+Here's a complete example `main.tsp` file based on all of the snippets in this README:
+
+```typespec
+import "@typespec/http";
+import "@typespec/rest";
+import "@typespec/versioning";
+import "@azure-tools/typespec-providerhub";
+import "@azure-tools/typespec-azure-core";
+import "@azure-tools/typespec-azure-resource-manager";
+
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using TypeSpec.Versioning;
+using Azure.Core;
+using Azure.ResourceManager;
+
+@armProviderNamespace
+@service({
+  title: "ContosoProviderHubClient",
+  version: "2021-01-01-preview",
+})
+@doc("Contoso Resource Provider management API.")
+@versionedDependency(Azure.ResourceManager.Versions.v1_0_Preview_1)
+namespace Microsoft.ContosoProviderHub;
+
+interface Operations extends Azure.ResourceManager.Operations {}
+
+@lroStatus
+enum ProvisioningState {
+  ...ResourceProvisioningState,
+  Provisioning,
+  Updating,
+  Deleting,
+  Accepted,
+}
+
+@doc("The properties of UserResource")
+model UserResourceProperties {
+  @doc("The user's full name")
+  fullName: string;
+
+  @doc("The user's email address.")
+  emailAddress: string;
+
+  @doc("The status of the last operation.")
+  provisioningState?: ProvisioningState;
+}
+
+@doc("A UserResource")
+model UserResource is TrackedResource<UserResourceProperties> {
+  @key("userName")
+  @segment("users")
+  @doc("Address name")
+  @path
+  name: string;
+}
+
+@doc("The details of a user notification.")
+model NotificationDetails {
+  @doc("The notification message.")
+  message: string;
+
+  @doc("If true, the notification is urgent.")
+  urgent: boolean;
+}
+
+@armResourceOperations
+interface Users extends TrackedResourceOperations<UserResource, UserResourceProperties> {
+  @post
+  @doc("Send a notification to the user")
+  @segment("notify")
+  notifyUser(
+    ...ResourceInstanceParameters<UserResource>,
+    @body notification: NotificationDetails
+  ): ArmResponse<string> | ErrorResponse;
+}
+
+@doc("An address resource belonging to a user resource.")
+@parentResource(UserResource)
+model AddressResource is ProxyResource<AddressResourceProperties> {
+  @doc("Address name")
+  @key("addressName")
+  @segment("addresses")
+  @path
+  name: string;
+}
+
+@doc("The properties of AddressResource")
+model AddressResourceProperties {
+  @doc("The street address.")
+  streetAddress: string;
+
+  @doc("The city of the address.")
+  city: string;
+
+  @doc("The state of the address.")
+  state: string;
+
+  @doc("The zip code of the address.")
+  zip: int32;
+
+  @doc("The status of the last operation.")
+  provisioningState?: ProvisioningState;
+}
+
+@armResourceOperations
+interface Addresses extends ProxyResourceOperations<AddressResource> {}
+```

package/dist/src/common-types.d.ts

@@ -0,0 +1,8 @@
+import { Type } from "@typespec/compiler";
+/**
+ * Check if a given model or model property is an ARM common type.
+ * @param {Type} entity - The entity to be checked.
+ *  @return {boolean} - A boolean value indicating whether an entity is an ARM common type.
+ */
+export declare function isArmCommonType(entity: Type): boolean;
+//# sourceMappingURL=common-types.d.ts.map

package/dist/src/common-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-types.d.ts","sourceRoot":"","sources":["../../src/common-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAQrD"}

package/dist/src/common-types.js

@@ -0,0 +1,14 @@
+import { isTypeSpecValueTypeOf } from "@typespec/compiler";
+/**
+ * Check if a given model or model property is an ARM common type.
+ * @param {Type} entity - The entity to be checked.
+ *  @return {boolean} - A boolean value indicating whether an entity is an ARM common type.
+ */
+export function isArmCommonType(entity) {
+    const commonDecorators = ["$armCommonDefinition", "$armCommonParameter"];
+    if (isTypeSpecValueTypeOf(entity, ["Model", "ModelProperty"])) {
+        return commonDecorators.some((commonDecorator) => entity.decorators.some((d) => d.decorator.name === commonDecorator));
+    }
+    return false;
+}
+//# sourceMappingURL=common-types.js.map

package/dist/src/common-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-types.js","sourceRoot":"","sources":["../../src/common-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAQ,MAAM,oBAAoB,CAAC;AAEjE;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAY;IAC1C,MAAM,gBAAgB,GAAG,CAAC,sBAAsB,EAAE,qBAAqB,CAAC,CAAC;IACzE,IAAI,qBAAqB,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,EAAE;QAC7D,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE,CAC/C,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,KAAK,eAAe,CAAC,CACpE,CAAC;KACH;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+export declare const namespace = "Azure.ResourceManager";
+export * from "./common-types.js";
+export * from "./linter.js";
+export * from "./namespace.js";
+export * from "./operations.js";
+export * from "./resource.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,0BAA0B,CAAC;AAEjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,7 @@
+export const namespace = "Azure.ResourceManager";
+export * from "./common-types.js";
+export * from "./linter.js";
+export * from "./namespace.js";
+export * from "./operations.js";
+export * from "./resource.js";
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAEjD,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,eAAe,CAAC"}

package/dist/src/internal.d.ts

@@ -0,0 +1,44 @@
+export declare const namespace = "Azure.ResourceManager.Foundations";
+import { DecoratorContext, Interface, Program, Type } from "@typespec/compiler";
+/**
+ * Using ARM common definition for a Model
+ * @param {DecoratorContext} context DecoratorContext object
+ * @param {Type} entity Decorator target type. Must be `Model`
+ * @param {string?} definitionName Optional definition name
+ * @param {string?} version Optional version
+ * @param {string?} referenceFile Optional common file path
+ * @returns {void}
+ */
+export declare function $armCommonDefinition(context: DecoratorContext, entity: Type, definitionName?: string, version?: string, referenceFile?: string): void;
+/**
+ * Refer an model property to be a common ARM parameter
+ * @param {DecoratorContext} context DecoratorContext object
+ * @param {Type} entity Decorator target type. Must be `Model`
+ * @param {string?} definitionName Optional definition name
+ * @param {string?} version Optional version
+ * @param {string?} referenceFile Optional common file path
+ * @returns void
+ */
+export declare function $armCommonParameter(context: DecoratorContext, entity: Type, parameterName?: string, version?: string, referenceFile?: string): void;
+/**
+ * This decorator dynamically assigns the serviceNamespace from the containing
+ * namespace to the string literal value of the path parameter to which this
+ * decorator is applied.  Its purpose is to dynamically insert the provider
+ * namespace (e.g. 'Microsoft.CodeSigning') into the path parameter list.
+ * @param {DecoratorContext} context DecoratorContext
+ * @param {Type} target Target of this decorator. Must be a string `ModelProperty`.
+ * @param {Type} resourceType Must be a `Model`.
+ */
+export declare function $assignProviderNameValue(context: DecoratorContext, target: Type, resourceType: Type): void;
+/**
+ * Update the ARM provider namespace for a given entity.
+ * @param {DecoratorContext} context DecoratorContext
+ * @param {Type} entity Entity to set namespace. Must be a `Operation`.
+ * @returns
+ */
+export declare function $armUpdateProviderNamespace(context: DecoratorContext, entity: Type): void;
+/**
+ * Check if an interface is extending the Azure.ResourceManager.Operations interface.
+ */
+export declare function isArmOperationsListInterface(program: Program, type: Interface): boolean;
+//# sourceMappingURL=internal.d.ts.map

package/dist/src/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,sCAAsC,CAAC;AAG7D,OAAO,EACL,gBAAgB,EAChB,SAAS,EAGT,OAAO,EAEP,IAAI,EAGL,MAAM,oBAAoB,CAAC;AAS5B;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,cAAc,CAAC,EAAE,MAAM,EACvB,OAAO,CAAC,EAAE,MAAM,EAChB,aAAa,CAAC,EAAE,MAAM,GACrB,IAAI,CAqBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,MAAM,EAChB,aAAa,CAAC,EAAE,MAAM,GACrB,IAAI,CAqBN;AAED;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,IAAI,EACZ,YAAY,EAAE,IAAI,GACjB,IAAI,CAoBN;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,IAAI,QA4BlF;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,GAAG,OAAO,CAWvF"}

package/dist/src/internal.js

@@ -0,0 +1,142 @@
+export const namespace = "Azure.ResourceManager.Foundations";
+import { $useRef } from "@azure-tools/typespec-autorest";
+import { validateDecoratorParamType, validateDecoratorTarget, } from "@typespec/compiler";
+import { getSegment } from "@typespec/rest";
+import { reportDiagnostic } from "./lib.js";
+import { getArmProviderNamespace } from "./namespace.js";
+function getArmTypesPath(program) {
+    return program.getOption("arm-types-path") || "../../../../../common-types/resource-management";
+}
+/**
+ * Using ARM common definition for a Model
+ * @param {DecoratorContext} context DecoratorContext object
+ * @param {Type} entity Decorator target type. Must be `Model`
+ * @param {string?} definitionName Optional definition name
+ * @param {string?} version Optional version
+ * @param {string?} referenceFile Optional common file path
+ * @returns {void}
+ */
+export function $armCommonDefinition(context, entity, definitionName, version, referenceFile) {
+    if (!validateDecoratorTarget(context, entity, "@armCommonDefinition", "Model")) {
+        return;
+    }
+    // Use the name of the model type if not specified
+    if (!definitionName) {
+        definitionName = entity.name;
+    }
+    const basePath = getArmTypesPath(context.program).trim();
+    // for backward compatibility, skip if we are trying to access a non-default file and emit the type
+    if ((version || referenceFile) && basePath.endsWith(".json"))
+        return;
+    if (!version)
+        version = "v3";
+    if (!referenceFile)
+        referenceFile = "types.json";
+    const path = basePath.endsWith(".json")
+        ? `${basePath}#/definitions/${definitionName}`
+        : `${basePath}/${version}/${referenceFile}#/definitions/${definitionName}`;
+    context.call($useRef, entity, path);
+}
+/**
+ * Refer an model property to be a common ARM parameter
+ * @param {DecoratorContext} context DecoratorContext object
+ * @param {Type} entity Decorator target type. Must be `Model`
+ * @param {string?} definitionName Optional definition name
+ * @param {string?} version Optional version
+ * @param {string?} referenceFile Optional common file path
+ * @returns void
+ */
+export function $armCommonParameter(context, entity, parameterName, version, referenceFile) {
+    if (!validateDecoratorTarget(context, entity, "@armCommonParameter", "ModelProperty")) {
+        return;
+    }
+    // Use the name of the model type if not specified
+    if (!parameterName) {
+        parameterName = entity.name;
+    }
+    const basePath = getArmTypesPath(context.program).trim();
+    // for backward compatibility, skip if we are trying to access a non-default file and emit the type
+    if ((version || referenceFile) && basePath.endsWith(".json"))
+        return;
+    if (!version)
+        version = "v3";
+    if (!referenceFile)
+        referenceFile = "types.json";
+    const path = basePath.endsWith(".json")
+        ? `${basePath}#/parameters/${parameterName}`
+        : `${basePath}/${version}/${referenceFile}#/parameters/${parameterName}`;
+    context.call($useRef, entity, path);
+}
+/**
+ * This decorator dynamically assigns the serviceNamespace from the containing
+ * namespace to the string literal value of the path parameter to which this
+ * decorator is applied.  Its purpose is to dynamically insert the provider
+ * namespace (e.g. 'Microsoft.CodeSigning') into the path parameter list.
+ * @param {DecoratorContext} context DecoratorContext
+ * @param {Type} target Target of this decorator. Must be a string `ModelProperty`.
+ * @param {Type} resourceType Must be a `Model`.
+ */
+export function $assignProviderNameValue(context, target, resourceType) {
+    const { program } = context;
+    // If the resource type is a template parameter, this must be a templated type
+    if (resourceType.kind === "TemplateParameter") {
+        return;
+    }
+    if (!validateDecoratorTarget(context, target, "@assignProviderNameValue", "ModelProperty") ||
+        !validateDecoratorParamType(program, target, target.type, "String") ||
+        !validateDecoratorParamType(program, target, resourceType, "Model")) {
+        return;
+    }
+    const armProviderNamespace = getArmProviderNamespace(program, resourceType);
+    if (armProviderNamespace) {
+        target.type.value = armProviderNamespace;
+    }
+}
+/**
+ * Update the ARM provider namespace for a given entity.
+ * @param {DecoratorContext} context DecoratorContext
+ * @param {Type} entity Entity to set namespace. Must be a `Operation`.
+ * @returns
+ */
+export function $armUpdateProviderNamespace(context, entity) {
+    const { program } = context;
+    if (!validateDecoratorTarget(context, entity, "@armUpdateProviderNamespace", "Operation")) {
+        return;
+    }
+    const operation = entity;
+    const opInterface = operation.interface;
+    if (opInterface && opInterface.namespace) {
+        const armProviderNamespace = getArmProviderNamespace(program, opInterface.namespace);
+        if (armProviderNamespace) {
+            // Set the namespace constant on the 'provider' parameter
+            const providerParam = operation.parameters.properties.get("provider");
+            if (providerParam) {
+                if (providerParam.type.kind !== "String") {
+                    reportDiagnostic(program, {
+                        code: "decorator-param-wrong-type",
+                        messageId: "armUpdateProviderNamespace",
+                        target: providerParam,
+                    });
+                    return;
+                }
+                providerParam.type.value = armProviderNamespace;
+            }
+        }
+    }
+}
+/**
+ * Check if an interface is extending the Azure.ResourceManager.Operations interface.
+ */
+export function isArmOperationsListInterface(program, type) {
+    if (type.name !== "Operations") {
+        return false;
+    }
+    const listOperation = type.operations.get("list");
+    if (listOperation) {
+        if (getSegment(program, listOperation) === "operations") {
+            return true;
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=internal.js.map

package/dist/src/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../../src/internal.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,mCAAmC,CAAC;AAE7D,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACzD,OAAO,EAQL,0BAA0B,EAC1B,uBAAuB,GACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,SAAS,eAAe,CAAC,OAAgB;IACvC,OAAO,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,iDAAiD,CAAC;AAClG,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAClC,OAAyB,EACzB,MAAY,EACZ,cAAuB,EACvB,OAAgB,EAChB,aAAsB;IAEtB,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE;QAC9E,OAAO;KACR;IAED,kDAAkD;IAClD,IAAI,CAAC,cAAc,EAAE;QACnB,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC;KAC9B;IAED,MAAM,QAAQ,GAAW,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjE,mGAAmG;IACnG,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO;IACrE,IAAI,CAAC,OAAO;QAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,aAAa;QAAE,aAAa,GAAG,YAAY,CAAC;IACjD,MAAM,IAAI,GAAW,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC7C,CAAC,CAAC,GAAG,QAAQ,iBAAiB,cAAc,EAAE;QAC9C,CAAC,CAAC,GAAG,QAAQ,IAAI,OAAO,IAAI,aAAa,iBAAiB,cAAc,EAAE,CAAC;IAE7E,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mBAAmB,CACjC,OAAyB,EACzB,MAAY,EACZ,aAAsB,EACtB,OAAgB,EAChB,aAAsB;IAEtB,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,eAAe,CAAC,EAAE;QACrF,OAAO;KACR;IAED,kDAAkD;IAClD,IAAI,CAAC,aAAa,EAAE;QAClB,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC;KAC7B;IAED,MAAM,QAAQ,GAAW,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjE,mGAAmG;IACnG,IAAI,CAAC,OAAO,IAAI,aAAa,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO;IACrE,IAAI,CAAC,OAAO;QAAE,OAAO,GAAG,IAAI,CAAC;IAC7B,IAAI,CAAC,aAAa;QAAE,aAAa,GAAG,YAAY,CAAC;IAEjD,MAAM,IAAI,GAAW,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC7C,CAAC,CAAC,GAAG,QAAQ,gBAAgB,aAAa,EAAE;QAC5C,CAAC,CAAC,GAAG,QAAQ,IAAI,OAAO,IAAI,aAAa,gBAAgB,aAAa,EAAE,CAAC;IAC3E,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAyB,EACzB,MAAY,EACZ,YAAkB;IAElB,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5B,8EAA8E;IAC9E,IAAI,YAAY,CAAC,IAAI,KAAK,mBAAmB,EAAE;QAC7C,OAAO;KACR;IAED,IACE,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,0BAA0B,EAAE,eAAe,CAAC;QACtF,CAAC,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC;QACnE,CAAC,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EACnE;QACA,OAAO;KACR;IAED,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,OAAO,EAAE,YAAqB,CAAC,CAAC;IACrF,IAAI,oBAAoB,EAAE;QACvB,MAAM,CAAC,IAAsB,CAAC,KAAK,GAAG,oBAAoB,CAAC;KAC7D;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAC,OAAyB,EAAE,MAAY;IACjF,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5B,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,EAAE,6BAA6B,EAAE,WAAW,CAAC,EAAE;QACzF,OAAO;KACR;IAED,MAAM,SAAS,GAAG,MAAmB,CAAC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC;IACxC,IAAI,WAAW,IAAI,WAAW,CAAC,SAAS,EAAE;QACxC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;QACrF,IAAI,oBAAoB,EAAE;YACxB,yDAAyD;YACzD,MAAM,aAAa,GAAG,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACtE,IAAI,aAAa,EAAE;gBACjB,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;oBACxC,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,4BAA4B;wBAClC,SAAS,EAAE,4BAA4B;wBACvC,MAAM,EAAE,aAAa;qBACtB,CAAC,CAAC;oBACH,OAAO;iBACR;gBAED,aAAa,CAAC,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC;aACjD;SACF;KACF;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAAC,OAAgB,EAAE,IAAe;IAC5E,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE;QAC9B,OAAO,KAAK,CAAC;KACd;IACD,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,aAAa,EAAE;QACjB,IAAI,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,KAAK,YAAY,EAAE;YACvD,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}