@azure-typespec/http-client-csharp-mgmt 1.0.0-alpha.20260113.1 → 1.0.0-alpha.20260115.2

package/dist/generator/net10.0/Azure.Generator.Management.xml

@@ -89,24 +89,117 @@
         <member name="M:Azure.Generator.Management.ManagementTypeFactory.CreateNewProjectScaffolding">
             <inheritdoc/>
         </member>
-        <member name="T:Azure.Generator.Management.Models.ArmProviderSchema">
+        <member name="T:Azure.Generator.Management.Models.ContextualParameter">
             <summary>
-            Represents the unified ARM provider schema containing all resource metadata and non-resource methods.
-            This consolidates information previously scattered across @resourceSchema and @nonResourceMethodSchema decorators.
+            Represents a parameter whose value can be derived contextually from the resource identifier (Id) of its enclosing resource or resource collection.
+            <para>
+            A <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/> is used in Azure management SDK code generation to model parameters that do not need to be explicitly provided by the caller,
+            because their values can be computed from the resource's <see cref="T:Azure.Core.ResourceIdentifier"/>. For example, parameters such as "subscriptionId", "resourceGroupName",
+            or the name of a parent resource can often be extracted from the Id property of the resource or its parent.
+            </para>
+            <para>
+            Each contextual parameter is associated with a <c>Key</c> (the constant segment preceding the parameter in the request path),
+            a <c>VariableName</c> (the name of the parameter in the path), and a function that builds the value expression from a given `Id` instance.
+            </para>
+            <para>
+            The <see cref="M:Azure.Generator.Management.Models.ContextualParameter.BuildValueExpression(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.Core.ResourceIdentifier})"/> method is used to generate the code expression that retrieves the parameter value from the Id property,
+            enabling the SDK to automatically supply these values in generated client methods.
+            </para>
+            </summary>
+        </member>
+        <member name="T:Azure.Generator.Management.Models.OperationContext">
+            <summary>
+            Represents the context for an Azure resource operation, encapsulating the primary and (optionally) secondary request path patterns
+            and their associated contextual parameters.
+            <para>
+            The <see cref="T:Azure.Generator.Management.Models.OperationContext"/> is used during code generation to determine which parameters for an operation
+            can be derived contextually from the resource identifier (Id) of the enclosing resource or resource collection,
+            and which must be supplied by the caller. It analyzes the request path(s) to build a list of <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/>s,
+            which describe how to extract parameter values from the Id property.
+            </para>
+            <para>
+            A secondary contextual path is only provided in the case of a resource collection for a "tuple resource".
+            Unlike regular resources, which can be specified from their parent by a single parameter (typically their name),
+            tuple resources require multiple parameters to be specified from their parent—hence the name "tuple resource".
+            In such cases, the resource collection may need to take additional parameters from its constructor,
+            and the secondary contextual path is used to model this scenario and extract those parameters.
+            </para>
+            <para>
+            The <see cref="M:Azure.Generator.Management.Models.OperationContext.BuildParameterMapping(Azure.Generator.Management.Models.RequestPathPattern)"/> method enables mapping operation path parameters to their contextual sources,
+            supporting both primary and tuple resource collection scenarios.
+            </para>
+            </summary>
+        </member>
+        <member name="M:Azure.Generator.Management.Models.OperationContext.#ctor(Azure.Generator.Management.Models.RequestPathPattern,Azure.Generator.Management.Models.RequestPathPattern,System.Func{System.String,Microsoft.TypeSpec.Generator.Providers.FieldProvider})">
+            <summary>
+            Initializes a new instance of the OperationContext class with the specified primary and secondary request
+            path patterns.
+            </summary>
+            <param name="contextualPath">The primary request path pattern that defines the main context for the operation. Cannot be null.</param>
+            <param name="secondaryContextualPath">An optional secondary request path pattern that provides additional context for the operation. Can be null
+            if no secondary context is required.</param>
+            <param name="fieldSelector">The function to get the corresponding field for secondary contextual parameters.</param>
+        </member>
+        <member name="M:Azure.Generator.Management.Models.OperationContext.BuildContextualParameters(Azure.Generator.Management.Models.RequestPathPattern)">
+            <summary>
+            This method accepts a <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> as a contextual request path pattern
+            of a certain resource or resource collection class,
+            and builds a list of <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/>s that represent the parameters
+            provided by this contextual request path pattern.
             </summary>
