Encryption Protectors - Create Or Update

Servicio:: SQL Database

Versión de la API:: 2025-01-01

Actualiza un protector de cifrado existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/encryptionProtector/current?api-version=2025-01-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
encryptionProtectorName	path	True	EncryptionProtectorName	Nombre del protector de cifrado que se va a recuperar.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.serverKeyType	True	ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
properties.autoRotationEnabled		boolean	Marca de participación de rotación automática de claves. True o false.
properties.serverKeyName		string	Nombre de la clave de servidor.

Respuestas

Nombre	Tipo	Description
200 OK	EncryptionProtector	Operación de actualización del recurso 'EncryptionProtector' exitosa
202 Accepted		Operación de recursos aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Nombre

Tipo

Description

200 OK

EncryptionProtector

Operación de actualización del recurso 'EncryptionProtector' exitosa

202 Accepted

Operación de recursos aceptada.

Encabezados

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Update the encryption protector to key vault

Update the encryption protector to key vault with versionless key

Update the encryption protector to service managed

Update the encryption protector to key vault

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2025-01-01

{
  "properties": {
    "autoRotationEnabled": false,
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "kind": "azurekeyvault",
  "location": "West US",
  "properties": {
    "autoRotationEnabled": false,
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault"
  }
}

status code:: 202

Update the encryption protector to key vault with versionless key

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2025-01-01

{
  "properties": {
    "autoRotationEnabled": false,
    "serverKeyName": "someVault_someKey",
    "serverKeyType": "AzureKeyVault"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "kind": "azurekeyvault",
  "location": "West US",
  "properties": {
    "autoRotationEnabled": false,
    "keyVersion": "01234567890123456789012345678901",
    "serverKeyName": "someVault_someKey",
    "serverKeyType": "AzureKeyVault"
  }
}

status code:: 202

Update the encryption protector to service managed

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current?api-version=2025-01-01

{
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

Respuesta de muestra

status code:: 200

{
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "kind": "servicemanaged",
  "location": "West US",
  "properties": {
    "serverKeyName": "ServiceManaged",
    "serverKeyType": "ServiceManaged"
  }
}

status code:: 202

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
EncryptionProtector	Protector de cifrado del servidor.
EncryptionProtectorName
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

EncryptionProtector

Objeto

Protector de cifrado del servidor.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de protector de cifrado. Estos son metadatos usados para la experiencia del portal de Azure.
location	string	Ubicación del recurso.
name	string	Nombre del recurso
properties.autoRotationEnabled	boolean	Marca de participación de rotación automática de claves. True o false.
properties.keyVersion	string	La versión de la clave de servidor que se usa como protector de cifrado
properties.serverKeyName	string	Nombre de la clave de servidor.
properties.serverKeyType	ServerKeyType	El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Subdivisión del protector de cifrado.
properties.thumbprint	string	Huella digital de la clave del servidor.
properties.uri	string	Identificador URI de la clave del servidor.
systemData	systemData	Azure Resource Manager metadatos que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft. Compute/virtualMachines" o "Microsoft. CuentasAlmacenamiento/Almacenamiento"

EncryptionProtectorName

Enumeración

Valor	Description
current	corriente

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ServerKeyType

Enumeración

El tipo de protector de cifrado como "ServiceManaged", "AzureKeyVault".

Valor	Description
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	La marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Encryption Protectors - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Update the encryption protector to key vault

Solicitud de ejemplo

Respuesta de muestra

Update the encryption protector to key vault with versionless key

Solicitud de ejemplo

Respuesta de muestra

Update the encryption protector to service managed

Solicitud de ejemplo

Respuesta de muestra

Definiciones

createdByType

EncryptionProtector

EncryptionProtectorName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerKeyType

systemData