-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.microsoft.azure.management.redis.RedisCache.yml
238 lines (238 loc) · 15.5 KB
/
com.microsoft.azure.management.redis.RedisCache.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
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
### YamlMime:JavaType
uid: "com.microsoft.azure.management.redis.RedisCache"
fullName: "com.microsoft.azure.management.redis.RedisCache"
name: "RedisCache"
nameWithType: "RedisCache"
summary: "An immutable client-side representation of an Azure Redis Cache."
syntax: "public interface **RedisCache**</br> extends <xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.implementation.RedisManager?alt=com.microsoft.azure.management.redis.implementation.RedisManager&text=RedisManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.redis.implementation.RedisResourceInner?alt=com.microsoft.azure.management.redis.implementation.RedisResourceInner&text=RedisResourceInner\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.RedisCache?alt=com.microsoft.azure.management.redis.RedisCache&text=RedisCache\" data-throw-if-not-resolved=\"False\" />>, <xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.RedisCache.Update?alt=com.microsoft.azure.management.redis.RedisCache.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
methods:
- uid: "com.microsoft.azure.management.redis.RedisCache.asPremium()"
fullName: "com.microsoft.azure.management.redis.RedisCache.asPremium()"
name: "asPremium()"
nameWithType: "RedisCache.asPremium()"
modifiers:
- "abstract"
syntax: "public abstract RedisCachePremium asPremium()"
returns:
description: "exposes features available only to Premium Sku Redis Cache instances."
type: "<xref href=\"com.microsoft.azure.management.redis.RedisCachePremium?alt=com.microsoft.azure.management.redis.RedisCachePremium&text=RedisCachePremium\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.firewallRules()"
fullName: "com.microsoft.azure.management.redis.RedisCache.firewallRules()"
name: "firewallRules()"
nameWithType: "RedisCache.firewallRules()"
modifiers:
- "abstract"
syntax: "public abstract Map<String,RedisFirewallRule> firewallRules()"
returns:
description: "Firewall Rules in the Redis Cache, indexed by name"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.redis.RedisFirewallRule?alt=com.microsoft.azure.management.redis.RedisFirewallRule&text=RedisFirewallRule\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.redis.RedisCache.forceReboot(com.microsoft.azure.management.redis.RebootType)"
fullName: "com.microsoft.azure.management.redis.RedisCache.forceReboot(RebootType rebootType)"
name: "forceReboot(RebootType rebootType)"
nameWithType: "RedisCache.forceReboot(RebootType rebootType)"
summary: "Reboot specified Redis node(s)."
modifiers:
- "abstract"
parameters:
- description: "specifies which Redis node(s) to reboot. Depending on this value data loss is\n possible. Possible values include: 'PrimaryNode', 'SecondaryNode', 'AllNodes'."
name: "rebootType"
type: "<xref href=\"com.microsoft.azure.management.redis.RebootType?alt=com.microsoft.azure.management.redis.RebootType&text=RebootType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract void forceReboot(RebootType rebootType)"
desc: "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss."
- uid: "com.microsoft.azure.management.redis.RedisCache.getKeys()"
fullName: "com.microsoft.azure.management.redis.RedisCache.getKeys()"
name: "getKeys()"
nameWithType: "RedisCache.getKeys()"
modifiers:
- "abstract"
syntax: "public abstract RedisAccessKeys getKeys()"
returns:
description: "a Redis Cache's access keys. This operation requires write permission to the Cache resource."
type: "<xref href=\"com.microsoft.azure.management.redis.RedisAccessKeys?alt=com.microsoft.azure.management.redis.RedisAccessKeys&text=RedisAccessKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.hostName()"
fullName: "com.microsoft.azure.management.redis.RedisCache.hostName()"
name: "hostName()"
nameWithType: "RedisCache.hostName()"
modifiers:
- "abstract"
syntax: "public abstract String hostName()"
returns:
description: "the hostName value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.isPremium()"
fullName: "com.microsoft.azure.management.redis.RedisCache.isPremium()"
name: "isPremium()"
nameWithType: "RedisCache.isPremium()"
modifiers:
- "abstract"
syntax: "public abstract boolean isPremium()"
returns:
description: "returns true if current Redis Cache instance has Premium Sku."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.keys()"
fullName: "com.microsoft.azure.management.redis.RedisCache.keys()"
name: "keys()"
nameWithType: "RedisCache.keys()"
modifiers:
- "abstract"
syntax: "public abstract RedisAccessKeys keys()"
returns:
description: "a Redis Cache's access keys. This operation requires write permission to the Cache resource."
type: "<xref href=\"com.microsoft.azure.management.redis.RedisAccessKeys?alt=com.microsoft.azure.management.redis.RedisAccessKeys&text=RedisAccessKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.minimumTlsVersion()"
fullName: "com.microsoft.azure.management.redis.RedisCache.minimumTlsVersion()"
name: "minimumTlsVersion()"
nameWithType: "RedisCache.minimumTlsVersion()"
modifiers:
- "abstract"
syntax: "public abstract TlsVersion minimumTlsVersion()"
returns:
description: "the minimum TLS version (or higher) that clients require to use."
type: "<xref href=\"com.microsoft.azure.management.redis.TlsVersion?alt=com.microsoft.azure.management.redis.TlsVersion&text=TlsVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.nonSslPort()"
fullName: "com.microsoft.azure.management.redis.RedisCache.nonSslPort()"
name: "nonSslPort()"
nameWithType: "RedisCache.nonSslPort()"
modifiers:
- "abstract"
syntax: "public abstract boolean nonSslPort()"
returns:
description: "true if non SSL port is enabled, false otherwise"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.patchSchedules()"
fullName: "com.microsoft.azure.management.redis.RedisCache.patchSchedules()"
name: "patchSchedules()"
nameWithType: "RedisCache.patchSchedules()"
modifiers:
- "abstract"
syntax: "public abstract List<ScheduleEntry> patchSchedules()"
returns:
description: "List of patch schedules for current Redis Cache."
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.ScheduleEntry?alt=com.microsoft.azure.management.redis.ScheduleEntry&text=ScheduleEntry\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.redis.RedisCache.port()"
fullName: "com.microsoft.azure.management.redis.RedisCache.port()"
name: "port()"
nameWithType: "RedisCache.port()"
modifiers:
- "abstract"
syntax: "public abstract int port()"
returns:
description: "the port value"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.provisioningState()"
fullName: "com.microsoft.azure.management.redis.RedisCache.provisioningState()"
name: "provisioningState()"
nameWithType: "RedisCache.provisioningState()"
modifiers:
- "abstract"
syntax: "public abstract String provisioningState()"
returns:
description: "the provisioningState value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.redisConfiguration()"
fullName: "com.microsoft.azure.management.redis.RedisCache.redisConfiguration()"
name: "redisConfiguration()"
nameWithType: "RedisCache.redisConfiguration()"
modifiers:
- "abstract"
syntax: "public abstract Map<String,String> redisConfiguration()"
returns:
description: "the Redis configuration value"
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.microsoft.azure.management.redis.RedisCache.redisVersion()"
fullName: "com.microsoft.azure.management.redis.RedisCache.redisVersion()"
name: "redisVersion()"
nameWithType: "RedisCache.redisVersion()"
modifiers:
- "abstract"
syntax: "public abstract String redisVersion()"
returns:
description: "the Redis version value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.refreshKeys()"
fullName: "com.microsoft.azure.management.redis.RedisCache.refreshKeys()"
name: "refreshKeys()"
nameWithType: "RedisCache.refreshKeys()"
summary: "Fetch the up-to-date access keys from Azure for this Redis Cache."
modifiers:
- "abstract"
syntax: "public abstract RedisAccessKeys refreshKeys()"
desc: "Fetch the up-to-date access keys from Azure for this Redis Cache."
returns:
description: "the access keys for this Redis Cache"
type: "<xref href=\"com.microsoft.azure.management.redis.RedisAccessKeys?alt=com.microsoft.azure.management.redis.RedisAccessKeys&text=RedisAccessKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.regenerateKey(com.microsoft.azure.management.redis.RedisKeyType)"
fullName: "com.microsoft.azure.management.redis.RedisCache.regenerateKey(RedisKeyType keyType)"
name: "regenerateKey(RedisKeyType keyType)"
nameWithType: "RedisCache.regenerateKey(RedisKeyType keyType)"
summary: "Regenerates the access keys for this Redis Cache."
modifiers:
- "abstract"
parameters:
- description: "key type to regenerate"
name: "keyType"
type: "<xref href=\"com.microsoft.azure.management.redis.RedisKeyType?alt=com.microsoft.azure.management.redis.RedisKeyType&text=RedisKeyType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract RedisAccessKeys regenerateKey(RedisKeyType keyType)"
desc: "Regenerates the access keys for this Redis Cache."
returns:
description: "the generated access keys for this Redis Cache"
type: "<xref href=\"com.microsoft.azure.management.redis.RedisAccessKeys?alt=com.microsoft.azure.management.redis.RedisAccessKeys&text=RedisAccessKeys\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.shardCount()"
fullName: "com.microsoft.azure.management.redis.RedisCache.shardCount()"
name: "shardCount()"
nameWithType: "RedisCache.shardCount()"
modifiers:
- "abstract"
syntax: "public abstract int shardCount()"
returns:
description: "the shardCount value"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.sku()"
fullName: "com.microsoft.azure.management.redis.RedisCache.sku()"
name: "sku()"
nameWithType: "RedisCache.sku()"
modifiers:
- "abstract"
syntax: "public abstract Sku sku()"
returns:
description: "the sku value"
type: "<xref href=\"com.microsoft.azure.management.redis.Sku?alt=com.microsoft.azure.management.redis.Sku&text=Sku\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.sslPort()"
fullName: "com.microsoft.azure.management.redis.RedisCache.sslPort()"
name: "sslPort()"
nameWithType: "RedisCache.sslPort()"
modifiers:
- "abstract"
syntax: "public abstract int sslPort()"
returns:
description: "the sslPort value"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.staticIP()"
fullName: "com.microsoft.azure.management.redis.RedisCache.staticIP()"
name: "staticIP()"
nameWithType: "RedisCache.staticIP()"
modifiers:
- "abstract"
syntax: "public abstract String staticIP()"
returns:
description: "the staticIP value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.redis.RedisCache.subnetId()"
fullName: "com.microsoft.azure.management.redis.RedisCache.subnetId()"
name: "subnetId()"
nameWithType: "RedisCache.subnetId()"
modifiers:
- "abstract"
syntax: "public abstract String subnetId()"
returns:
description: "the subnetId value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
type: "interface"
desc: "An immutable client-side representation of an Azure Redis Cache."
implements:
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource?alt=com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource&text=GroupableResource\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.implementation.RedisManager?alt=com.microsoft.azure.management.redis.implementation.RedisManager&text=RedisManager\" data-throw-if-not-resolved=\"False\" />,<xref href=\"com.microsoft.azure.management.redis.implementation.RedisResourceInner?alt=com.microsoft.azure.management.redis.implementation.RedisResourceInner&text=RedisResourceInner\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Refreshable?alt=com.microsoft.azure.management.resources.fluentcore.model.Refreshable&text=Refreshable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.RedisCache?alt=com.microsoft.azure.management.redis.RedisCache&text=RedisCache\" data-throw-if-not-resolved=\"False\" />>"
- "<xref href=\"com.microsoft.azure.management.resources.fluentcore.model.Updatable?alt=com.microsoft.azure.management.resources.fluentcore.model.Updatable&text=Updatable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.redis.RedisCache.Update?alt=com.microsoft.azure.management.redis.RedisCache.Update&text=Update\" data-throw-if-not-resolved=\"False\" />>"
metadata: {}
package: "com.microsoft.azure.management.redis"
artifact: com.microsoft.azure:azure-mgmt-redis:1.41.4