Encryption Protectors - Create Or Update

Serviço:: SQL Database

Versão da API:: 2025-01-01

Atualiza um protetor de criptografia existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
encryptionProtectorName	path	True	EncryptionProtectorName	O nome do protetor de criptografia a ser recuperado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.serverKeyType	True	ServerKeyType	O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.
properties.autoRotationEnabled		boolean	Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.
properties.serverKeyName		string	O nome da chave do servidor.

Respostas

Name	Tipo	Description
200 OK	EncryptionProtector	Operação de atualização do recurso 'EncryptionProtector' bem-sucedida
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

EncryptionProtector

Operação de atualização do recurso 'EncryptionProtector' bem-sucedida

202 Accepted

Operação de recurso aceita.

Cabeçalhos

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

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

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Update the encryption protector to key vault with versionless key

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Update the encryption protector to service managed

Pedido de amostra

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"
  }
}

Resposta da amostra

Código de estado:: 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"
  }
}

Código de estado:: 202

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
EncryptionProtector	O protetor de criptografia do servidor.
EncryptionProtectorName
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerKeyType	O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

EncryptionProtector

Object

O protetor de criptografia do servidor.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de protetor de criptografia. Estes são metadados usados para a experiência do portal Azure.
location	string	Localização do recurso.
name	string	O nome do recurso
properties.autoRotationEnabled	boolean	Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.
properties.keyVersion	string	A versão da chave do servidor que está sendo usada como protetor de criptografia
properties.serverKeyName	string	O nome da chave do servidor.
properties.serverKeyType	ServerKeyType	O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Sub-região do protetor de criptografia.
properties.thumbprint	string	Impressão digital da chave do servidor.
properties.uri	string	O URI da chave do servidor.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

EncryptionProtectorName

Enumeração

Valor	Description
current	atual

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ServerKeyType

Enumeração

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

Valor	Description
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.