@azure-tools/typespec-azure-resource-manager 0.58.0-dev.2 → 0.58.0-dev.3

package/lib/extension/parameters.tsp

@@ -0,0 +1,223 @@
+namespace Azure.ResourceManager.Extension;
+
+using Http;
+using Rest;
+using Azure.ResourceManager.Private;
+using Azure.ResourceManager.Extension.Private;
+using Azure.ResourceManager.CommonTypes;
+
+/**
+ * The default scope parameter for an extension resource.
+ * @template Type The type of the scope parameter (default is string). This can be used to specify `Azure.Core.armResourceIdentifier` type or other constrained type
+ *
+ * @example
+ * ```typespec
+ * model Employee {
+ *  ...ResourceUriParameter;
+ * }
+ * ```
+ */
+@builtInResource
+model ScopeParameter<Type extends string = string> {
+  @path(#{ allowReserved: true })
+  @key
+  @doc("The fully qualified Azure Resource manager identifier of the resource.")
+  scope: Type;
+}
+
+/**
+ * Base parameters for an extension target.
+ * @template Resource The resource model for an extension target (usually Extension.Tenant, Extension.Subscription, Extension.ResourceGroup, Extension.Scope, Extension.ManagementGroup or an external resource).
+ *
+ */
+@resourceBaseParametersOf(Resource)
+model TargetBaseParameters<Resource extends {}> {
+  ...ApiVersionParameter;
+
+  // unless built-in, tenant or extension
+  ...CommonTypes.SubscriptionIdParameter;
+
+  // unless built-in tenant, subscription, location, or extension
+  ...CommonTypes.ResourceGroupNameParameter;
+
+  // unless built-in
+  ...TargetProviderNamespace<Resource>;
+}
+
+/** The path parameters for a target resource for an extension
+ * @template Resource The resource model for an extension target (usually Extension.Tenant, Extension.Subscription, Extension.ResourceGroup, Extension.Scope, Extension.ManagementGroup or an external resource).
+ */
+model TargetParameters<Resource extends {}> {
+  ...TargetBaseParameters<Resource>;
+  ...KeysOf<Resource>;
+}
+
+/** The provider namespace for an extension resource
+ * @template Resource The extension resource model
+ */
+model ExtensionProviderNamespace<Resource extends {}> {
+  @path
+  @segment("providers")
+  @assignUniqueProviderNameValue(Resource)
+  @doc("The provider namespace for the resource.")
+  extensionProvider: "Microsoft.ExtensionProviderNamespace";
+}
+
+/** The provider namespace (if any) for a target resource for an extension
+ * @template Resource The resource model for an extension target (usually Extension.Tenant, Extension.Subscription, Extension.ResourceGroup, Extension.Scope, Extension.ManagementGroup or an external resource)
+ */
+model TargetProviderNamespace<Resource extends {}> {
+  @resourceParameterBaseFor(
+    [
+      ResourceHome.Extension,
+      ResourceHome.Location,
+      ResourceHome.ResourceGroup,
+      ResourceHome.Subscription,
+      ResourceHome.Tenant
+    ]
+  )
+  @path
+  @segment("providers")
+  @doc("The provider namespace for the resource.")
+  @assignUniqueProviderNameValue(Resource)
+  provider: "Microsoft.TargetProviderNamespace";
+}
+
+/** The path parameters for an extension resource at the given target
+ * @template TargetResource The target of the extension resource (Extension.Tenant, Extension.Subscription, Extension.ResourceGroup, Extension.Scope, Extension.ManagementGroup or another resource).
+ * @template Resource The extension resource.
+ */
+model ExtensionInstanceParameters<TargetResource extends {}, Resource extends {}> {
+  ...TargetParameters<TargetResource>;
+  ...ExtensionProviderNamespace<Resource>;
+  ...KeysOf<Resource>;
+}
+
+/** The path parameters for a collection of extension resources at the given target
+ * @template TargetResource The target of the extension resource (Extension.Tenant, Extension.Subscription, Extension.ResourceGroup, Extension.Scope, Extension.ManagementGroup or another resource).
+ * @template ExtensionResource The extension resource.
+ */
+model ExtensionParentParameters<TargetResource extends {}, ExtensionResource extends {}> {
+  ...TargetParameters<TargetResource>;
+  ...ExtensionProviderNamespace<ExtensionResource>;
+  ...ParentKeysOf<ExtensionResource>;
+}
+
+/** A tenant target for the extension resource */
+@builtInResource
+model Tenant {}
+
+/** A management group
+ * @template ParameterName The name of the 'name' parameter of the management group (usually managementGroupName or managementGroupId).
+ */
+@tenantResource
+@armVirtualResource("Microsoft.Management")
+model ManagementGroup<ParameterName extends valueof string = "managementGroupName"> {
+  @path
+  @minLength(1)
+  @segment("managementGroups")
+  @key(ParameterName)
+  @doc("The management group ID.")
+  name: string;
+}
+
+/** An external resource target, used when an extension targets a resource from another provider namespace
+ * @template TargetNamespace The provider namespace for the external resource.
+ * @template ResourceType The type of the external resource.
+ * @template ResourceParameterName The name of the 'name' parameter of the external resource.
+ * @template NamePattern The pattern restriction for the name of the external resource (default is none).
+ * @template NameType The type of the name parameter of the external resource (default is string).
+ * @template Description The description of the name parameter of the external resource (default is "The name of the resource").
+ *
+ * @example
+ * ```typespec
+ * alias VirtualMachine = ExternalResource<"Microsoft.Compute", "virtualMachines", "vmName">;
+ *
+ * ```
+ *
+ * @example
+ * ```typespec
+ * alias Scaleset = Extension.ExternalResource<
+ *   "Microsoft.Compute",
+ *   "virtualMachineScaleSets",
+ *   "scaleSetName"
+ * >;
+ 
+ * ```
+ */
+@doc("")
+@armVirtualResource(TargetNamespace)
+@Http.Private.includeInapplicableMetadataInPayload(false)
+model ExternalResource<
+  TargetNamespace extends valueof string,
+  ResourceType extends valueof string,
+  ResourceParameterName extends valueof string,
+  NamePattern extends valueof string = "",
+  NameType extends string = string,
+  Description extends valueof string = "The name of the resource"
+> {
+  @doc(Description)
+  @visibility(Lifecycle.Read)
+  @path
+  @key(ResourceParameterName)
+  @segment(ResourceType)
+  @pattern(NamePattern)
+  name: NameType;
+}
+
+/** An external child resource target, used when an extension targets a child resource from another provider namespace
+ * @template ParentModel The parent of this resource.
+ * @template ResourceType The type of this resource.
+ * @template ResourceParameterName The name of the 'name' parameter of this resource.
+ * @template NamePattern The pattern restriction for the name of this resource (default is none).
+ * @template NameType The type of the name parameter of this resource (default is string).
+ * @template Description The description of the name parameter of this resource (default is "The name of the resource").
+ *
+ * @example
+ * ```typespec
+ * alias VirtualMachine = ExternalResource<"Microsoft.Compute", "virtualMachines", "vmName">;
+ *
+ * ```
+ *
+ * @example
+ * ```typespec
+ * alias Scaleset = Extension.ExternalResource<
+ *   "Microsoft.Compute",
+ *   "virtualMachineScaleSets",
+ *   "scaleSetName"
+ * >;
+ *
+ * alias VirtualMachineScaleSetVm = Extension.ExternalChildResource<
+ *   Scaleset,
+ *   "virtualMachineScaleSetVms",
+ *   "scaleSetVmName"
+ * >;
+ *
+ * ```
+ */
+@doc("")
+@parentResource(ParentModel)
+@Http.Private.includeInapplicableMetadataInPayload(false)
+model ExternalChildResource<
+  ParentModel extends {},
+  ResourceType extends valueof string,
+  ResourceParameterName extends valueof string,
+  NamePattern extends valueof string = "",
+  NameType extends string = string,
+  Description extends valueof string = "The name of the resource"
+> {
+  @doc(Description)
+  @visibility(Lifecycle.Read)
+  @path
+  @key(ResourceParameterName)
+  @segment(ResourceType)
+  @pattern(NamePattern)
+  name: NameType;
+}
+/** A subscription target for an extension resource */
+@builtInSubscriptionResource
+model Subscription {}
+
+/** A resource group target for an extension resource */
+@builtInResourceGroupResource
+model ResourceGroup {}

package/lib/extension/private.decorators.tsp

@@ -0,0 +1,24 @@
+using Reflection;
+
+namespace Azure.ResourceManager.Extension.Private;
+
+/**
+ * `@builtInResource` marks a model as built-in to Azure ResourceManager at the tenant level
+ *
+ * @param target - The model that is marked as built-in.
+ */
+extern dec builtInResource(target: Model);
+
+/**
+ * `@builtInSubscriptionResource` marks a model as built-in to Azure ResourceManager at the Subscription level
+ *
+ * @param target - The model that is marked as built-in.
+ */
+extern dec builtInSubscriptionResource(target: Model);
+
+/**
+ * `@builtInResourceGroupResource` marks a model as built-in to Azure ResourceManager at the ResourceGroup level
+ *
+ * @param target - The model that is marked as built-in.
+ */
+extern dec builtInResourceGroupResource(target: Model);

package/lib/private.decorators.tsp

@@ -14,6 +14,11 @@ extern dec armUpdateProviderNamespace(target: Reflection.Operation);
  */
 extern dec assignProviderNameValue(target: ModelProperty, resource: Model);
 
+/**
+ * @param resource Resource model
+ */
+extern dec assignUniqueProviderNameValue(target: ModelProperty, resource: Model);
+
 /**
  * This decorator is used to identify Azure Resource Manager resource types and extract their
  * metadata.  It is *not* meant to be used directly by a spec author, it instead

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-resource-manager",
-  "version": "0.58.0-dev.2",
+  "version": "0.58.0-dev.3",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Resource Manager library",
   "homepage": "https://azure.github.io/typespec-azure",