+            <param name="contextualPath">The contextual request path pattern.</param>
+            <returns></returns>
         </member>
-        <member name="M:Azure.Generator.Management.Models.ArmProviderSchema.Deserialize(System.Collections.Generic.IReadOnlyDictionary{System.String,System.BinaryData},Azure.Generator.Management.ManagementInputLibrary,System.Func{Azure.Generator.Management.Models.NonResourceMethod,System.Boolean})">
+        <member name="M:Azure.Generator.Management.Models.OperationContext.BuildParameterMapping(Azure.Generator.Management.Models.RequestPathPattern)">
             <summary>
-            Deserializes the ArmProviderSchema from decorator arguments.
+            Builds a mapping from operation path parameters to contextual parameters.
+            Parameters are matched based on the position of their variable segments within the shared
+            prefix between the operation path and the contextual (and secondary contextual) paths.
             </summary>
-            <param name="arguments">The decorator arguments containing resources and nonResourceMethods data</param>
-            <param name="library">The management input library containing models cache</param>
-            <param name="methodFilter">Optional predicate to filter non-resource methods</param>
-            <returns>A new ArmProviderSchema instance</returns>
+            <param name="operationPath">The operation's request path.</param>
+            <returns>A parameter mapping that maps operation parameter names to contextual parameters.</returns>
         </member>
-        <member name="T:Azure.Generator.Management.Models.ContextualParameter">
+        <member name="T:Azure.Generator.Management.Models.ParameterContextMapping">
+            <summary>
+            Represents a mapping between an operation parameter name and its contextual information.
+            <para>
+            The <see cref="T:Azure.Generator.Management.Models.ParameterContextMapping"/> associates a parameter name with a <see cref="P:Azure.Generator.Management.Models.ParameterContextMapping.ContextualParameter"/>,
+            if the parameter can be derived from the resource identifier (Id) of the enclosing resource or resource collection.
+            If <see cref="P:Azure.Generator.Management.Models.ParameterContextMapping.ContextualParameter"/> is <c>null</c>, the parameter is considered a pass-through parameter and must be provided by the caller.
+            </para>
+            <para>
+            This record is used within <see cref="T:Azure.Generator.Management.Models.ParameterContextRegistry"/> to describe how each operation parameter should be resolved
+            during code generation for Azure management SDKs.
+            </para>
+            </summary>
+        </member>
+        <member name="M:Azure.Generator.Management.Models.ParameterContextMapping.#ctor(System.String,Azure.Generator.Management.Models.ContextualParameter)">
             <summary>
-            A <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/> represents a parameter which could be determined contextually from the Id property of its enclosing resource or resource collection class.
+            Represents a mapping between an operation parameter name and its contextual information.
+            <para>
+            The <see cref="T:Azure.Generator.Management.Models.ParameterContextMapping"/> associates a parameter name with a <see cref="P:Azure.Generator.Management.Models.ParameterContextMapping.ContextualParameter"/>,
+            if the parameter can be derived from the resource identifier (Id) of the enclosing resource or resource collection.
+            If <see cref="P:Azure.Generator.Management.Models.ParameterContextMapping.ContextualParameter"/> is <c>null</c>, the parameter is considered a pass-through parameter and must be provided by the caller.
+            </para>
+            <para>
+            This record is used within <see cref="T:Azure.Generator.Management.Models.ParameterContextRegistry"/> to describe how each operation parameter should be resolved
+            during code generation for Azure management SDKs.
+            </para>
+            </summary>
+        </member>
+        <member name="T:Azure.Generator.Management.Models.ParameterContextRegistry">
+            <summary>
+            Represents a registry that maps parameter names to their contextual information for a given operation.
+            <para>
+            The <see cref="T:Azure.Generator.Management.Models.ParameterContextRegistry"/> is used to associate operation parameters with their corresponding
+            <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/> (if available), which describes how a parameter value can be derived from the
+            resource identifier (Id) of the enclosing resource or resource collection. This mapping enables the generator
+            to determine which parameters are contextually available and which are pass-through (must be supplied by the caller).
+            </para>
+            <para>
+            The registry provides lookup and enumeration capabilities for parameter mappings, and supports argument population
+            for method invocations by resolving contextual values or falling back to method parameters as needed.
+            </para>
             </summary>
         </member>
         <member name="T:Azure.Generator.Management.Models.RequestPathPattern">
