/
ReservationOrderConsumptionResource.xml
187 lines (187 loc) · 17.9 KB
/
ReservationOrderConsumptionResource.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
<Type Name="ReservationOrderConsumptionResource" FullName="Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource">
<TypeSignature Language="C#" Value="public class ReservationOrderConsumptionResource : Azure.ResourceManager.ArmResource" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ReservationOrderConsumptionResource extends Azure.ResourceManager.ArmResource" />
<TypeSignature Language="DocId" Value="T:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource" />
<TypeSignature Language="VB.NET" Value="Public Class ReservationOrderConsumptionResource
Inherits ArmResource" />
<TypeSignature Language="F#" Value="type ReservationOrderConsumptionResource = class
 inherit ArmResource" />
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.ResourceManager.ArmResource</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A class extending from the ReservationOrderResource in Azure.ResourceManager.Consumption along with the instance operations that can be performed on it.
You can only construct a <see cref="T:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource" /> from a <see cref="T:Azure.Core.ResourceIdentifier" /> with a resource type of Microsoft.Capacity/reservationorders.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ReservationOrderConsumptionResource ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of the <see cref="T:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource" /> class for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetReservationDetails">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetReservationDetails (string filter, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetReservationDetails(string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.GetReservationDetails(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetReservationDetails (filter As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ConsumptionReservationDetail)" />
<MemberSignature Language="F#" Value="abstract member GetReservationDetails : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>
override this.GetReservationDetails : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>" Usage="reservationOrderConsumptionResource.GetReservationDetails (filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
<list type="bullet"><item><term>Request Path</term><description>/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails</description></item><item><term>Operation Id</term><description>ReservationsDetails_ListByReservationOrder</description></item></list></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetReservationDetailsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetReservationDetailsAsync (string filter, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail> GetReservationDetailsAsync(string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.GetReservationDetailsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetReservationDetailsAsync (filter As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ConsumptionReservationDetail)" />
<MemberSignature Language="F#" Value="abstract member GetReservationDetailsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>
override this.GetReservationDetailsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail>" Usage="reservationOrderConsumptionResource.GetReservationDetailsAsync (filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="filter"> Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Lists the reservations details for provided date range. Note: ARM has a payload size limit of 12MB, so currently callers get 502 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.
<list type="bullet"><item><term>Request Path</term><description>/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails</description></item><item><term>Operation Id</term><description>ReservationsDetails_ListByReservationOrder</description></item></list></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.Consumption.Models.ConsumptionReservationDetail" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="filter" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="GetReservationSummaries">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary> GetReservationSummaries (Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain grain, string filter = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary> GetReservationSummaries(valuetype Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain grain, string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.GetReservationSummaries(Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetReservationSummaries (grain As ReservationSummaryDataGrain, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of ConsumptionReservationSummary)" />
<MemberSignature Language="F#" Value="abstract member GetReservationSummaries : Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary>
override this.GetReservationSummaries : Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary>" Usage="reservationOrderConsumptionResource.GetReservationSummaries (grain, filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="grain" Type="Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="grain"> Can be daily or monthly. </param>
<param name="filter"> Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Lists the reservations summaries for daily or monthly grain.
<list type="bullet"><item><term>Request Path</term><description>/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries</description></item><item><term>Operation Id</term><description>ReservationsSummaries_ListByReservationOrder</description></item></list></summary>
<returns> A collection of <see cref="T:Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary" /> that may take multiple service requests to iterate over. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetReservationSummariesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary> GetReservationSummariesAsync (Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain grain, string filter = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary> GetReservationSummariesAsync(valuetype Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain grain, string filter, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.ResourceManager.Consumption.ReservationOrderConsumptionResource.GetReservationSummariesAsync(Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetReservationSummariesAsync (grain As ReservationSummaryDataGrain, Optional filter As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of ConsumptionReservationSummary)" />
<MemberSignature Language="F#" Value="abstract member GetReservationSummariesAsync : Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary>
override this.GetReservationSummariesAsync : Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary>" Usage="reservationOrderConsumptionResource.GetReservationSummariesAsync (grain, filter, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="grain" Type="Azure.ResourceManager.Consumption.Models.ReservationSummaryDataGrain" />
<Parameter Name="filter" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="grain"> Can be daily or monthly. </param>
<param name="filter"> Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary>
Lists the reservations summaries for daily or monthly grain.
<list type="bullet"><item><term>Request Path</term><description>/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries</description></item><item><term>Operation Id</term><description>ReservationsSummaries_ListByReservationOrder</description></item></list></summary>
<returns> An async collection of <see cref="T:Azure.ResourceManager.Consumption.Models.ConsumptionReservationSummary" /> that may take multiple service requests to iterate over. </returns>
<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.Consumption.ReservationOrderConsumptionResource.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.Consumption.ReservationOrderConsumptionResource.ResourceType" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.ResourceManager.Consumption</AssemblyName>
<AssemblyVersion>1.0.1.0</AssemblyVersion>
<AssemblyVersion>1.1.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>