Microsoft.DocumentDB databaseAccounts/sqlDatabases/clientEncryptionKeys 2023-09-15
- Najnowsza
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15-preview
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15-preview
Definicja zasobu Bicep
Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
Wartości właściwości
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep. |
ciąg (wymagany) |
| Nadrzędny | W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu : sqlDatabases |
| properties | Właściwości do tworzenia i aktualizowania clientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nazwa | Opis | Wartość |
|---|---|---|
| zasób | Standardowy format JSON clientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (wymagane) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| encryptionAlgorithm | Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. | ciąg |
| identyfikator | Nazwa klucza ClientEncryptionKey | ciąg |
| keyWrapMetadata | Metadane dostawcy opakowującego, którego można użyć do odłączania opakowanych kluczy szyfrowania klienta. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. | W przypadku Bicep można użyć funkcji any(). |
KeyWrapMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| Algorytm | Algorytm używany w zawijaniu i rozpakowaniu klucza szyfrowania danych. | ciąg |
| name | Nazwa skojarzonego kluczaEncryptionKey (aka CustomerManagedKey). | ciąg |
| typ | ProviderName dostawcy KeyStoreProvider. | ciąg |
| wartość | Odwołanie/link do klucza KluczEncryptionKey. | ciąg |
Definicja zasobu szablonu usługi ARM
Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
"apiVersion": "2023-09-15",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
Wartości właściwości
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys" |
| apiVersion | Wersja interfejsu API zasobów | '2023-09-15' |
| name | Nazwa zasobu Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON. |
ciąg (wymagany) |
| properties | Właściwości do tworzenia i aktualizowania ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nazwa | Opis | Wartość |
|---|---|---|
| zasób | Standardowy format JSON clientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (wymagane) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| encryptionAlgorithm | Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. | ciąg |
| identyfikator | Nazwa klucza ClientEncryptionKey | ciąg |
| keyWrapMetadata | Metadane dla dostawcy opakowującego, który może służyć do odpakowywania opakowany klucz szyfrowania klienta. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. |
KeyWrapMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| Algorytm | Algorytm używany do opakowywania i rozpakowywania klucza szyfrowania danych. | ciąg |
| name | Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). | ciąg |
| typ | ProviderName dostawcy KeyStoreProvider. | ciąg |
| wartość | Odwołanie/łącze do klucza KeyEncryptionKey. | ciąg |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu databaseAccounts/sqlDatabases/clientEncryptionKeys można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, dodaj następujący element Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
resource = {
encryptionAlgorithm = "string"
id = "string"
keyWrapMetadata = {
algorithm = "string"
name = "string"
type = "string"
value = "string"
}
}
}
})
}
Wartości właściwości
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-09-15" |
| name | Nazwa zasobu | ciąg (wymagany) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu : sqlDatabases |
| properties | Właściwości do tworzenia i aktualizowania ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (wymagane) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Nazwa | Opis | Wartość |
|---|---|---|
| zasób | Standardowy format JSON clientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (wymagane) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Nazwa | Opis | Wartość |
|---|---|---|
| encryptionAlgorithm | Algorytm szyfrowania, który będzie używany wraz z tym kluczem szyfrowania klienta do szyfrowania/odszyfrowywania danych. | ciąg |
| identyfikator | Nazwa klucza ClientEncryptionKey | ciąg |
| keyWrapMetadata | Metadane dla dostawcy opakowującego, który może służyć do odpakowywania opakowany klucz szyfrowania klienta. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Opakowana (zaszyfrowana) forma klucza reprezentowana jako tablica bajtów. |
KeyWrapMetadata
| Nazwa | Opis | Wartość |
|---|---|---|
| Algorytm | Algorytm używany do opakowywania i rozpakowywania klucza szyfrowania danych. | ciąg |
| name | Nazwa skojarzonego klucza KeyEncryptionKey (aka CustomerManagedKey). | ciąg |
| typ | ProviderName dostawcy KeyStoreProvider. | ciąg |
| wartość | Odwołanie/łącze do klucza KeyEncryptionKey. | ciąg |