-
Notifications
You must be signed in to change notification settings - Fork 260
/
QuantumExtensions.xml
348 lines (348 loc) · 38.6 KB
/
QuantumExtensions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<Type Name="QuantumExtensions" FullName="Azure.ResourceManager.Quantum.QuantumExtensions">
<TypeSignature Language="C#" Value="public static class QuantumExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit QuantumExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Quantum.QuantumExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module QuantumExtensions" />
<TypeSignature Language="F#" Value="type QuantumExtensions = class" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> A class to add extension methods to Azure.ResourceManager.Quantum. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CheckWorkspaceNameAvailability">
<MemberSignature Language="C#" Value="public static Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult> CheckWorkspaceNameAvailability (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent content, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Response`1<class Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult> CheckWorkspaceNameAvailability(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, class Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent content, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.CheckWorkspaceNameAvailability(Azure.ResourceManager.Resources.SubscriptionResource,System.String,Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function CheckWorkspaceNameAvailability (subscriptionResource As SubscriptionResource, locationName As String, content As WorkspaceNameAvailabilityContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of WorkspaceNameAvailabilityResult)" />
<MemberSignature Language="F#" Value="static member CheckWorkspaceNameAvailability : Azure.ResourceManager.Resources.SubscriptionResource * string * Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.CheckWorkspaceNameAvailability (subscriptionResource, locationName, content, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="locationName" Type="System.String" />
<Parameter Name="content" Type="Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="locationName"> Location. </param>
<param name="content"> The name and type of the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Check the availability of the resource name.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability</description></item><item><term>Operation Id</term><description>Workspace_CheckNameAvailability</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.CheckWorkspaceNameAvailability(System.String,Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="locationName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" />, <paramref name="locationName" /> or <paramref name="content" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CheckWorkspaceNameAvailabilityAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult>> CheckWorkspaceNameAvailabilityAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent content, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult>> CheckWorkspaceNameAvailabilityAsync(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, class Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent content, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.CheckWorkspaceNameAvailabilityAsync(Azure.ResourceManager.Resources.SubscriptionResource,System.String,Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function CheckWorkspaceNameAvailabilityAsync (subscriptionResource As SubscriptionResource, locationName As String, content As WorkspaceNameAvailabilityContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of WorkspaceNameAvailabilityResult))" />
<MemberSignature Language="F#" Value="static member CheckWorkspaceNameAvailabilityAsync : Azure.ResourceManager.Resources.SubscriptionResource * string * Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult>>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.CheckWorkspaceNameAvailabilityAsync (subscriptionResource, locationName, content, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityResult>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="locationName" Type="System.String" />
<Parameter Name="content" Type="Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="locationName"> Location. </param>
<param name="content"> The name and type of the resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Check the availability of the resource name.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/checkNameAvailability</description></item><item><term>Operation Id</term><description>Workspace_CheckNameAvailability</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.CheckWorkspaceNameAvailability(System.String,Azure.ResourceManager.Quantum.Models.WorkspaceNameAvailabilityContent,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="locationName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" />, <paramref name="locationName" /> or <paramref name="content" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetOfferings">
<MemberSignature Language="C#" Value="public static Azure.Pageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription> GetOfferings (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Pageable`1<class Azure.ResourceManager.Quantum.Models.QuantumProviderDescription> GetOfferings(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetOfferings(Azure.ResourceManager.Resources.SubscriptionResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetOfferings (subscriptionResource As SubscriptionResource, locationName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of QuantumProviderDescription)" />
<MemberSignature Language="F#" Value="static member GetOfferings : Azure.ResourceManager.Resources.SubscriptionResource * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetOfferings (subscriptionResource, locationName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="locationName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="locationName"> Location. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the list of all provider offerings available for the given location.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings</description></item><item><term>Operation Id</term><description>Offerings_List</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.GetOfferings(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.Quantum.Models.QuantumProviderDescription" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="locationName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> or <paramref name="locationName" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetOfferingsAsync">
<MemberSignature Language="C#" Value="public static Azure.AsyncPageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription> GetOfferingsAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AsyncPageable`1<class Azure.ResourceManager.Quantum.Models.QuantumProviderDescription> GetOfferingsAsync(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string locationName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetOfferingsAsync(Azure.ResourceManager.Resources.SubscriptionResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetOfferingsAsync (subscriptionResource As SubscriptionResource, locationName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of QuantumProviderDescription)" />
<MemberSignature Language="F#" Value="static member GetOfferingsAsync : Azure.ResourceManager.Resources.SubscriptionResource * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetOfferingsAsync (subscriptionResource, locationName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.Quantum.Models.QuantumProviderDescription></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="locationName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="locationName"> Location. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the list of all provider offerings available for the given location.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/locations/{locationName}/offerings</description></item><item><term>Operation Id</term><description>Offerings_List</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.GetOfferings(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.Quantum.Models.QuantumProviderDescription" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="locationName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> or <paramref name="locationName" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspace">
<MemberSignature Language="C#" Value="public static Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspace (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string workspaceName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Response`1<class Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspace(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string workspaceName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspace(Azure.ResourceManager.Resources.ResourceGroupResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspace (resourceGroupResource As ResourceGroupResource, workspaceName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of QuantumWorkspaceResource)" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspace : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspace (resourceGroupResource, workspaceName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
<Parameter Name="workspaceName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<param name="workspaceName"> The name of the quantum workspace resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the Workspace resource associated with the given name.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}</description></item><item><term>Operation Id</term><description>Workspaces_Get</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /></description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumResourceGroupResource.GetQuantumWorkspace(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> or <paramref name="workspaceName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="workspaceName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspaceAsync">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>> GetQuantumWorkspaceAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string workspaceName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.Quantum.QuantumWorkspaceResource>> GetQuantumWorkspaceAsync(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string workspaceName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaceAsync(Azure.ResourceManager.Resources.ResourceGroupResource,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspaceAsync (resourceGroupResource As ResourceGroupResource, workspaceName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of QuantumWorkspaceResource))" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspaceAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaceAsync (resourceGroupResource, workspaceName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
<Parameter Name="workspaceName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<param name="workspaceName"> The name of the quantum workspace resource. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Returns the Workspace resource associated with the given name.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Quantum/workspaces/{workspaceName}</description></item><item><term>Operation Id</term><description>Workspaces_Get</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /></description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumResourceGroupResource.GetQuantumWorkspaceAsync(System.String,System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> or <paramref name="workspaceName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="workspaceName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspaceResource">
<MemberSignature Language="C#" Value="public static Azure.ResourceManager.Quantum.QuantumWorkspaceResource GetQuantumWorkspaceResource (this Azure.ResourceManager.ArmClient client, Azure.Core.ResourceIdentifier id);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.ResourceManager.Quantum.QuantumWorkspaceResource GetQuantumWorkspaceResource(class Azure.ResourceManager.ArmClient client, class Azure.Core.ResourceIdentifier id) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaceResource(Azure.ResourceManager.ArmClient,Azure.Core.ResourceIdentifier)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspaceResource (client As ArmClient, id As ResourceIdentifier) As QuantumWorkspaceResource" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspaceResource : Azure.ResourceManager.ArmClient * Azure.Core.ResourceIdentifier -> Azure.ResourceManager.Quantum.QuantumWorkspaceResource" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaceResource (client, id)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Quantum.QuantumWorkspaceResource</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="client" Type="Azure.ResourceManager.ArmClient" RefType="this" />
<Parameter Name="id" Type="Azure.Core.ResourceIdentifier" />
</Parameters>
<Docs>
<param name="client"> The <see cref="T:Azure.ResourceManager.ArmClient" /> instance the method will execute against. </param>
<param name="id"> The resource ID of the resource to get. </param>
<summary>
Gets an object representing a <see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /> along with the instance operations that can be performed on it but with no data.
You can use <see cref="M:Azure.ResourceManager.Quantum.QuantumWorkspaceResource.CreateResourceIdentifier(System.String,System.String,System.String)" /> to create a <see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /><see cref="T:Azure.Core.ResourceIdentifier" /> from its components.
<item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumArmClient.GetQuantumWorkspaceResource(Azure.Core.ResourceIdentifier)" /> instead.</description></item></summary>
<returns> Returns a <see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /> object. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="client" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspaces">
<MemberSignature Language="C#" Value="public static Azure.ResourceManager.Quantum.QuantumWorkspaceCollection GetQuantumWorkspaces (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.ResourceManager.Quantum.QuantumWorkspaceCollection GetQuantumWorkspaces(class Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaces(Azure.ResourceManager.Resources.ResourceGroupResource)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspaces (resourceGroupResource As ResourceGroupResource) As QuantumWorkspaceCollection" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspaces : Azure.ResourceManager.Resources.ResourceGroupResource -> Azure.ResourceManager.Quantum.QuantumWorkspaceCollection" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaces resourceGroupResource" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Quantum.QuantumWorkspaceCollection</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resourceGroupResource" Type="Azure.ResourceManager.Resources.ResourceGroupResource" RefType="this" />
</Parameters>
<Docs>
<param name="resourceGroupResource"> The <see cref="T:Azure.ResourceManager.Resources.ResourceGroupResource" /> instance the method will execute against. </param>
<summary>
Gets a collection of QuantumWorkspaceResources in the ResourceGroupResource.
<item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumResourceGroupResource.GetQuantumWorkspaces" /> instead.</description></item></summary>
<returns> An object representing collection of QuantumWorkspaceResources and their operations over a QuantumWorkspaceResource. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="resourceGroupResource" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspaces">
<MemberSignature Language="C#" Value="public static Azure.Pageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspaces (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Pageable`1<class Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspaces(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaces(Azure.ResourceManager.Resources.SubscriptionResource,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspaces (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of QuantumWorkspaceResource)" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspaces : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspaces (subscriptionResource, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets the list of Workspaces within a Subscription.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces</description></item><item><term>Operation Id</term><description>Workspaces_ListBySubscription</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /></description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.GetQuantumWorkspaces(System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetQuantumWorkspacesAsync">
<MemberSignature Language="C#" Value="public static Azure.AsyncPageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspacesAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.AsyncPageable`1<class Azure.ResourceManager.Quantum.QuantumWorkspaceResource> GetQuantumWorkspacesAsync(class Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspacesAsync(Azure.ResourceManager.Resources.SubscriptionResource,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetQuantumWorkspacesAsync (subscriptionResource As SubscriptionResource, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of QuantumWorkspaceResource)" />
<MemberSignature Language="F#" Value="static member GetQuantumWorkspacesAsync : Azure.ResourceManager.Resources.SubscriptionResource * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource>" Usage="Azure.ResourceManager.Quantum.QuantumExtensions.GetQuantumWorkspacesAsync (subscriptionResource, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Quantum</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.Quantum.QuantumWorkspaceResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionResource" Type="Azure.ResourceManager.Resources.SubscriptionResource" RefType="this" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="subscriptionResource"> The <see cref="T:Azure.ResourceManager.Resources.SubscriptionResource" /> instance the method will execute against. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Gets the list of Workspaces within a Subscription.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/providers/Microsoft.Quantum/workspaces</description></item><item><term>Operation Id</term><description>Workspaces_ListBySubscription</description></item><item><term>Default Api Version</term><description>2023-11-13-preview</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /></description></item></list><item><term>Mocking</term><description>To mock this method, please mock <see cref="M:Azure.ResourceManager.Quantum.Mocking.MockableQuantumSubscriptionResource.GetQuantumWorkspaces(System.Threading.CancellationToken)" /> instead.</description></item></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.Quantum.QuantumWorkspaceResource" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="subscriptionResource" /> is null. </exception>
</Docs>
</Member>
</Members>
</Type>