/
ClientEncryptionIncludedPath.yml
62 lines (62 loc) · 1.82 KB
/
ClientEncryptionIncludedPath.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
### YamlMime:TSType
name: ClientEncryptionIncludedPath
uid: '@azure/arm-cosmosdb.ClientEncryptionIncludedPath'
package: '@azure/arm-cosmosdb'
summary: .
fullName: ClientEncryptionIncludedPath
remarks: ''
isDeprecated: false
type: interface
properties:
- name: clientEncryptionKeyId
uid: '@azure/arm-cosmosdb.ClientEncryptionIncludedPath.clientEncryptionKeyId'
package: '@azure/arm-cosmosdb'
summary: >-
The identifier of the Client Encryption Key to be used to encrypt the
path.
fullName: clientEncryptionKeyId
remarks: ''
isDeprecated: false
syntax:
content: 'clientEncryptionKeyId: string'
return:
description: ''
type: string
- name: encryptionAlgorithm
uid: '@azure/arm-cosmosdb.ClientEncryptionIncludedPath.encryptionAlgorithm'
package: '@azure/arm-cosmosdb'
summary: >-
The encryption algorithm which will be used. Eg -
AEAD_AES_256_CBC_HMAC_SHA256.
fullName: encryptionAlgorithm
remarks: ''
isDeprecated: false
syntax:
content: 'encryptionAlgorithm: string'
return:
description: ''
type: string
- name: encryptionType
uid: '@azure/arm-cosmosdb.ClientEncryptionIncludedPath.encryptionType'
package: '@azure/arm-cosmosdb'
summary: The type of encryption to be performed. Eg - Deterministic, Randomized.
fullName: encryptionType
remarks: ''
isDeprecated: false
syntax:
content: 'encryptionType: string'
return:
description: ''
type: string
- name: path
uid: '@azure/arm-cosmosdb.ClientEncryptionIncludedPath.path'
package: '@azure/arm-cosmosdb'
summary: Path that needs to be encrypted.
fullName: path
remarks: ''
isDeprecated: false
syntax:
content: 'path: string'
return:
description: ''
type: string