@azure-typespec/http-client-csharp-mgmt 1.0.0-alpha.20250716.1 → 1.0.0-alpha.20250722.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@
6
6
  "compilationOptions": {},
7
7
  "targets": {
8
8
  ".NETCoreApp,Version=v8.0": {
9
- "Azure.Generator.Management/1.0.0-alpha.20250716.1": {
9
+ "Azure.Generator.Management/1.0.0-alpha.20250722.1": {
10
10
  "dependencies": {
11
11
  "Azure.Core": "1.47.1",
12
12
  "Azure.Generator": "1.0.0-alpha.20250715.3",
@@ -670,7 +670,7 @@
670
670
  }
671
671
  },
672
672
  "libraries": {
673
- "Azure.Generator.Management/1.0.0-alpha.20250716.1": {
673
+ "Azure.Generator.Management/1.0.0-alpha.20250722.1": {
674
674
  "type": "project",
675
675
  "serviceable": false,
676
676
  "sha512": ""
@@ -82,6 +82,11 @@
82
82
  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.
83
83
  </summary>
84
84
  </member>
85
+ <member name="T:Azure.Generator.Management.Models.RequestPathPattern">
86
+ <summary>
87
+ This class provides the pattern of an operation request path.
88
+ </summary>
89
+ </member>
85
90
  <member name="M:Azure.Generator.Management.Models.RequestPathPattern.IsAncestorOf(Azure.Generator.Management.Models.RequestPathPattern)">
86
91
  <summary>
87
92
  Check if this <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> is a prefix path of the other request path.
@@ -100,6 +105,14 @@
100
105
  <returns></returns>
101
106
  <exception cref="T:System.InvalidOperationException">if this.IsAncestorOf(other) is false</exception>
102
107
  </member>
108
+ <member name="M:Azure.Generator.Management.Models.RequestPathPattern.TryGetContextualParameter(Microsoft.TypeSpec.Generator.Providers.ParameterProvider,Azure.Generator.Management.Models.ContextualParameter@)">
109
+ <summary>
110
+ Get the corresponding contextual parameter in this request path for a provided parameter.
111
+ </summary>
112
+ <param name="parameter"></param>
113
+ <param name="contextualParameter"></param>
114
+ <returns></returns>
115
+ </member>
103
116
  <member name="P:Azure.Generator.Management.Models.RequestPathSegment.Value">
104
117
  <summary>
105
118
  Returns the literal value of this segment.
@@ -122,6 +135,16 @@
122
135
  Returns true if this segment is the "providers" segment.
123
136
  </summary>
124
137
  </member>
138
+ <member name="T:Azure.Generator.Management.Models.RestClientInfo">
139
+ <summary>
140
+ Record to combine client provider and related field providers
141
+ </summary>
142
+ </member>
143
+ <member name="M:Azure.Generator.Management.Models.RestClientInfo.#ctor(Microsoft.TypeSpec.Generator.ClientModel.Providers.ClientProvider,Microsoft.TypeSpec.Generator.Providers.FieldProvider,Microsoft.TypeSpec.Generator.Providers.FieldProvider)">
144
+ <summary>
145
+ Record to combine client provider and related field providers
146
+ </summary>
147
+ </member>
125
148
  <member name="M:Azure.Generator.Management.Providers.Abstraction.ManagementHttpPipelineProvider.FromExpression(Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
126
149
  <inheritdoc/>
127
150
  </member>
@@ -130,6 +153,17 @@
130
153
  Provider for building operation methods in resource clients.
131
154
  </summary>
132
155
  </member>
156
+ <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,Microsoft.TypeSpec.Generator.Providers.MethodProvider,System.Boolean)">
157
+ <summary>
158
+ Creates a new instance of <see cref="T:Azure.Generator.Management.Providers.OperationMethodProviders.ResourceOperationMethodProvider"/> which represents a method on a client
159
+ </summary>
160
+ <param name="enclosingType">The enclosing type of this operation. </param>
161
+ <param name="contextualPath">The contextual path of the enclosing type. </param>
162
+ <param name="restClientInfo">The rest client information containing the client provider and related fields. </param>
163
+ <param name="method">The input service method that we are building from. </param>
164
+ <param name="convenienceMethod">The corresponding convenience method provided by the generator framework. </param>
165
+ <param name="isAsync">Whether this method is an async method. </param>
166
+ </member>
133
167
  <member name="T:Azure.Generator.Management.Providers.ResourceClientProvider">
134
168
  <summary>
135
169
  Provides a resource client type.
@@ -144,6 +178,34 @@
144
178
  <returns></returns>
145
179
  <exception cref="T:System.NotSupportedException"></exception>
146
180
  </member>
181
+ <member name="M:Azure.Generator.Management.Snippets.ArmCollectionSnippets.ValidateResourceId(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmCollection},Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
182
+ <summary>
183
+ Constructs a method expression that calls the ValidateResourceId method on the ArmCollection type.
184
+ Note: this method is a static method, the <paramref name="type"/> must be a static type reference of the type.
185
+ Also the abstract class ArmCollection does not have a ValidateResourceId method, but our generated ArmCollection's derived classes will always have one.
186
+ </summary>
187
+ <param name="type"></param>
188
+ <param name="id"></param>
189
+ <returns></returns>
190
+ </member>
191
+ <member name="M:Azure.Generator.Management.Snippets.ArmResourceSnippets.ResourceType(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmResource})">
192
+ <summary>
193
+ Returns the "ResourceType" property on an ArmResource.
194
+ Note: the abstract class ArmResource does not have a ResourceType property, but our generated ArmResource's derived classes will always have one.
195
+ </summary>
196
+ <param name="resource"></param>
197
+ <returns></returns>
198
+ </member>
199
+ <member name="M:Azure.Generator.Management.Snippets.ArmResourceSnippets.ValidateResourceId(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmResource},Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
200
+ <summary>
201
+ Constructs a method expression that calls the ValidateResourceId method on the ArmResource type.
202
+ Note: this method is a static method, the <paramref name="type"/> must be a static type reference of the type.
203
+ Also the abstract class ArmResource does not have a ValidateResourceId method, but our generated ArmResource's derived classes will always have one.
204
+ </summary>
205
+ <param name="type"></param>
206
+ <param name="id"></param>
207
+ <returns></returns>
208
+ </member>
147
209
  <member name="M:Azure.Generator.Management.Utilities.ConstructorProviderHelpers.BuildMockingConstructor(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
148
210
  <summary>
149
211
  Builds a constructor for the enclosing type for mocking purposes.
@@ -160,6 +222,24 @@
160
222
  <param name="requestPathPattern">The contextual request path pattern.</param>
161
223
  <returns></returns>
162
224
  </member>
225
+ <member name="M:Azure.Generator.Management.Utilities.ResourceMetadataExtensions.CreateClientInfosMap(Azure.Generator.Management.Models.ResourceMetadata,Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
226
+ <summary>
227
+ Creates a dictionary mapping InputClient to RestClientInfo for all distinct clients used by the resource.
228
+ </summary>
229
+ <param name="resourceMetadata">The resource metadata containing the method to client mapping.</param>
230
+ <param name="clientProvider">The client provider that will own the fields.</param>
231
+ <returns>A dictionary mapping InputClient to RestClientInfo.</returns>
232
+ </member>
233
+ <member name="M:Azure.Generator.Management.Utilities.ResourceMetadataExtensions.GetRestClientForServiceMethod(Azure.Generator.Management.Models.ResourceMetadata,Microsoft.TypeSpec.Generator.Input.InputServiceMethod,System.Collections.Generic.Dictionary{Microsoft.TypeSpec.Generator.Input.InputClient,Azure.Generator.Management.Models.RestClientInfo})">
234
+ <summary>
235
+ Gets the RestClientInfo for a specific service method based on the method-to-client mapping.
236
+ </summary>
237
+ <param name="resourceMetadata">The resource metadata containing the method to client mapping.</param>
238
+ <param name="serviceMethod">The service method to get the rest client info for.</param>
239
+ <param name="clientInfos">The dictionary mapping InputClient to RestClientInfo.</param>
240
+ <returns>The RestClientInfo for the specified service method.</returns>
241
+ <exception cref="T:System.InvalidOperationException">Thrown when no client mapping is found for the service method.</exception>
242
+ </member>
163
243
  <member name="M:Azure.Generator.Management.Visitors.RestClientVisitor.VisitType(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
164
244
  <inheritdoc/>
165
245
  </member>
@@ -6,7 +6,7 @@
6
6
  "compilationOptions": {},
7
7
  "targets": {
8
8
  ".NETCoreApp,Version=v8.0": {
9
- "Azure.Generator.Management/1.0.0-alpha.20250716.1": {
9
+ "Azure.Generator.Management/1.0.0-alpha.20250722.1": {
10
10
  "dependencies": {
11
11
  "Azure.Core": "1.47.1",
12
12
  "Azure.Generator": "1.0.0-alpha.20250715.3",
@@ -670,7 +670,7 @@
670
670
  }
671
671
  },
672
672
  "libraries": {
673
- "Azure.Generator.Management/1.0.0-alpha.20250716.1": {
673
+ "Azure.Generator.Management/1.0.0-alpha.20250722.1": {
674
674
  "type": "project",
675
675
  "serviceable": false,
676
676
  "sha512": ""
@@ -82,6 +82,11 @@
82
82
  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.
83
83
  </summary>
84
84
  </member>
85
+ <member name="T:Azure.Generator.Management.Models.RequestPathPattern">
86
+ <summary>
87
+ This class provides the pattern of an operation request path.
88
+ </summary>
89
+ </member>
85
90
  <member name="M:Azure.Generator.Management.Models.RequestPathPattern.IsAncestorOf(Azure.Generator.Management.Models.RequestPathPattern)">
86
91
  <summary>
87
92
  Check if this <see cref="T:Azure.Generator.Management.Models.RequestPathPattern"/> is a prefix path of the other request path.
@@ -100,6 +105,14 @@
100
105
  <returns></returns>
101
106
  <exception cref="T:System.InvalidOperationException">if this.IsAncestorOf(other) is false</exception>
102
107
  </member>
108
+ <member name="M:Azure.Generator.Management.Models.RequestPathPattern.TryGetContextualParameter(Microsoft.TypeSpec.Generator.Providers.ParameterProvider,Azure.Generator.Management.Models.ContextualParameter@)">
109
+ <summary>
110
+ Get the corresponding contextual parameter in this request path for a provided parameter.
111
+ </summary>
112
+ <param name="parameter"></param>
113
+ <param name="contextualParameter"></param>
114
+ <returns></returns>
115
+ </member>
103
116
  <member name="P:Azure.Generator.Management.Models.RequestPathSegment.Value">
104
117
  <summary>
105
118
  Returns the literal value of this segment.
@@ -122,6 +135,16 @@
122
135
  Returns true if this segment is the "providers" segment.
123
136
  </summary>
124
137
  </member>
138
+ <member name="T:Azure.Generator.Management.Models.RestClientInfo">
139
+ <summary>
140
+ Record to combine client provider and related field providers
141
+ </summary>
142
+ </member>
143
+ <member name="M:Azure.Generator.Management.Models.RestClientInfo.#ctor(Microsoft.TypeSpec.Generator.ClientModel.Providers.ClientProvider,Microsoft.TypeSpec.Generator.Providers.FieldProvider,Microsoft.TypeSpec.Generator.Providers.FieldProvider)">
144
+ <summary>
145
+ Record to combine client provider and related field providers
146
+ </summary>
147
+ </member>
125
148
  <member name="M:Azure.Generator.Management.Providers.Abstraction.ManagementHttpPipelineProvider.FromExpression(Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
126
149
  <inheritdoc/>
127
150
  </member>
@@ -130,6 +153,17 @@
130
153
  Provider for building operation methods in resource clients.
131
154
  </summary>
132
155
  </member>
156
+ <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,Microsoft.TypeSpec.Generator.Providers.MethodProvider,System.Boolean)">
157
+ <summary>
158
+ Creates a new instance of <see cref="T:Azure.Generator.Management.Providers.OperationMethodProviders.ResourceOperationMethodProvider"/> which represents a method on a client
159
+ </summary>
160
+ <param name="enclosingType">The enclosing type of this operation. </param>
161
+ <param name="contextualPath">The contextual path of the enclosing type. </param>
162
+ <param name="restClientInfo">The rest client information containing the client provider and related fields. </param>
163
+ <param name="method">The input service method that we are building from. </param>
164
+ <param name="convenienceMethod">The corresponding convenience method provided by the generator framework. </param>
165
+ <param name="isAsync">Whether this method is an async method. </param>
166
+ </member>
133
167
  <member name="T:Azure.Generator.Management.Providers.ResourceClientProvider">
134
168
  <summary>
135
169
  Provides a resource client type.
@@ -144,6 +178,34 @@
144
178
  <returns></returns>
145
179
  <exception cref="T:System.NotSupportedException"></exception>
146
180
  </member>
181
+ <member name="M:Azure.Generator.Management.Snippets.ArmCollectionSnippets.ValidateResourceId(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmCollection},Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
182
+ <summary>
183
+ Constructs a method expression that calls the ValidateResourceId method on the ArmCollection type.
184
+ Note: this method is a static method, the <paramref name="type"/> must be a static type reference of the type.
185
+ Also the abstract class ArmCollection does not have a ValidateResourceId method, but our generated ArmCollection's derived classes will always have one.
186
+ </summary>
187
+ <param name="type"></param>
188
+ <param name="id"></param>
189
+ <returns></returns>
190
+ </member>
191
+ <member name="M:Azure.Generator.Management.Snippets.ArmResourceSnippets.ResourceType(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmResource})">
192
+ <summary>
193
+ Returns the "ResourceType" property on an ArmResource.
194
+ Note: the abstract class ArmResource does not have a ResourceType property, but our generated ArmResource's derived classes will always have one.
195
+ </summary>
196
+ <param name="resource"></param>
197
+ <returns></returns>
198
+ </member>
199
+ <member name="M:Azure.Generator.Management.Snippets.ArmResourceSnippets.ValidateResourceId(Microsoft.TypeSpec.Generator.Snippets.ScopedApi{Azure.ResourceManager.ArmResource},Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
200
+ <summary>
201
+ Constructs a method expression that calls the ValidateResourceId method on the ArmResource type.
202
+ Note: this method is a static method, the <paramref name="type"/> must be a static type reference of the type.
203
+ Also the abstract class ArmResource does not have a ValidateResourceId method, but our generated ArmResource's derived classes will always have one.
204
+ </summary>
205
+ <param name="type"></param>
206
+ <param name="id"></param>
207
+ <returns></returns>
208
+ </member>
147
209
  <member name="M:Azure.Generator.Management.Utilities.ConstructorProviderHelpers.BuildMockingConstructor(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
148
210
  <summary>
149
211
  Builds a constructor for the enclosing type for mocking purposes.
@@ -160,6 +222,24 @@
160
222
  <param name="requestPathPattern">The contextual request path pattern.</param>
161
223
  <returns></returns>
162
224
  </member>
225
+ <member name="M:Azure.Generator.Management.Utilities.ResourceMetadataExtensions.CreateClientInfosMap(Azure.Generator.Management.Models.ResourceMetadata,Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
226
+ <summary>
227
+ Creates a dictionary mapping InputClient to RestClientInfo for all distinct clients used by the resource.
228
+ </summary>
229
+ <param name="resourceMetadata">The resource metadata containing the method to client mapping.</param>
230
+ <param name="clientProvider">The client provider that will own the fields.</param>
231
+ <returns>A dictionary mapping InputClient to RestClientInfo.</returns>
232
+ </member>
233
+ <member name="M:Azure.Generator.Management.Utilities.ResourceMetadataExtensions.GetRestClientForServiceMethod(Azure.Generator.Management.Models.ResourceMetadata,Microsoft.TypeSpec.Generator.Input.InputServiceMethod,System.Collections.Generic.Dictionary{Microsoft.TypeSpec.Generator.Input.InputClient,Azure.Generator.Management.Models.RestClientInfo})">
234
+ <summary>
235
+ Gets the RestClientInfo for a specific service method based on the method-to-client mapping.
236
+ </summary>
237
+ <param name="resourceMetadata">The resource metadata containing the method to client mapping.</param>
238
+ <param name="serviceMethod">The service method to get the rest client info for.</param>
239
+ <param name="clientInfos">The dictionary mapping InputClient to RestClientInfo.</param>
240
+ <returns>The RestClientInfo for the specified service method.</returns>
241
+ <exception cref="T:System.InvalidOperationException">Thrown when no client mapping is found for the service method.</exception>
242
+ </member>
163
243
  <member name="M:Azure.Generator.Management.Visitors.RestClientVisitor.VisitType(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
164
244
  <inheritdoc/>
165
245
  </member>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure-typespec/http-client-csharp-mgmt",
3
- "version": "1.0.0-alpha.20250716.1",
3
+ "version": "1.0.0-alpha.20250722.1",
4
4
  "author": "Microsoft Corporation",
5
5
  "description": "TypeSpec library for emitting Azure management libraries for C#.",
6
6
  "readme": "https://github.com/Azure/azure-sdk-for-net/blob/main/eng/packages/http-client-csharp-mgmt/README.md",