/
ThroughputSettingsGetPropertiesResource.yml
190 lines (183 loc) · 6.67 KB
/
ThroughputSettingsGetPropertiesResource.yml
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
### YamlMime:TSType
name: ThroughputSettingsGetPropertiesResource
uid: '@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource'
package: '@azure/arm-cosmosdb'
summary: >-
Cosmos DB resource throughput object. Either throughput is required or
autoscaleSettings is required, but not both.
fullName: ThroughputSettingsGetPropertiesResource
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: autoscaleSettings
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.autoscaleSettings
package: '@azure/arm-cosmosdb'
summary: >-
Cosmos DB resource for autoscale settings. Either throughput is required
or autoscaleSettings is required, but not both.
fullName: autoscaleSettings
remarks: ''
isDeprecated: false
syntax:
content: 'autoscaleSettings?: AutoscaleSettingsResource'
return:
description: ''
type: <xref uid="@azure/arm-cosmosdb.AutoscaleSettingsResource" />
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.autoscaleSettings](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.autoscaleSettings)
- name: etag
uid: '@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.etag'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property representing the resource etag required for
optimistic concurrency control.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: etag
remarks: ''
isDeprecated: false
syntax:
content: 'etag?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.etag](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.etag)
- name: instantMaximumThroughput
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.instantMaximumThroughput
package: '@azure/arm-cosmosdb'
summary: >-
The offer throughput value to instantly scale up without triggering splits
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: instantMaximumThroughput
remarks: ''
isDeprecated: false
syntax:
content: 'instantMaximumThroughput?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.instantMaximumThroughput](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.instantMaximumThroughput)
- name: minimumThroughput
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.minimumThroughput
package: '@azure/arm-cosmosdb'
summary: >-
The minimum throughput of the resource
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: minimumThroughput
remarks: ''
isDeprecated: false
syntax:
content: 'minimumThroughput?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.minimumThroughput](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.minimumThroughput)
- name: offerReplacePending
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.offerReplacePending
package: '@azure/arm-cosmosdb'
summary: >-
The throughput replace is pending
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: offerReplacePending
remarks: ''
isDeprecated: false
syntax:
content: 'offerReplacePending?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.offerReplacePending](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.offerReplacePending)
- name: rid
uid: '@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.rid'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property. A unique identifier.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: rid
remarks: ''
isDeprecated: false
syntax:
content: 'rid?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.rid](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.rid)
- name: softAllowedMaximumThroughput
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.softAllowedMaximumThroughput
package: '@azure/arm-cosmosdb'
summary: >-
The maximum throughput value or the maximum maxThroughput value (for
autoscale) that can be specified
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: softAllowedMaximumThroughput
remarks: ''
isDeprecated: false
syntax:
content: 'softAllowedMaximumThroughput?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.softAllowedMaximumThroughput](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.softAllowedMaximumThroughput)
- name: throughput
uid: '@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.throughput'
package: '@azure/arm-cosmosdb'
summary: >-
Value of the Cosmos DB resource throughput. Either throughput is required
or autoscaleSettings is required, but not both.
fullName: throughput
remarks: ''
isDeprecated: false
syntax:
content: 'throughput?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[ThroughputSettingsResource.throughput](xref:@azure/arm-cosmosdb.ThroughputSettingsResource.throughput)
- name: ts
uid: '@azure/arm-cosmosdb.ThroughputSettingsGetPropertiesResource.ts'
package: '@azure/arm-cosmosdb'
summary: >-
A system generated property that denotes the last updated timestamp of the
resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: ts
remarks: ''
isDeprecated: false
syntax:
content: 'ts?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[ExtendedResourceProperties.ts](xref:@azure/arm-cosmosdb.ExtendedResourceProperties.ts)
extends: >-
<xref uid="@azure/arm-cosmosdb.ThroughputSettingsResource" />,<xref
uid="@azure/arm-cosmosdb.ExtendedResourceProperties" />