Banco de dados Microsoft.DocumentDBAccounts/sqlDatabases/clientEncryptionKeys 2023-03-15
- Mais recente
- 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
Definição de recurso do Bicep
O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o seguinte Bicep ao modelo.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15' = {
name: 'string'
parent: resourceSymbolicName
properties: {
resource: {
encryptionAlgorithm: 'string'
id: 'string'
keyWrapMetadata: {
algorithm: 'string'
name: 'string'
type: 'string'
value: 'string'
}
wrappedDataEncryptionKey: any()
}
}
}
Valores de propriedade
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Descrição | Valor |
|---|---|---|
| name | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
cadeia de caracteres (obrigatório) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte Recurso filho fora do recurso pai. |
Nome simbólico para o recurso do tipo: sqlDatabases |
| properties | Propriedades para criar e atualizar ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Descrição | Valor |
|---|---|---|
| recurso | O formato JSON padrão de um ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Descrição | Valor |
|---|---|---|
| Encryptionalgorithm | Algoritmo de criptografia que será usado junto com essa chave de criptografia de cliente para criptografar/descriptografar dados. | string |
| id | Nome do ClientEncryptionKey | string |
| keyWrapMetadata | Metadados para o provedor de encapsulamento que podem ser usados para desencapsular a chave de criptografia de cliente encapsulada. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. | Para o Bicep, você pode usar a função any(). |
KeyWrapMetadata
| Name | Descrição | Valor |
|---|---|---|
| algoritmo | Algoritmo usado no encapsulamento e desencapsular a chave de criptografia de dados. | string |
| name | O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Referência/link para KeyEncryptionKey. | string |
Definição de recurso de modelo do ARM
O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:
- Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys",
"apiVersion": "2023-03-15",
"name": "string",
"properties": {
"resource": {
"encryptionAlgorithm": "string",
"id": "string",
"keyWrapMetadata": {
"algorithm": "string",
"name": "string",
"type": "string",
"value": "string"
},
"wrappedDataEncryptionKey": {}
}
}
}
Valores de propriedade
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys' |
| apiVersion | A versão da API de recursos | '2023-03-15' |
| name | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON. |
cadeia de caracteres (obrigatório) |
| properties | Propriedades para criar e atualizar ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Descrição | Valor |
|---|---|---|
| recurso | O formato JSON padrão de um ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Descrição | Valor |
|---|---|---|
| Encryptionalgorithm | Algoritmo de criptografia que será usado junto com essa chave de criptografia do cliente para criptografar/descriptografar dados. | string |
| id | Nome do ClientEncryptionKey | string |
| keyWrapMetadata | Metadados para o provedor de encapsulamento que podem ser usados para desembrulhar a chave de criptografia de cliente encapsulada. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. |
KeyWrapMetadata
| Name | Descrição | Valor |
|---|---|---|
| algoritmo | Algoritmo usado em encapsulamento e desembrulhamento da chave de criptografia de dados. | string |
| name | O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Referência/link para KeyEncryptionKey. | string |
Definição de recurso do Terraform (provedor AzAPI)
O tipo de recurso databaseAccounts/sqlDatabases/clientEncryptionKeys pode ser implantado com operações direcionadas:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato de recurso
Para criar um recurso Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys, adicione o Terraform a seguir ao modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
resource = {
encryptionAlgorithm = "string"
id = "string"
keyWrapMetadata = {
algorithm = "string"
name = "string"
type = "string"
value = "string"
}
}
}
})
}
Valores de propriedade
databaseAccounts/sqlDatabases/clientEncryptionKeys
| Name | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKeys@2023-03-15" |
| name | O nome do recurso | cadeia de caracteres (obrigatório) |
| parent_id | A ID do recurso que é o pai desse recurso. | ID do recurso do tipo: sqlDatabases |
| properties | Propriedades para criar e atualizar ClientEncryptionKey. | ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc... (obrigatório) |
ClientEncryptionKeyCreateUpdatePropertiesOrClientEnc...
| Name | Descrição | Valor |
|---|---|---|
| recurso | O formato JSON padrão de um ClientEncryptionKey | ClientEncryptionKeyResourceOrClientEncryptionKeyGetP... (obrigatório) |
ClientEncryptionKeyResourceOrClientEncryptionKeyGetP...
| Name | Descrição | Valor |
|---|---|---|
| Encryptionalgorithm | Algoritmo de criptografia que será usado junto com essa chave de criptografia do cliente para criptografar/descriptografar dados. | string |
| id | Nome do ClientEncryptionKey | string |
| keyWrapMetadata | Metadados para o provedor de encapsulamento que podem ser usados para desembrulhar a chave de criptografia de cliente encapsulada. | KeyWrapMetadata |
| wrappedDataEncryptionKey | Forma encapsulada (criptografada) da chave representada como uma matriz de bytes. |
KeyWrapMetadata
| Name | Descrição | Valor |
|---|---|---|
| algoritmo | Algoritmo usado em encapsulamento e desembrulhamento da chave de criptografia de dados. | string |
| name | O nome de KeyEncryptionKey associado (também conhecido como CustomerManagedKey). | string |
| type | ProviderName de KeyStoreProvider. | string |
| value | Referência/link para KeyEncryptionKey. | string |