Managed Instance Encryption Protectors - Create Or Update

Atualiza um protetor de encriptação existente.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/encryptionProtector/current?api-version=2021-02-01-preview

Parâmetros do URI

Name In Required Type Description
encryptionProtectorName
path True

O nome do protetor de encriptação deve ser atualizado.

managedInstanceName
path True
  • string

O nome do caso gerido.

resourceGroupName
path True
  • string

O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir do Azure Resource Manager API ou do portal.

subscriptionId
path True
  • string

O ID de subscrição que identifica uma subscrição do Azure.

api-version
query True
  • string

A versão API a utilizar para o pedido.

Corpo do Pedido

Name Required Type Description
properties.serverKeyType True

O tipo de protetor de encriptação como 'ServiceManaged', 'AzureKeyVault'.

properties.autoRotationEnabled
  • boolean

Chave auto rotação de opt-in bandeira. Ou verdadeiro ou falso.

properties.serverKeyName
  • string

O nome da chave de exemplo gerida.

Respostas

Name Type Description
200 OK

Atualizou com sucesso o protetor de encriptação.

202 Accepted

Aceite

Other Status Codes

Respostas de erro: ***

  • 400 InvalidKeyName - Foi dado um valor inválido para o nome chave do servidor.

  • 400 InvalidKeyType - O tipo de chave de servidor de criar não é suportado.

  • 400 InvalidUpsertKeyType - As teclas TDE geridas pelo serviço são geridas pelo serviço. As teclas TDE geridas pelo serviço não suportam criar ou atualizar pelo utilizador.

  • 400 InvalidKeyUpsertRequest - O pedido de chave do servidor de criação não existe ou não tem nenhum objeto de propriedade.

  • 400 InvalidEncrypationProtectorName - O nome da chave protetora de encriptação não é suportado.

  • 400 SecurityAdalPrincipalCertExpiredError - A operação não pôde ser concluída porque o Azure Key Vault certificado principal expirou.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O Key Vault uri fornecido não é válido.

  • 400 KeyMaterialNotFoundOnRemoteServer - O servidor remoto não tem acesso a material chave utilizado como protetor TDE.

  • 400 AzureKeyVaultMismatchError - Região de Key Vault inesperada encontrada na resposta http.

  • 400 AzureKeyVaultRsaKeyNotSupported - O cofre de chaves fornecido utiliza tamanho ou tipo de chave RSA não suportado. O tamanho da chave RSA suportado é 2048 ou 3072 e o Tipo chave é RSA ou RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled - A operação não pôde ser concluída no servidor porque a tecla Azure Key Vault está desativada.

  • 400 AzureKeyVaultInvalidexpirationDate - A operação não pôde ser concluída porque a data de validade do Azure Key Vault chave é inválida.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty - A operação não pôde ser concluída porque o Azure Key Vault Uri é nulo ou vazio.

  • 400 AzureKeyVaultNoServerIdentity - A identidade do servidor não está corretamente configurada.

  • 400 AzureKeyVaultInvalidUri - Uma resposta inválida da Azure Key Vault. Por favor, utilize um Azure Key Vault URI válido.

  • 400 AzureKeyVaultMissingPermissions - Falta permissões necessárias no Azure Key Vault.

  • 400 SecurityAzureKeyVaultInvalidKeyName - A operação não pôde ser concluída devido a um nome inválido da chave do servidor.

  • 400 AdalGenericError - A operação não pôde ser concluída porque foi encontrado um erro Azure Ative Directory.

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque um Azure Ative Directory de serviço de biblioteca principal não encontrou erro.

  • 400 AzureKeyVaultMalformedVaultUri - O Key Vault uri fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError - A criação secundária de secundário (um processo conhecido como chaining) não é suportada ao permitir Encriptação de Dados Transparente utilizando a Azure Key Vault (BYOK).

  • 404 SubscriçãoDoesNotHaveServer - O servidor solicitado não foi encontrado

  • 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos especificado e na subscrição.

  • 404 ResourceNotFound - O recurso solicitado não foi encontrado.

  • 404 ServerKeyNotFound - A chave do servidor solicitada não foi encontrada na subscrição atual.

  • 409 ServerKeyNameAlreadyExists - A chave do servidor já existe no servidor.

  • 409 ServerKeyUriAlreadyExists - A chave de servidor URI 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 chave Azure Key Vault não existe.

  • 409 AzureKeyVaultKeyInUse - A chave está atualmente a ser utilizada pelo servidor.

  • 503 AzureKeyVaultConnectionFailed - A operação não pôde ser concluída no servidor porque as tentativas de ligação ao Azure Key Vault falharam

  • 503 AzureKeyVaultGenericConnectionError - A operação não pôde ser concluída porque foi encontrado um erro ao tentar recuperar Key Vault informação .

Exemplos

Update the encryption protector to key vault
Update the encryption protector to service managed

Update the encryption protector to key vault

Sample Request

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

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

Sample Response

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

Update the encryption protector to service managed

Sample Request

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

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

Sample Response

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

Definições

EncryptionProtectorName

O nome do protetor de encriptação deve ser atualizado.

ManagedInstanceEncryptionProtector

O protetor de encriptação de exemplo gerido.

ServerKeyType

O tipo de protetor de encriptação como 'ServiceManaged', 'AzureKeyVault'.

EncryptionProtectorName

O nome do protetor de encriptação deve ser atualizado.

Name Type Description
current
  • string

ManagedInstanceEncryptionProtector

O protetor de encriptação de exemplo gerido.

Name Type Description
id
  • string

Identificação de recursos.

kind
  • string

Tipo protetor de encriptação. Estes são metadados usados para a experiência portal do Azure.

name
  • string

Nome de recurso.

properties.autoRotationEnabled
  • boolean

Chave auto rotação de opt-in bandeira. Ou verdadeiro ou falso.

properties.serverKeyName
  • string

O nome da chave de exemplo gerida.

properties.serverKeyType

O tipo de protetor de encriptação como 'ServiceManaged', 'AzureKeyVault'.

properties.thumbprint
  • string

Impressão digital da chave do servidor.

properties.uri
  • string

O URI da chave do servidor.

type
  • string

Tipo de recurso.

ServerKeyType

O tipo de protetor de encriptação como 'ServiceManaged', 'AzureKeyVault'.

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string