@@ -132,13 +225,17 @@
             <returns></returns>
             <exception cref="T:System.InvalidOperationException">if this.IsAncestorOf(other) is false</exception>
         </member>
-        <member name="M:Azure.Generator.Management.Models.RequestPathPattern.TryGetContextualParameter(Microsoft.TypeSpec.Generator.Providers.ParameterProvider,Azure.Generator.Management.Models.ContextualParameter@)">
+        <member name="M:Azure.Generator.Management.Models.RequestPathPattern.GetMaximumSharingSegmentsCount(Azure.Generator.Management.Models.RequestPathPattern,Azure.Generator.Management.Models.RequestPathPattern)">
             <summary>
-            Get the corresponding contextual parameter in this request path for a provided parameter.
+            Returns the number of shared segments between two <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> instances,
+            starting from the beginning of the paths. Segments are considered shared if both are variable segments,
+            or if both are constant segments with equal values. The comparison stops at the first non-matching segment.
             </summary>
-            <param name="parameter"></param>
-            <param name="contextualParameter"></param>
-            <returns></returns>
+            <param name="left">The first <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> to compare.</param>
+            <param name="right">The second <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> to compare.</param>
+            <returns>
+            The count of shared segments between the two paths.
+            </returns>
         </member>
         <member name="P:Azure.Generator.Management.Models.RequestPathSegment.Value">
             <summary>
@@ -162,6 +259,21 @@
             Returns true if this segment is the "providers" segment.
             </summary>
         </member>
+        <member name="T:Azure.Generator.Management.Models.ArmProviderSchema">
+            <summary>
+            Represents the unified ARM provider schema containing all resource metadata and non-resource methods.
+            This consolidates information previously scattered across @resourceSchema and @nonResourceMethodSchema decorators.
+            </summary>
+        </member>
+        <member name="M:Azure.Generator.Management.Models.ArmProviderSchema.Deserialize(System.Collections.Generic.IReadOnlyDictionary{System.String,System.BinaryData},Azure.Generator.Management.ManagementInputLibrary,System.Func{Azure.Generator.Management.Models.NonResourceMethod,System.Boolean})">
+            <summary>
+            Deserializes the ArmProviderSchema from decorator arguments.
+            </summary>
+            <param name="arguments">The decorator arguments containing resources and nonResourceMethods data</param>
+            <param name="library">The management input library containing models cache</param>
+            <param name="methodFilter">Optional predicate to filter non-resource methods</param>
+            <returns>A new ArmProviderSchema instance</returns>
+        </member>
         <member name="T:Azure.Generator.Management.Models.RestClientInfo">
             <summary>
             Record to combine client provider and related field providers
@@ -229,12 +341,12 @@
             Provider for building operation methods in resource clients.
             </summary>
         </member>
-        <member name="M:Azure.Generator.Management.Providers.OperationMethodProviders.ResourceOperationMethodProvider.#ctor(Microsoft.TypeSpec.Generator.Providers.TypeProvider,Azure.Generator.Management.Models.RequestPathPattern,Azure.Generator.Management.Models.RestClientInfo,Microsoft.TypeSpec.Generator.Input.InputServiceMethod,System.Boolean,System.String,System.FormattableString,System.Boolean)">
+        <member name="M:Azure.Generator.Management.Providers.OperationMethodProviders.ResourceOperationMethodProvider.#ctor(Microsoft.TypeSpec.Generator.Providers.TypeProvider,Azure.Generator.Management.Models.OperationContext,Azure.Generator.Management.Models.RestClientInfo,Microsoft.TypeSpec.Generator.Input.InputServiceMethod,System.Boolean,System.String,System.FormattableString,System.Boolean)">
             <summary>
             Creates a new instance of <see cref="T:Azure.Generator.Management.Providers.OperationMethodProviders.ResourceOperationMethodProvider"/> which represents a method on a client
             </summary>
             <param name="enclosingType">The enclosing type of this operation. </param>
