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

package/lib/operations.tsp

@@ -0,0 +1,260 @@
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using OpenAPI;
+using Autorest;
+using Azure.ResourceManager.Foundations;
+
+namespace Azure.ResourceManager;
+
+// OPERATION TEMPLATES
+@autoRoute
+@doc("List {name} resources by subscription ID", TResource)
+@list(TResource)
+@segmentOf(TResource)
+@armResourceList(TResource)
+@get
+op ArmListBySubscription<TResource extends ArmResource>(
+  ...SubscriptionScope<TResource>
+): ArmResponse<ResourceListResult<TResource>> | ErrorResponse;
+
+@get
+@autoRoute
+@list(TResource)
+@segmentOf(TResource)
+@armRenameListByOperation(TResource, TParentName, TParentFriendlyName) // This must come before @armResourceList!
+@armResourceList(TResource)
+op ArmResourceListByParent<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>,
+  TParentName = "",
+  TParentFriendlyName = ""
+>(
+  ...ResourceParentParameters<TResource, TBaseParameters>
+): ArmResponse<ResourceListResult<TResource>> | ErrorResponse;
+
+@get
+@autoRoute
+@list(TResource)
+@segmentOf(TResource)
+@armRenameListByOperation(TResource) // This must come before @armResourceList!
+@armResourceList(TResource)
+op ArmResourceListAtScope<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceParentParameters<TResource, TBaseParameters>
+): ArmResponse<ResourceListResult<TResource>> | ErrorResponse;
+
+@autoRoute
+@doc("Get a {name}", TResource)
+@get
+@armResourceRead(TResource)
+op ArmResourceRead<TResource extends ArmResource, TBaseParameters = BaseParameters<TResource>>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>
+): ArmResponse<TResource> | ErrorResponse;
+
+@autoRoute
+@doc("Create a {name}", TResource)
+@extension("x-ms-long-running-operation", true)
+@extension(
+  "x-ms-long-running-operation-options",
+  {
+    `final-state-via`: "azure-async-operation",
+  }
+)
+@armResourceCreateOrUpdate(TResource)
+@put
+op ArmResourceCreateOrUpdateAsync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("Resource create parameters.")
+  @body
+  resource: TResource
+): ArmResponse<TResource> | ArmCreatedResponse<TResource> | ErrorResponse;
+
+@autoRoute
+@doc("Create a {name}", TResource)
+@armResourceCreateOrUpdate(TResource)
+@put
+op ArmResourceCreateOrUpdateSync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("Resource create parameters.")
+  @body
+  resource: TResource
+): ArmResponse<TResource> | ErrorResponse;
+
+alias ArmTagsPatchAsync<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> = ArmCustomPatchAsync<TResource, TagsUpdateModel<TResource>, TBaseParameters>;
+
+alias ArmResourcePatchAsync<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> = ArmCustomPatchAsync<TResource, ResourceUpdateModel<TResource, TProperties>, TBaseParameters>;
+
+@autoRoute
+@doc("Update a {name}", TResource)
+@extension("x-ms-long-running-operation", true)
+@extension(
+  "x-ms-long-running-operation-options",
+  {
+    `final-state-via`: "azure-async-operation",
+  }
+)
+@armResourceUpdate(TResource)
+@patch
+op ArmCustomPatchAsync<
+  TResource extends ArmResource,
+  TPatchModel extends object = TagsUpdateModel<TResource>,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The resource properties to be updated.")
+  @body
+  properties: TPatchModel
+): ArmResponse<TResource> | ArmAcceptedResponse<"Resource update request accepted."> | ErrorResponse;
+
+alias ArmTagsPatchSync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> = ArmCustomPatchSync<TResource, TagsUpdateModel<TResource>, TBaseParameters>;
+
+alias ArmResourcePatchSync<
+  TResource extends ArmResource,
+  TProperties extends object,
+  TBaseParameters = BaseParameters<TResource>
+> = ArmCustomPatchSync<TResource, ResourceUpdateModel<TResource, TProperties>, TBaseParameters>;
+
+@autoRoute
+@doc("Update a {name}", TResource)
+@armResourceUpdate(TResource)
+@patch
+op ArmCustomPatchSync<
+  TResource extends ArmResource,
+  TPatchModel extends object = TagsUpdateModel<TResource>,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The resource properties to be updated.")
+  @body
+  properties: TPatchModel
+): ArmResponse<TResource> | ErrorResponse;
+
+@autoRoute
+@doc("Delete a {name}", TResource)
+@extension("x-ms-long-running-operation", true)
+@extension(
+  "x-ms-long-running-operation-options",
+  {
+    `final-state-via`: "azure-async-operation",
+  }
+)
+@armResourceDelete(TResource)
+@delete
+op ArmResourceDeleteAsync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>(...ResourceInstanceParameters<TResource, TBaseParameters>):
+  | ArmDeletedResponse
+  | ArmDeleteAcceptedResponse
+  | ArmDeletedNoContentResponse
+  | ErrorResponse;
+
+@autoRoute
+@doc("Delete a {name}", TResource)
+@armResourceDelete(TResource)
+@delete
+op ArmResourceDeleteSync<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>
+): ArmDeletedResponse | ArmDeletedNoContentResponse | ErrorResponse;
+
+@autoRoute
+@extension("x-ms-long-running-operation", true)
+@extension(
+  "x-ms-long-running-operation-options",
+  {
+    `final-state-via`: "azure-async-operation",
+  }
+)
+@armResourceAction(TResource)
+@post
+op ArmResourceActionAsync<
+  TResource extends ArmResource,
+  TRequest extends object,
+  TResponse extends object,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The content of the action request")
+  @body
+  body: TRequest
+): ArmResponse<TResponse> | ArmAcceptedResponse | ErrorResponse;
+
+@autoRoute
+@armResourceAction(TResource)
+@post
+op ArmResourceActionSync<
+  TResource extends ArmResource,
+  TRequest extends object,
+  TResponse extends object,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The content of the action request")
+  @body
+  body: TRequest
+): ArmResponse<TResponse> | ErrorResponse;
+
+@autoRoute
+@extension("x-ms-long-running-operation", true)
+@extension(
+  "x-ms-long-running-operation-options",
+  {
+    `final-state-via`: "azure-async-operation",
+  }
+)
+@armResourceAction(TResource)
+@post
+op ArmResourceActionNoContentAsync<
+  TResource extends ArmResource,
+  TRequest extends object,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The content of the action request")
+  @body
+  body: TRequest
+): ArmNoContentResponse<"Action completed successfully."> | ArmAcceptedResponse | ErrorResponse;
+
+@autoRoute
+@armResourceAction(TResource)
+@post
+op ArmResourceActionNoContentSync<
+  TResource extends ArmResource,
+  TRequest extends object,
+  TBaseParameters = BaseParameters<TResource>
+>(
+  ...ResourceInstanceParameters<TResource, TBaseParameters>,
+
+  @doc("The content of the action request")
+  @body
+  body: TRequest
+): ArmNoContentResponse<"Action completed successfully."> | ErrorResponse;

