-
Notifications
You must be signed in to change notification settings - Fork 256
/
ThroughputProperties.xml
236 lines (236 loc) · 13.2 KB
/
ThroughputProperties.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
<Type Name="ThroughputProperties" FullName="Microsoft.Azure.Cosmos.ThroughputProperties">
<TypeSignature Language="C#" Value="public class ThroughputProperties" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ThroughputProperties extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.ThroughputProperties" />
<TypeSignature Language="VB.NET" Value="Public Class ThroughputProperties" />
<TypeSignature Language="F#" Value="type ThroughputProperties = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a throughput of the resources in the Azure Cosmos DB service.
It is the standard pricing for the resource in the Azure Cosmos DB service.
</summary>
<remarks>
It contains provisioned container throughput in measurement of request units per second in the Azure Cosmos service.
</remarks>
<example>
The example below fetch the ThroughputProperties on testContainer.
<code language="c#"><![CDATA[
ThroughputProperties throughputProperties = await testContainer.ReadThroughputAsync().Resource;
]]></code></example>
</Docs>
<Members>
<Member MemberName="AutoscaleMaxThroughput">
<MemberSignature Language="C#" Value="public int? AutoscaleMaxThroughput { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> AutoscaleMaxThroughput" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputProperties.AutoscaleMaxThroughput" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AutoscaleMaxThroughput As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.AutoscaleMaxThroughput : Nullable<int>" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.AutoscaleMaxThroughput" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
The maximum throughput the autoscale will scale to.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateAutoscaleThroughput">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Cosmos.ThroughputProperties CreateAutoscaleThroughput (int autoscaleMaxThroughput);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Cosmos.ThroughputProperties CreateAutoscaleThroughput(int32 autoscaleMaxThroughput) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ThroughputProperties.CreateAutoscaleThroughput(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateAutoscaleThroughput (autoscaleMaxThroughput As Integer) As ThroughputProperties" />
<MemberSignature Language="F#" Value="static member CreateAutoscaleThroughput : int -> Microsoft.Azure.Cosmos.ThroughputProperties" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.CreateAutoscaleThroughput autoscaleMaxThroughput" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.ThroughputProperties</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="autoscaleMaxThroughput" Type="System.Int32" />
</Parameters>
<Docs>
<param name="autoscaleMaxThroughput">The maximum throughput the resource can scale to.</param>
<summary>
The Throughput properties for autoscale provisioned throughput offering
</summary>
<returns>Returns a ThroughputProperties for autoscale provisioned throughput</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateManualThroughput">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Cosmos.ThroughputProperties CreateManualThroughput (int throughput);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Cosmos.ThroughputProperties CreateManualThroughput(int32 throughput) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.ThroughputProperties.CreateManualThroughput(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateManualThroughput (throughput As Integer) As ThroughputProperties" />
<MemberSignature Language="F#" Value="static member CreateManualThroughput : int -> Microsoft.Azure.Cosmos.ThroughputProperties" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.CreateManualThroughput throughput" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.ThroughputProperties</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="throughput" Type="System.Int32" />
</Parameters>
<Docs>
<param name="throughput">The current provisioned throughput for the resource.</param>
<summary>
The Throughput properties for manual provisioned throughput offering
</summary>
<returns>Returns a ThroughputProperties for manual throughput</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ETag">
<MemberSignature Language="C#" Value="public string ETag { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ETag" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputProperties.ETag" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ETag As String" />
<MemberSignature Language="F#" Value="member this.ETag : string" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.ETag" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_etag")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the entity tag associated with the resource from the Azure Cosmos DB service.
</summary>
<value>
The entity tag associated with the resource.
</value>
<remarks>
ETags are used for concurrency checking when updating resources.
</remarks>
</Docs>
</Member>
<Member MemberName="LastModified">
<MemberSignature Language="C#" Value="public DateTime? LastModified { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTime> LastModified" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputProperties.LastModified" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property LastModified As Nullable(Of DateTime)" />
<MemberSignature Language="F#" Value="member this.LastModified : Nullable<DateTime>" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.LastModified" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.UnixDateTimeConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_ts")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTime></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the last modified time stamp associated with <see cref="T:Microsoft.Azure.Cosmos.DatabaseProperties" /> from the Azure Cosmos DB service.
</summary>
<value>The last modified time stamp associated with the resource.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SelfLink">
<MemberSignature Language="C#" Value="public string SelfLink { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SelfLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputProperties.SelfLink" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SelfLink As String" />
<MemberSignature Language="F#" Value="member this.SelfLink : string" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.SelfLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(NullValueHandling=Newtonsoft.Json.NullValueHandling.Ignore, PropertyName="_self")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the self-link associated with the resource from the Azure Cosmos DB service.
</summary>
<value>The self-link associated with the resource.</value>
<remarks>
A self-link is a static addressable Uri for each resource within a database account and follows the Azure Cosmos DB resource model.
E.g. a self-link for a document could be dbs/db_resourceid/colls/coll_resourceid/documents/doc_resourceid
</remarks>
</Docs>
</Member>
<Member MemberName="Throughput">
<MemberSignature Language="C#" Value="public int? Throughput { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> Throughput" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.ThroughputProperties.Throughput" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Throughput As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.Throughput : Nullable<int>" Usage="Microsoft.Azure.Cosmos.ThroughputProperties.Throughput" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the provisioned throughput for a resource in measurement of request units per second in the Azure Cosmos service.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>