你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Sql 服务器/加密保护器

Bicep 资源定义

可以使用目标作部署服务器/encryptionProtector 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/encryptionProtector 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Sql/servers/encryptionProtector@2024-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    autoRotationEnabled: bool
    serverKeyName: 'string'
    serverKeyType: 'string'
  }
}

属性值

Microsoft.Sql/servers/encryptionProtector

Name Description Value
name 资源名称 “current”(必需)
父级 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源外部的子资源
类型资源的符号名称:服务器
properties 资源属性。 EncryptionProtectorProperties

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled 密钥自动轮换选择加入标志。 true 或 false。 bool
serverKeyName 服务器密钥的名称。 字符串
serverKeyType 加密保护程序类型,例如“ServiceManaged”、“AzureKeyVault”。 'AzureKeyVault'
'ServiceManaged'(必需)

ARM 模板资源定义

可以使用目标作部署服务器/encryptionProtector 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/encryptionProtector 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "apiVersion": "2024-11-01-preview",
  "name": "string",
  "properties": {
    "autoRotationEnabled": "bool",
    "serverKeyName": "string",
    "serverKeyType": "string"
  }
}

属性值

Microsoft.Sql/servers/encryptionProtector

Name Description Value
apiVersion API 版本 '2024-11-01-preview'
name 资源名称 “current”(必需)
properties 资源属性。 EncryptionProtectorProperties
类型 资源类型 'Microsoft.Sql/servers/encryptionProtector'

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled 密钥自动轮换选择加入标志。 true 或 false。 bool
serverKeyName 服务器密钥的名称。 字符串
serverKeyType 加密保护程序类型,例如“ServiceManaged”、“AzureKeyVault”。 'AzureKeyVault'
'ServiceManaged'(必需)

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

Template Description
使用数据加密保护程序创建 Azure SQL Server

部署到 Azure
此模板创建 Azure SQL Server,使用存储在给定 Key Vault 中的给定密钥激活数据加密保护程序

Terraform (AzAPI 提供程序)资源定义

可以使用目标作部署服务器/encryptionProtector 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Sql/servers/encryptionProtector 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Sql/servers/encryptionProtector@2024-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      autoRotationEnabled = bool
      serverKeyName = "string"
      serverKeyType = "string"
    }
  }
}

属性值

Microsoft.Sql/servers/encryptionProtector

Name Description Value
name 资源名称 “current”(必需)
parent_id 此资源的父资源的 ID。 类型资源的 ID:服务器
properties 资源属性。 EncryptionProtectorProperties
类型 资源类型 “Microsoft.Sql/servers/encryptionProtector@2024-11-01-preview”

EncryptionProtectorProperties

Name Description Value
autoRotationEnabled 密钥自动轮换选择加入标志。 true 或 false。 bool
serverKeyName 服务器密钥的名称。 字符串
serverKeyType 加密保护程序类型,例如“ServiceManaged”、“AzureKeyVault”。 'AzureKeyVault'
'ServiceManaged'(必需)

用法示例

Terraform 示例

为 MSSQL Server 部署透明数据加密配置的基本示例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westus"
}

variable "administrator_login_password" {
  type        = string
  sensitive   = true
  description = "The administrator login password for the SQL server"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "server" {
  type      = "Microsoft.Sql/servers@2023-08-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      administratorLogin            = "mradministrator"
      administratorLoginPassword    = var.administrator_login_password
      minimalTlsVersion             = "1.2"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      version                       = "12.0"
    }
  }
}

resource "azapi_resource" "encryptionProtector" {
  type      = "Microsoft.Sql/servers/encryptionProtector@2023-08-01-preview"
  parent_id = azapi_resource.server.id
  name      = "current"
  body = {
    properties = {
      autoRotationEnabled = false
      serverKeyName       = ""
      serverKeyType       = "ServiceManaged"
    }
  }
}