package/lib/parameters.tsp

@@ -0,0 +1,126 @@
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using OpenAPI;
+using Azure.ResourceManager.Foundations;
+
+namespace Azure.ResourceManager;
+
+/**
+ * The default api-version parameter type.
+ */
+@doc("The default api-version parameter type.")
+model ApiVersionParameter {
+  @query("api-version")
+  @minLength(1)
+  @doc("The API version to use for this operation.")
+  @armCommonParameter("ApiVersionParameter")
+  @resourceParameterBaseFor(
+    [
+      ResourceHome.ResourceGroup,
+      ResourceHome.Subscription,
+      ResourceHome.Location,
+      ResourceHome.Tenant,
+      ResourceHome.Extension
+    ]
+  )
+  apiVersion: string;
+}
+
+/**
+ * The default subscriptionId parameter type.
+ */
+@doc("The default subscriptionId parameter type.")
+model SubscriptionIdParameter {
+  @path
+  @minLength(1)
+  @segment("subscriptions")
+  @doc("The ID of the target subscription.")
+  @armCommonParameter("SubscriptionIdParameter")
+  @resourceParameterBaseFor(
+    [ResourceHome.ResourceGroup, ResourceHome.Subscription, ResourceHome.Location]
+  )
+  subscriptionId: string;
+}
+
+/**
+ * The default subscriptionId parameter type.
+ */
+@doc("The default subscriptionId parameter type.")
+model LocationParameter {
+  @path
+  @minLength(1)
+  @segment("locations")
+  @doc("The location name.")
+  @resourceParameterBaseFor([ResourceHome.Location])
+  location: string;
+}
+
+/**
+ * The default resource group parameter type.
+ */
+@doc("The default resource group parameter type.")
+model ResourceGroupParameter {
+  @path
+  @minLength(1)
+  @maxLength(90)
+  @segment("resourceGroups")
+  @pattern("^[-\\w\\._\\(\\)]+$")
+  @doc("The name of the resource group. The name is case insensitive.")
+  @armCommonParameter("ResourceGroupNameParameter")
+  @resourceParameterBaseFor([ResourceHome.ResourceGroup])
+  resourceGroupName: string;
+}
+
+/**
+ * The default resourceUri parameter type.
+ */
+@doc("The default resourceUri parameter type.")
+model ResourceUriParameter {
+  @path
+  @doc("The fully qualified Azure Resource manager identifier of the resource.")
+  @extension("x-ms-skip-url-encoding", true)
+  @resourceParameterBaseFor([ResourceHome.Extension])
+  resourceUri: string;
+}
+
+/**
+ * The dynamic parameters of a resource instance - pass in the proper base type to indicate
+ * where the resource is based.  The default is in a resource group
+ */
+model ResourceInstanceParameters<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  ...TBaseParameters;
+  ...ProviderNamespace<TResource>;
+  ...KeysOf<TResource>;
+}
+
+/**
+ * The dynamic parameters of a list call for a resource instance - pass in the proper base type to indicate
+ * where the list should take place.  The default is in a resource group
+ */
+model ResourceParentParameters<
+  TResource extends ArmResource,
+  TBaseParameters = BaseParameters<TResource>
+> {
+  ...TBaseParameters;
+  ...ProviderNamespace<TResource>;
+  ...ParentKeysOf<TResource>;
+}
+
+/**
+ * The dynamic parameters of a list call for an extension resource instance.
+ */
+alias ExtensionResourceInstanceParameters<TResource extends ArmResource> = ResourceInstanceParameters<
+  TResource,
+  ExtensionBaseParameters
+>;
+
+/**
+ * The dynamic parameters of a list call for a tenant resource instance.
+ */
+alias TenantInstanceParameters<TResource extends ArmResource> = ResourceInstanceParameters<
+  TResource,
+  TenantBaseParameters
+>;

