-
Notifications
You must be signed in to change notification settings - Fork 180
/
ThroughputSettingsResource.yml
106 lines (102 loc) · 3.4 KB
/
ThroughputSettingsResource.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
### YamlMime:TSType
name: ThroughputSettingsResource
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource'
package: '@azure/arm-cosmosdb'
summary: >-
Cosmos DB resource throughput object. Either throughput is required or
autoscaleSettings is required, but not both.
fullName: ThroughputSettingsResource
remarks: ''
isDeprecated: false
type: interface
properties:
- name: autoscaleSettings
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource.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" />
- name: instantMaximumThroughput
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource.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
- name: minimumThroughput
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource.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
- name: offerReplacePending
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource.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
- name: softAllowedMaximumThroughput
uid: >-
@azure/arm-cosmosdb.ThroughputSettingsResource.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
- name: throughput
uid: '@azure/arm-cosmosdb.ThroughputSettingsResource.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