-
Notifications
You must be signed in to change notification settings - Fork 182
/
EncryptionScopes.yml
214 lines (211 loc) · 8.97 KB
/
EncryptionScopes.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
### YamlMime:TSType
name: EncryptionScopes
uid: '@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopes'
package: '@azure/arm-storage-profile-2020-09-01-hybrid'
summary: Interface representing a EncryptionScopes.
fullName: EncryptionScopes
remarks: ''
isDeprecated: false
type: interface
methods:
- name: get(string, string, string, EncryptionScopesGetOptionalParams)
uid: '@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopes.get'
package: '@azure/arm-storage-profile-2020-09-01-hybrid'
summary: Returns the properties for the specified encryption scope.
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, accountName: string,
encryptionScopeName: string, options?:
EncryptionScopesGetOptionalParams): Promise<EncryptionScope>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: accountName
type: string
description: >-
The name of the storage account within the specified resource group.
Storage
account names must be between 3 and 24 characters in length and use numbers and lower-case letters
only.
- id: encryptionScopeName
type: string
description: >-
The name of the encryption scope within the specified storage
account.
Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case
letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a
letter or number.
- id: options
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopesGetOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>>
- name: list(string, string, EncryptionScopesListOptionalParams)
uid: '@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopes.list'
package: '@azure/arm-storage-profile-2020-09-01-hybrid'
summary: >-
Lists all the encryption scopes available under the specified storage
account.
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, accountName: string, options?:
EncryptionScopesListOptionalParams):
PagedAsyncIterableIterator<EncryptionScope, EncryptionScope[],
PageSettings>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: accountName
type: string
description: >-
The name of the storage account within the specified resource group.
Storage
account names must be between 3 and 24 characters in length and use numbers and lower-case letters
only.
- id: options
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopesListOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope" />,
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>[], <xref uid="@azure/core-paging.PageSettings" />>
- name: >-
patch(string, string, string, EncryptionScope,
EncryptionScopesPatchOptionalParams)
uid: '@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopes.patch'
package: '@azure/arm-storage-profile-2020-09-01-hybrid'
summary: >-
Update encryption scope properties as specified in the request body.
Update fails if the specified
encryption scope does not already exist.
remarks: ''
isDeprecated: false
syntax:
content: >-
function patch(resourceGroupName: string, accountName: string,
encryptionScopeName: string, encryptionScope: EncryptionScope, options?:
EncryptionScopesPatchOptionalParams): Promise<EncryptionScope>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: accountName
type: string
description: >-
The name of the storage account within the specified resource group.
Storage
account names must be between 3 and 24 characters in length and use numbers and lower-case letters
only.
- id: encryptionScopeName
type: string
description: >-
The name of the encryption scope within the specified storage
account.
Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case
letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a
letter or number.
- id: encryptionScope
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>
description: Encryption scope properties to be used for the update.
- id: options
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopesPatchOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>>
- name: >-
put(string, string, string, EncryptionScope,
EncryptionScopesPutOptionalParams)
uid: '@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopes.put'
package: '@azure/arm-storage-profile-2020-09-01-hybrid'
summary: >-
Synchronously creates or updates an encryption scope under the specified
storage account. If an
encryption scope is already created and a subsequent request is issued
with different properties,
the encryption scope properties will be updated per the specified request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function put(resourceGroupName: string, accountName: string,
encryptionScopeName: string, encryptionScope: EncryptionScope, options?:
EncryptionScopesPutOptionalParams): Promise<EncryptionScope>
parameters:
- id: resourceGroupName
type: string
description: >-
The name of the resource group within the user's subscription. The
name is
case insensitive.
- id: accountName
type: string
description: >-
The name of the storage account within the specified resource group.
Storage
account names must be between 3 and 24 characters in length and use numbers and lower-case letters
only.
- id: encryptionScopeName
type: string
description: >-
The name of the encryption scope within the specified storage
account.
Encryption scope names must be between 3 and 63 characters in length and use numbers, lower-case
letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a
letter or number.
- id: encryptionScope
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>
description: Encryption scope properties to be used for the create or update.
- id: options
type: >-
<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScopesPutOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-storage-profile-2020-09-01-hybrid.EncryptionScope"
/>>