package/lib/responses.tsp

@@ -0,0 +1,47 @@
+using TypeSpec.Http;
+using TypeSpec.Rest;
+using OpenAPI;
+using Azure.ResourceManager.Foundations;
+
+namespace Azure.ResourceManager;
+
+@doc("ARM operation completed successfully.")
+model ArmResponse<T> {
+  ...OkResponse;
+  ...Body<T>;
+}
+
+@doc("ARM create operation completed successfully.")
+model ArmCreatedResponse<T> {
+  ...CreatedResponse;
+  ...Azure.Core.Foundations.RetryAfterHeader;
+  ...Body<T>;
+}
+
+@doc("Resource deleted successfully.")
+model ArmDeletedResponse {
+  ...OkResponse;
+}
+
+model ArmDeleteAcceptedResponse is ArmAcceptedResponse<"Resource deletion accepted.">;
+
+@doc(TMessage)
+model ArmAcceptedResponse<TMessage extends string = "Resource operation accepted."> {
+  ...AcceptedResponse;
+  ...Azure.Core.Foundations.RetryAfterHeader;
+}
+
+model ArmDeletedNoContentResponse is ArmNoContentResponse<"Resource deleted successfully.">;
+
+@doc(TMessage)
+model ArmNoContentResponse<TMessage extends string = "Operation completed successfully."> {
+  ...NoContentResponse;
+}
+
+@error
+@armCommonDefinition
+@doc("Common error response for all Azure Resource Manager APIs to return error details for failed operations.")
+model ErrorResponse {
+  @doc("The error object.")
+  error?: ErrorDetail;
+}

package/package.json

@@ -0,0 +1,85 @@
+{
+  "name": "@azure-tools/typespec-azure-resource-manager",
+  "version": "0.27.0",
+  "author": "Microsoft Corporation",
+  "description": "TypeSpec Azure Resource Manager library",
+  "homepage": "https://azure.github.io/typespec-azure",
+  "readme": "https://github.com/Microsoft/typespec/blob/master/README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Microsoft/typespec.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Microsot/typespec/issues"
+  },
+  "keywords": [
+    "typespec"
+  ],
+  "main": "dist/src/index.js",
+  "tspMain": "lib/arm.tsp",
+  "exports": {
+    ".": "./dist/src/index.js",
+    "./testing": "./dist/src/testing/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/src/index.d.ts"
+      ],
+      "testing": [
+        "./dist/src/testing/index.d.ts"
+      ]
+    }
+  },
+  "type": "module",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "lib/*.tsp",
+    "dist/**",
+    "!dist/test/**"
+  ],
+  "peerDependencies": {
+    "@typespec/compiler": "~0.41.0",
+    "@azure-tools/typespec-azure-core": "~0.27.0",
+    "@azure-tools/typespec-autorest": "~0.27.0",
+    "@typespec/openapi": "~0.41.0",
+    "@typespec/rest": "~0.41.0",
+    "@typespec/http": "~0.41.0",
+    "@typespec/versioning": "~0.41.0"
+  },
+  "dependencies": {
+    "@typespec/lint": "~0.41.0"
+  },
+  "devDependencies": {
+    "@typespec/compiler": "~0.41.0",
+    "@typespec/openapi": "~0.41.0",
+    "@azure-tools/typespec-azure-core": "~0.27.0",
+    "@azure-tools/typespec-autorest": "~0.27.0",
+    "@typespec/rest": "~0.41.0",
+    "@typespec/http": "~0.41.0",
+    "@typespec/versioning": "~0.41.0",
+    "@types/mocha": "~10.0.0",
+    "@types/node": "~18.11.9",
+    "@typespec/eslint-config-typespec": "~0.6.0",
+    "@typespec/library-linter": "~0.41.0",
+    "@typespec/eslint-plugin": "~0.41.0",
+    "eslint": "^8.12.0",
+    "mocha": "~10.1.0",
+    "c8": "~7.12.0",
+    "rimraf": "~3.0.2",
+    "typescript": "~4.9.3"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist ./temp",
+    "build": "tsc -p . && npm run lint-typespec-library",
+    "watch": "tsc -p . --watch",
+    "lint-typespec-library": "tsp compile . --warn-as-error --import @typespec/library-linter --no-emit",
+    "test": "mocha",
+    "test-official": "c8 mocha --forbid-only",
+    "lint": "eslint . --ext .ts --max-warnings=0",
+    "lint:fix": "eslint . --fix --ext .ts"
+  }
+}