Encryption Protectors - Create Or Update

Serviço:

SQL Database

Versão da API:

2023-08-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=2023-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
encryptionProtectorName	path	True	EncryptionProtectorName	O nome do protetor de criptografia a ser atualizado.
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor na API do Azure Resource Manager ou no portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID da assinatura que identifica uma assinatura do Azure.
api-version	query	True	string	A versão da API a ser usada para a solicitação.

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
200 OK	EncryptionProtector	Atualizou com êxito o protetor de criptografia.
202 Accepted		Aceitado Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial 400 InvalidKeyName - Um valor inválido foi fornecido para o nome da chave do servidor. 400 InvalidKeyType – Não há suporte para o tipo de chave criar servidor. 400 InvalidUpsertKeyType – As chaves TDE gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não dão suporte a Criar ou Atualizar pelo usuário. 400 InvalidKeyUpsertRequest - A solicitação criar chave de servidor não existe ou não tem nenhum objeto de propriedades. 400 InvalidEncryptionProtectorName – Não há suporte para o nome da chave do protetor de criptografia. 400 SecurityAdalPrincipalCertExpiredError – A operação não pôde ser concluída porque o certificado principal do Azure Key Vault expirou. 400 AkvHostNotResolvingFromNode - host AKV '{0}' não é resolvível do SQL, no servidor '{1}'. 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri do Key Vault fornecido não é válido. 400 MissingKeyVaultUriForRestore – O URI da chave do Azure Key Vault '{0}' é necessário para restaurar com êxito o banco de dados '{1}' no servidor '{2}'. 400 AzureKeyVaultKeyUsedOnGeoPrimary - A operação não pôde ser concluída porque o nome da chave do Azure Key Vault {0} está atualmente definido como protetor de criptografia no geo-primário. 400 KeyMaterialNotFoundOnRemoteServer – O servidor remoto não tem acesso ao material de chave usado como protetor de TDE. 400 PerDatabaseCMKAKVKeyMaterialMissingOnGeoSecondary - Todos os bancos de dados na replicação geográfica devem conter o mesmo material de chave que o protetor de criptografia do banco de dados de origem. Adicione a chave '{0}' com o mesmo material de chave ao banco de dados de destino '{1}'. 400 AzureKeyVaultRsaKeyNotSupported – O cofre de chaves fornecido usa tamanho de chave RSA sem suporte ou tipo de chave. O tamanho da chave RSA com suporte é 2048 ou 3072 e o Tipo de Chave é RSA ou RSA-HSM. 400 PerDatabaseCMKAKVKeyUriMissingOnGeoSecondary – Quando a rotação automática do Protetor de TDE no nível do banco de dados estiver habilitada, os bancos de dados de origem e de destino deverão ser conectados ao mesmo cofre de chaves. Adicione a chave '{0}' (do mesmo cofre de chaves que está conectado ao banco de dados de origem) ao banco de dados de destino '{1}'. 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeysWithDatabaseName – Ao tentar replicar um banco de dados configurado com o protetor de criptografia no nível do banco de dados, as chaves atuais que estão sendo usadas pelo banco de dados primário devem ser passadas para o banco de dados secundário '{0}' 400 ManagedInstanceNoConditionToMakeDatabaseAccessible - A operação não pôde ser concluída porque não há permissões suficientes para iniciar o fluxo de trabalho acessível na instância gerenciada {0}. 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId fornecido pelo usuário não tem acesso ao KeyId fornecido 400 SameKeyUriNotFoundOnRemoteServer – O servidor secundário não tem o material de chave do mesmo cofre de chaves que o protetor de criptografia do servidor primário com a rotação automática de chave habilitada. 400 SameKeyMaterialNotFoundOnRemoteServer – O servidor secundário não tem o material de chave do protetor de criptografia do servidor primário. 400 SecurityAzureKeyVaultGeoChainError – Não há suporte para a criação do secundário (um processo conhecido como encadeamento) ao habilitar a Transparent Data Encryption usando o Azure Key Vault (BYOK). 400 PerDatabaseCMKDWNotSupported – O CMK no nível do banco de dados na versão prévia não tem suporte para a edição Datawarehouse. 400 BlockSystemAssignedIdentityForCrossTenantCMK – CMK de locatário cruzado só pode ser configurado quando o servidor é configurado com uma Identidade Gerenciada Atribuída pelo Usuário. Consulte https://aka.ms/sqltdebyokumi para configurar a Identidade Gerenciada Atribuída ao Usuário. 400 PerDatabaseCMKCopyOrReplicationAttemptedWithoutCurrentKeys – Ao tentar replicar um banco de dados configurado com o protetor de criptografia no nível do banco de dados, as chaves atuais que estão sendo usadas pelo primário devem ser passadas para o banco de dados secundário. 400 CannotDropDatabaseAKVError – O banco de dados {0} no servidor {1} não pode ser descartado com segurança porque é criptografado com uma chave gerenciada pelo cliente que não está mais acessível para fazer o último backup antes da queda. Restaure o Acesso do Azure Key Vault no servidor e revalidar as chaves para tornar esse banco de dados acessível e, em seguida, prossiga com a queda. Para obter detalhes, consulte https://aka.ms/tdecmkrestorability 400 CreateDatabaseAttemptedWithRotationInProgress – A operação create database não pode ser executada no momento devido à rotação de chaves TDE (Transparent Data Encryption) contínua no servidor. Tente a operação novamente mais tarde. 400 AzureKeyVaultKeyDisabled – A operação não pôde ser concluída no servidor porque a chave do Azure Key Vault está desabilitada. 400 PerDatabaseCMKRestoreNotSupported – A restauração do banco de dados não tem suporte quando o CMK no nível do banco de dados está configurado na versão prévia. 400 AzureKeyVaultInvalidExpirationDate – A operação não pôde ser concluída porque a data de validade da chave do Azure Key Vault é inválida. 400 PerDatabaseCMKHSNotSupported – O CMK no nível do banco de dados na versão prévia não tem suporte para a edição hyperscale. 400 SecurityAzureKeyVaultUrlNullOrEmpty - A operação não pôde ser concluída porque o Uri do Azure Key Vault é nulo ou vazio. 400 CMKOperationNotAllowed - O usuário tentou executar uma operação no servidor quando o servidor não tinha acesso ao Azure Key Vault. 400 AkvEndpointNotReachableFromNode – o ponto de extremidade akv '{0}' não é acessível do SQL, no servidor '{1}'. 400 AzureKeyVaultNoServerIdentity – A identidade do servidor não está configurada corretamente. 400 AzureKeyVaultInvalidUri – Uma resposta inválida do Azure Key Vault. Use um URI válido do Azure Key Vault. 400 AzureKeyVaultMissingPermissions – o servidor não tem permissões necessárias no Azure Key Vault. 400 AzureKeyVaultKeyNameCurrentlyInUse - A operação não pôde ser concluída porque o nome da chave do Azure Key Vault {0} está em uso no momento. 400 AzureKeyVaultKeyThumbprintIsDifferent - A operação não pôde ser concluída porque o material da chave do Azure Key Vault é diferente da chave de protetor de criptografia atual. 400 SecurityAzureKeyVaultInvalidKeyName - A operação não pôde ser concluída devido a um nome de chave de servidor inválido. 400 OldGenerationOfAKVKeyBeingUsedError – Não é permitido usar uma versão antiga da chave AKV como protetor de TDE. Use a versão mais recente da chave AKV como o protetor de criptografia 400 PerDatabaseCMKMissingIdentityOnGeoSecondaryDatabase – Por identidade cmk de banco de dados não configurada no banco de dados de destino. 400 AdalGenericError – A operação não pôde ser concluída porque um erro do Azure Active Directory foi encontrado. 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque uma entidade de serviço de biblioteca do Azure Active Directory não encontrou erro. 400 AzureKeyVaultMalformedVaultUri – O uri do Key Vault fornecido não é válido. 404 ServerNotInSubscriptionResourceGroup – O servidor especificado não existe no grupo de recursos e na assinatura especificados. 404 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado 404 ResourceNotFound – O recurso solicitado não foi encontrado. 404 ServerKeyNotFound – A chave do servidor solicitada não foi encontrada na assinatura atual. 404 OperationIdNotFound – A operação com id não existe. 409 EncryptionProtectorChangeInProgress – Não é possível atualizar o protetor de chave de criptografia de banco de dados enquanto a alteração do protetor já está em andamento 409 ServerKeyNameAlreadyExists – A chave do servidor já existe no servidor. 409 ServerKeyUriAlreadyExists – O URI da chave do servidor já existe no servidor. 409 ServerKeyDoesNotExists – A chave do servidor não existe. 409 AzureKeyVaultKeyNameNotFound – A operação não pôde ser concluída porque o nome da chave do Azure Key Vault não existe. 409 AzureKeyVaultKeyInUse – A chave está sendo usada no momento pelo servidor. 409 CannotCancelOperation – A operação de gerenciamento está em um estado que não pode ser cancelado. 409 OperationCancelled – A operação foi cancelada pelo usuário. 409 OperationInterrupted – A operação no recurso não pôde ser concluída porque foi interrompida por outra operação no mesmo recurso. 429 SubscriptionTooManyCreateUpdateRequests – Solicitações além do máximo de solicitações que podem ser processadas por recursos disponíveis. 429 SubscriptionTooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis. 500 OperationTimedOut – A operação atingiu o tempo limite e foi revertida automaticamente. Tente novamente a operação. 503 AzureKeyVaultConnectionFailed – A operação não pôde ser concluída no servidor porque as tentativas de conexão com o Azure Key Vault falharam 503 AzureKeyVaultGenericConnectionError – A operação não pôde ser concluída porque um erro foi encontrado ao tentar recuperar informações do Key Vault. 503 TooManyRequests – Solicitações além das solicitações máximas que podem ser processadas por recursos disponíveis.