-            <param name="contextualPath">The contextual path of the enclosing type. </param>
+            <param name="operationContext">The contextual path of the enclosing type. </param>
             <param name="restClientInfo">The rest client information containing the client provider and related fields. </param>
             <param name="method">The input service method that we are building from. </param>
             <param name="isAsync">Whether this method is an async method. </param>
@@ -258,7 +370,7 @@
             Provides a resource client type.
             </summary>
         </member>
-        <member name="M:Azure.Generator.Management.Providers.ResourceCollectionClientProvider.GetContextualRequestPattern(Azure.Generator.Management.Models.ResourceMetadata)">
+        <member name="M:Azure.Generator.Management.Providers.ResourceCollectionClientProvider.GetContextualPath(Azure.Generator.Management.Models.ResourceMetadata)">
             <summary>
             Get the contextual request path pattern for this collection client.
             The contextual request path pattern for a collection should always be the request path pattern of the parent resource.
@@ -308,16 +420,6 @@
             </summary>
             <param name="enclosingType">The type provider to build the constructor for.</param>
         </member>
-        <member name="M:Azure.Generator.Management.Utilities.ContextualParameterBuilder.BuildContextualParameters(Azure.Generator.Management.Models.RequestPathPattern)">
-            <summary>
-            This method accepts a <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> as a contextual request path pattern
-            of a certain resource or resource collection class,
-            and builds a list of <see cref="T:Azure.Generator.Management.Models.ContextualParameter"/>s that represent the parameters
-            provided by this contextual request path pattern.
-            </summary>
-            <param name="requestPathPattern">The contextual request path pattern.</param>
-            <returns></returns>
-        </member>
         <member name="M:Azure.Generator.Management.Utilities.ResourceHelpers.GetOperationMethodName(Azure.Generator.Management.Models.ResourceOperationKind,System.Boolean,System.Boolean)">
             <summary>
             Gets the appropriate method name for a resource operation based on its kind.
@@ -354,6 +456,21 @@
             <param name="serviceMethod">The input service method to construct the operation ID from.</param>
             <returns>The constructed operation ID string.</returns>
         </member>
+        <member name="M:Azure.Generator.Management.Utilities.ResourceHelpers.GetRequestPathParameterType(System.String,Microsoft.TypeSpec.Generator.Input.InputServiceMethod)">
+            <summary>
+            Gets the C# type for a request path parameter by its name from the given <see cref="T:Microsoft.TypeSpec.Generator.Input.InputServiceMethod"/>.
+            <para>
+            This method searches the operation's parameters for a path parameter matching <paramref name="parameterName"/> and returns its C# type.
+            If the parameter is not found, it defaults to <see cref="T:System.String"/> and emits a warning diagnostic.
+            </para>
+            <para>
+            For backward compatibility, if the parameter is named "subscriptionId" and its type is <see cref="T:System.Guid"/>, the method returns <see cref="T:System.String"/>.
+            </para>
+            </summary>
+            <param name="parameterName">The name of the path parameter to look up.</param>
+            <param name="inputMethod">The input service method containing the operation and its parameters.</param>
+            <returns>The resolved <see cref="T:Microsoft.TypeSpec.Generator.Primitives.CSharpType"/> for the specified parameter, or <see cref="T:System.String"/> if not found.</returns>
+        </member>
         <member name="M:Azure.Generator.Management.Utilities.ResourceHelpers.BuildEnhancedXmlDocs(Microsoft.TypeSpec.Generator.Input.InputServiceMethod,System.FormattableString,Microsoft.TypeSpec.Generator.Providers.TypeProvider,Microsoft.TypeSpec.Generator.Providers.XmlDocProvider)">
             <summary>
             Builds enhanced XML documentation with structured XmlDocStatement objects for proper XML rendering.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-typespec/http-client-csharp-mgmt",
-  "version": "1.0.0-alpha.20260113.1",
+  "version": "1.0.0-alpha.20260115.2",
   "author": "Microsoft Corporation",
   "description": "TypeSpec library for emitting Azure management libraries for C#.",
   "readme": "https://github.com/Azure/azure-sdk-for-net/blob/main/eng/packages/http-client-csharp-mgmt/README.md",