-
Notifications
You must be signed in to change notification settings - Fork 180
/
ManagedInstanceKeys.yml
237 lines (237 loc) · 9.24 KB
/
ManagedInstanceKeys.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
### YamlMime:TSType
name: ManagedInstanceKeys
uid: '@azure/arm-sql.ManagedInstanceKeys'
package: '@azure/arm-sql'
summary: Interface representing a ManagedInstanceKeys.
fullName: ManagedInstanceKeys
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, ManagedInstanceKey,
ManagedInstanceKeysCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.beginCreateOrUpdate'
package: '@azure/arm-sql'
summary: Creates or updates a managed instance key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string,
managedInstanceName: string, keyName: string, parameters:
ManagedInstanceKey, options?:
ManagedInstanceKeysCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<ManagedInstanceKey>,
ManagedInstanceKey>>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: keyName
type: string
description: >-
The name of the managed instance key to be operated on (updated or
created).
- id: parameters
type: <xref uid="@azure/arm-sql.ManagedInstanceKey" />
description: The requested managed instance key resource state.
- id: options
type: >-
<xref
uid="@azure/arm-sql.ManagedInstanceKeysCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><<xref
uid="@azure/arm-sql.ManagedInstanceKey" />>, <xref
uid="@azure/arm-sql.ManagedInstanceKey" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, ManagedInstanceKey,
ManagedInstanceKeysCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.beginCreateOrUpdateAndWait'
package: '@azure/arm-sql'
summary: Creates or updates a managed instance key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
managedInstanceName: string, keyName: string, parameters:
ManagedInstanceKey, options?:
ManagedInstanceKeysCreateOrUpdateOptionalParams):
Promise<ManagedInstanceKey>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: keyName
type: string
description: >-
The name of the managed instance key to be operated on (updated or
created).
- id: parameters
type: <xref uid="@azure/arm-sql.ManagedInstanceKey" />
description: The requested managed instance key resource state.
- id: options
type: >-
<xref
uid="@azure/arm-sql.ManagedInstanceKeysCreateOrUpdateOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.ManagedInstanceKey" />>
- name: >-
beginDelete(string, string, string,
ManagedInstanceKeysDeleteOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.beginDelete'
package: '@azure/arm-sql'
summary: Deletes the managed instance key with the given name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, managedInstanceName:
string, keyName: string, options?:
ManagedInstanceKeysDeleteOptionalParams):
Promise<SimplePollerLike<OperationState<void>, void>>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: keyName
type: string
description: The name of the managed instance key to be deleted.
- id: options
type: >-
<xref uid="@azure/arm-sql.ManagedInstanceKeysDeleteOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.SimplePollerLike" /><<xref
uid="@azure/core-lro.OperationState" /><void>, void>>
- name: >-
beginDeleteAndWait(string, string, string,
ManagedInstanceKeysDeleteOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.beginDeleteAndWait'
package: '@azure/arm-sql'
summary: Deletes the managed instance key with the given name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string,
managedInstanceName: string, keyName: string, options?:
ManagedInstanceKeysDeleteOptionalParams): Promise<void>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: keyName
type: string
description: The name of the managed instance key to be deleted.
- id: options
type: >-
<xref uid="@azure/arm-sql.ManagedInstanceKeysDeleteOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, ManagedInstanceKeysGetOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.get'
package: '@azure/arm-sql'
summary: Gets a managed instance key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, managedInstanceName: string,
keyName: string, options?: ManagedInstanceKeysGetOptionalParams):
Promise<ManagedInstanceKey>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: keyName
type: string
description: The name of the managed instance key to be retrieved.
- id: options
type: <xref uid="@azure/arm-sql.ManagedInstanceKeysGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.ManagedInstanceKey" />>
- name: >-
listByInstance(string, string,
ManagedInstanceKeysListByInstanceOptionalParams)
uid: '@azure/arm-sql.ManagedInstanceKeys.listByInstance'
package: '@azure/arm-sql'
summary: Gets a list of managed instance keys.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByInstance(resourceGroupName: string, managedInstanceName:
string, options?: ManagedInstanceKeysListByInstanceOptionalParams):
PagedAsyncIterableIterator<ManagedInstanceKey, ManagedInstanceKey[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group that contains the resource. You can
obtain
this value from the Azure Resource Manager API or the portal.
- id: managedInstanceName
type: string
description: The name of the managed instance.
- id: options
type: >-
<xref
uid="@azure/arm-sql.ManagedInstanceKeysListByInstanceOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-sql.ManagedInstanceKey" />, <xref
uid="@azure/arm-sql.ManagedInstanceKey" />[], <xref
uid="@azure/core-paging.PageSettings" />>