-
Notifications
You must be signed in to change notification settings - Fork 180
/
ServerKeys.yml
217 lines (217 loc) · 8.93 KB
/
ServerKeys.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
### YamlMime:TSType
name: ServerKeys
uid: '@azure/arm-sql.ServerKeys'
package: '@azure/arm-sql'
summary: Interface representing a ServerKeys.
fullName: ServerKeys
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, ServerKey,
ServerKeysCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.ServerKeys.beginCreateOrUpdate'
package: '@azure/arm-sql'
summary: Creates or updates a server key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, serverName:
string, keyName: string, parameters: ServerKey, options?:
ServerKeysCreateOrUpdateOptionalParams):
Promise<SimplePollerLike<OperationState<ServerKey>, ServerKey>>
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: serverName
type: string
description: The name of the server.
- id: keyName
type: string
description: >-
The name of the server key to be operated on (updated or created).
The key name is
required to be in the format of 'vault_key_version'. For example, if the keyId is
https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name
should be formatted as: YourVaultName_YourKeyName_YourKeyVersion
- id: parameters
type: <xref uid="@azure/arm-sql.ServerKey" />
description: The requested server key resource state.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysCreateOrUpdateOptionalParams" />
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.ServerKey" />>, <xref
uid="@azure/arm-sql.ServerKey" />>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, ServerKey,
ServerKeysCreateOrUpdateOptionalParams)
uid: '@azure/arm-sql.ServerKeys.beginCreateOrUpdateAndWait'
package: '@azure/arm-sql'
summary: Creates or updates a server key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
serverName: string, keyName: string, parameters: ServerKey, options?:
ServerKeysCreateOrUpdateOptionalParams): Promise<ServerKey>
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: serverName
type: string
description: The name of the server.
- id: keyName
type: string
description: >-
The name of the server key to be operated on (updated or created).
The key name is
required to be in the format of 'vault_key_version'. For example, if the keyId is
https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, then the server key name
should be formatted as: YourVaultName_YourKeyName_YourKeyVersion
- id: parameters
type: <xref uid="@azure/arm-sql.ServerKey" />
description: The requested server key resource state.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.ServerKey" />>
- name: beginDelete(string, string, string, ServerKeysDeleteOptionalParams)
uid: '@azure/arm-sql.ServerKeys.beginDelete'
package: '@azure/arm-sql'
summary: Deletes the server key with the given name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, serverName: string,
keyName: string, options?: ServerKeysDeleteOptionalParams):
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: serverName
type: string
description: The name of the server.
- id: keyName
type: string
description: The name of the server key to be deleted.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysDeleteOptionalParams" />
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, ServerKeysDeleteOptionalParams)
uid: '@azure/arm-sql.ServerKeys.beginDeleteAndWait'
package: '@azure/arm-sql'
summary: Deletes the server key with the given name.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, serverName:
string, keyName: string, options?: ServerKeysDeleteOptionalParams):
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: serverName
type: string
description: The name of the server.
- id: keyName
type: string
description: The name of the server key to be deleted.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<void>
- name: get(string, string, string, ServerKeysGetOptionalParams)
uid: '@azure/arm-sql.ServerKeys.get'
package: '@azure/arm-sql'
summary: Gets a server key.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, serverName: string, keyName:
string, options?: ServerKeysGetOptionalParams): Promise<ServerKey>
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: serverName
type: string
description: The name of the server.
- id: keyName
type: string
description: The name of the server key to be retrieved.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-sql.ServerKey" />>
- name: listByServer(string, string, ServerKeysListByServerOptionalParams)
uid: '@azure/arm-sql.ServerKeys.listByServer'
package: '@azure/arm-sql'
summary: Gets a list of server keys.
remarks: ''
isDeprecated: false
syntax:
content: >-
function listByServer(resourceGroupName: string, serverName: string,
options?: ServerKeysListByServerOptionalParams):
PagedAsyncIterableIterator<ServerKey, ServerKey[], 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: serverName
type: string
description: The name of the server.
- id: options
type: <xref uid="@azure/arm-sql.ServerKeysListByServerOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-sql.ServerKey" />, <xref
uid="@azure/arm-sql.ServerKey" />[], <xref
uid="@azure/core-paging.PageSettings" />>