-
Notifications
You must be signed in to change notification settings - Fork 271
/
Copy pathOfferResource.xml
291 lines (291 loc) · 22.7 KB
/
OfferResource.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
<Type Name="OfferResource" FullName="Azure.ResourceManager.Hci.OfferResource">
<TypeSignature Language="C#" Value="public class OfferResource : Azure.ResourceManager.ArmResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OfferResource extends Azure.ResourceManager.ArmResource" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Hci.OfferResource" />
<TypeSignature Language="VB.NET" Value="Public Class OfferResource
Inherits ArmResource" />
<TypeSignature Language="F#" Value="type OfferResource = class
 inherit ArmResource" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.0.2.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.ResourceManager.ArmResource</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="azure-dotnet">
<AttributeName Language="C#">[System.Obsolete("This class is now deprecated. Please use the new class `HciClusterOfferResource` moving forward.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("This class is now deprecated. Please use the new class `HciClusterOfferResource` moving forward.")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A Class representing an Offer along with the instance operations that can be performed on it.
If you have a <see cref="T:Azure.Core.ResourceIdentifier" /> you can construct an <see cref="T:Azure.ResourceManager.Hci.OfferResource" />
from an instance of <see cref="T:Azure.ResourceManager.ArmClient" /> using the GetOfferResource method.
Otherwise you can get one from its parent resource <see cref="T:Azure.ResourceManager.Hci.PublisherResource" /> using the GetOffer method.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected OfferResource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of the <see cref="T:Azure.ResourceManager.Hci.OfferResource" /> class for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateResourceIdentifier">
<MemberSignature Language="C#" Value="public static Azure.Core.ResourceIdentifier CreateResourceIdentifier (string subscriptionId, string resourceGroupName, string clusterName, string publisherName, string offerName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Azure.Core.ResourceIdentifier CreateResourceIdentifier(string subscriptionId, string resourceGroupName, string clusterName, string publisherName, string offerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.CreateResourceIdentifier(System.String,System.String,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateResourceIdentifier (subscriptionId As String, resourceGroupName As String, clusterName As String, publisherName As String, offerName As String) As ResourceIdentifier" />
<MemberSignature Language="F#" Value="static member CreateResourceIdentifier : string * string * string * string * string -> Azure.Core.ResourceIdentifier" Usage="Azure.ResourceManager.Hci.OfferResource.CreateResourceIdentifier (subscriptionId, resourceGroupName, clusterName, publisherName, offerName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.ResourceIdentifier</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="subscriptionId" Type="System.String" />
<Parameter Name="resourceGroupName" Type="System.String" />
<Parameter Name="clusterName" Type="System.String" />
<Parameter Name="publisherName" Type="System.String" />
<Parameter Name="offerName" Type="System.String" />
</Parameters>
<Docs>
<param name="subscriptionId"> The subscriptionId. </param>
<param name="resourceGroupName"> The resourceGroupName. </param>
<param name="clusterName"> The clusterName. </param>
<param name="publisherName"> The publisherName. </param>
<param name="offerName"> The offerName. </param>
<summary> Generate the resource identifier of a <see cref="T:Azure.ResourceManager.Hci.OfferResource" /> instance. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public virtual Azure.ResourceManager.Hci.OfferData Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.ResourceManager.Hci.OfferData Data" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Hci.OfferResource.Data" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Data As OfferData" />
<MemberSignature Language="F#" Value="member this.Data : Azure.ResourceManager.Hci.OfferData" Usage="Azure.ResourceManager.Hci.OfferResource.Data" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Hci.OfferData</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets the data representing this Feature. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException"> Throws if there is no data loaded in the current instance. </exception>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.ResourceManager.Hci.OfferResource> Get (string expand = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.ResourceManager.Hci.OfferResource> Get(string expand, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.Get(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function Get (Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of OfferResource)" />
<MemberSignature Language="F#" Value="abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Hci.OfferResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Hci.OfferResource>" Usage="offerResource.Get (expand, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.Hci.OfferResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expand" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="expand"> Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Get Offer resource details within a publisher of HCI Cluster.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}</description></item><item><term>Operation Id</term><description>Offers_Get</description></item><item><term>Default Api Version</term><description>2023-02-01</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Hci.OfferResource" /></description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.OfferResource>> GetAsync (string expand = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.Hci.OfferResource>> GetAsync(string expand, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.GetAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAsync (Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of OfferResource))" />
<MemberSignature Language="F#" Value="abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.OfferResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.OfferResource>>" Usage="offerResource.GetAsync (expand, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.OfferResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="expand" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="expand"> Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Get Offer resource details within a publisher of HCI Cluster.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}</description></item><item><term>Operation Id</term><description>Offers_Get</description></item><item><term>Default Api Version</term><description>2023-02-01</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Hci.OfferResource" /></description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHciSku">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.ResourceManager.Hci.HciSkuResource> GetHciSku (string skuName, string expand = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.ResourceManager.Hci.HciSkuResource> GetHciSku(string skuName, string expand, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.GetHciSku(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetHciSku (skuName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of HciSkuResource)" />
<MemberSignature Language="F#" Value="abstract member GetHciSku : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>
override this.GetHciSku : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>" Usage="offerResource.GetHciSku (skuName, expand, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.ResourceManager.Hci.HciSkuResource></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skuName" Type="System.String" />
<Parameter Name="expand" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="skuName"> The name of the SKU available within HCI cluster. </param>
<param name="expand"> Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Get SKU resource details within a offer of HCI Cluster.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}</description></item><item><term>Operation Id</term><description>Skus_Get</description></item><item><term>Default Api Version</term><description>2023-02-01</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Hci.HciSkuResource" /></description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="skuName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="skuName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetHciSkuAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>> GetHciSkuAsync (string skuName, string expand = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.ResourceManager.Hci.HciSkuResource>> GetHciSkuAsync(string skuName, string expand, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.GetHciSkuAsync(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetHciSkuAsync (skuName As String, Optional expand As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of HciSkuResource))" />
<MemberSignature Language="F#" Value="abstract member GetHciSkuAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>>
override this.GetHciSkuAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>>" Usage="offerResource.GetHciSkuAsync (skuName, expand, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.Hci.HciSkuResource>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="skuName" Type="System.String" />
<Parameter Name="expand" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="skuName"> The name of the SKU available within HCI cluster. </param>
<param name="expand"> Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Get SKU resource details within a offer of HCI Cluster.
<list type="bullet"><item><term>Request Path</term><description>/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}</description></item><item><term>Operation Id</term><description>Skus_Get</description></item><item><term>Default Api Version</term><description>2023-02-01</description></item><item><term>Resource</term><description><see cref="T:Azure.ResourceManager.Hci.HciSkuResource" /></description></item></list></summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="skuName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="skuName" /> is an empty string, and was expected to be non-empty. </exception>
</Docs>
</Member>
<Member MemberName="GetHciSkus">
<MemberSignature Language="C#" Value="public virtual Azure.ResourceManager.Hci.HciSkuCollection GetHciSkus ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.ResourceManager.Hci.HciSkuCollection GetHciSkus() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Hci.OfferResource.GetHciSkus" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetHciSkus () As HciSkuCollection" />
<MemberSignature Language="F#" Value="abstract member GetHciSkus : unit -> Azure.ResourceManager.Hci.HciSkuCollection
override this.GetHciSkus : unit -> Azure.ResourceManager.Hci.HciSkuCollection" Usage="offerResource.GetHciSkus " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.ResourceManager.Hci.HciSkuCollection</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary> Gets a collection of HciSkuResources in the Offer. </summary>
<returns> An object representing collection of HciSkuResources and their operations over a HciSkuResource. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasData">
<MemberSignature Language="C#" Value="public virtual bool HasData { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasData" />
<MemberSignature Language="DocId" Value="P:Azure.ResourceManager.Hci.OfferResource.HasData" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property HasData As Boolean" />
<MemberSignature Language="F#" Value="member this.HasData : bool" Usage="Azure.ResourceManager.Hci.OfferResource.HasData" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets whether or not the current instance has data. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ResourceType">
<MemberSignature Language="C#" Value="public static readonly Azure.Core.ResourceType ResourceType;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly valuetype Azure.Core.ResourceType ResourceType" />
<MemberSignature Language="DocId" Value="F:Azure.ResourceManager.Hci.OfferResource.ResourceType" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly ResourceType As ResourceType " />
<MemberSignature Language="F#" Value=" staticval mutable ResourceType : Azure.Core.ResourceType" Usage="Azure.ResourceManager.Hci.OfferResource.ResourceType" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Hci</AssemblyName>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.ResourceType</ReturnType>
</ReturnValue>
<Docs>
<summary> Gets the resource type for the operations. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>