Exemplos

Update the encryption protector to key vault

Update the encryption protector to service managed

Update the encryption protector to key vault

Solicitação de exemplo

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=2023-08-01

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorCreateOrUpdateKeyVault.json
// this example is just showing the usage of "EncryptionProtectors_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
EncryptionProtectorData data = new EncryptionProtectorData
{
    ServerKeyName = "someVault_someKey_01234567890123456789012345678901",
    ServerKeyType = SqlServerKeyType.AzureKeyVault,
    IsAutoRotationEnabled = false,
};
ArmOperation<EncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
EncryptionProtectorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EncryptionProtectorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

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

Código de status:

202

Update the encryption protector to service managed

Solicitação de exemplo

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=2023-08-01

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/EncryptionProtectorCreateOrUpdateServiceManaged.json
// this example is just showing the usage of "EncryptionProtectors_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-7398";
string serverName = "sqlcrudtest-4645";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this EncryptionProtectorResource
EncryptionProtectorCollection collection = sqlServer.GetEncryptionProtectors();

// invoke the operation
EncryptionProtectorName encryptionProtectorName = EncryptionProtectorName.Current;
EncryptionProtectorData data = new EncryptionProtectorData
{
    ServerKeyName = "ServiceManaged",
    ServerKeyType = SqlServerKeyType.ServiceManaged,
};
ArmOperation<EncryptionProtectorResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, encryptionProtectorName, data);
EncryptionProtectorResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
EncryptionProtectorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:

200

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

Código de status:

202

Definições

Nome	Description
EncryptionProtector	O protetor de criptografia do servidor.
EncryptionProtectorName	O nome do protetor de criptografia a ser atualizado.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerKeyType	O tipo de protetor de criptografia, como 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtector

Objeto

O protetor de criptografia do servidor.

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de protetor de criptografia. Esses são metadados usados para a experiência do portal do Azure.
location	string	Local do recurso.
name	string	Nome do recurso.
properties.autoRotationEnabled	boolean	Sinalizador de aceitação de rotação automática de chaves. Verdadeiro ou falso.
properties.serverKeyName	string	O nome da chave do servidor.
properties.serverKeyType	ServerKeyType	O tipo de protetor de criptografia, como 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Subregião do protetor de criptografia.
properties.thumbprint	string	Impressão digital da chave do servidor.
properties.uri	string	O URI da chave do servidor.
type	string	Tipo de recurso.

EncryptionProtectorName

Enumeração

O nome do protetor de criptografia a ser atualizado.

Valor	Description
current

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

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

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ServerKeyType

Enumeração

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

Valor	Description
ServiceManaged
AzureKeyVault