Partilhar via

Managed Instance Keys - Create Or Update

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Cria ou atualiza uma chave de instância gerenciada.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys/{keyName}?api-version=2021-11-01

Parâmetros do URI

Name Em Necessário Tipo Description
keyName
 path True

string

O nome da chave de instância gerenciada a ser operada (atualizada ou criada).
managedInstanceName
 path True

string

O nome da instância gerenciada.
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
subscriptionId
 path True

string

A ID de 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 do Pedido

Name Necessário Tipo Description
properties.serverKeyType True

ServerKeyType

O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.
properties.uri

string

O URI da chave. Se ServerKeyType for AzureKeyVault, o URI será necessário.

Respostas

Name Tipo Description
200 OK

ManagedInstanceKey

Atualizada com êxito a chave da instância gerenciada.
201 Created

ManagedInstanceKey

Criada com êxito a chave de instância gerenciada.
202 Accepted

Aceito
Other Status Codes

Respostas de erro: ***

  • 400 InvalidKeyName - Um valor inválido foi fornecido para o nome da chave do servidor.

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

  • 400 InvalidUpsertKeyType - As chaves TDE gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não suportam Criar ou Atualizar pelo usuário.

  • 400 InvalidKeyUpsertRequest - A solicitação de chave de servidor de criação não existe ou não tem nenhum objeto de propriedades.

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

  • 400 AkvHostNotResolvingFromNode - AKV host '{0}' não é resolvível a partir de SQL, no servidor '{1}'.

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri do Cofre da Chave fornecido não é válido.

  • 400 KeyMaterialNotFoundOnRemoteServer - O servidor remoto não tem acesso ao material de chave usado como um protetor TDE.

  • 400 AzureKeyVaultRsaKeyNotSupported - O cofre de chaves fornecido usa o Tamanho da Chave RSA ou o Tipo de Chave não suportados. O tamanho da chave RSA suportada é 2048 ou 3072 e o tipo de chave é RSA ou RSA-HSM.

  • 400 AzureKeyVaultKeyDisabled - A operação não pôde ser concluída no servidor porque a chave do Cofre da Chave do Azure está desabilitada.

  • 400 AzureKeyVaultInvalidExpirationDate - A operação não pôde ser concluída porque a data de expiração da chave do Cofre da Chave do Azure é inválida.

  • 400 SameKeyUriNotFoundOnRemoteServer - O servidor secundário não tem o material da chave do mesmo cofre de chaves que o protetor de criptografia do servidor primário com a rotação automática de chaves habilitada.

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

  • 400 SameKeyMaterialNotFoundOnRemoteServer - O servidor secundário não tem o material da chave do protetor de criptografia do servidor primário.

  • 400 PerDatabaseCMKRestoreNotSupported - A restauração do banco de dados não é suportada quando a CMK no nível de banco de dados é configurada na visualização.

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

  • 400 PerDatabaseCMKHSNotSupported - A CMK no nível de banco de dados em visualização não é suportada para a edição Hyperscale.

  • 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 as permissões necessárias no Cofre da Chave do Azure.

  • 400 UmiMissingAkvPermissions - PrimaryUserAssignedIdentityId fornecido pelo usuário não tem acesso ao KeyId fornecido

  • 400 AkvEndpointNotReachableFromNode - AKV endpoint '{0}' não é acessível a partir de SQL, no servidor '{1}'.

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

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

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque foi encontrado um erro de Entidade de Serviço não encontrada da biblioteca do Azure Ative Directory.

  • 400 AzureKeyVaultMalformedVaultUri - O uri do Cofre da Chave fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError - A criação de secundário de secundário (um processo conhecido como encadeamento) não é suportada ao habilitar a Criptografia de Dados Transparente usando o Cofre de Chaves do Azure (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - A CMK no nível de banco de dados em visualização não é suportada para a edição Datawarehouse.

  • 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado

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

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

  • 404 OperationIdNotFound - A operação com Id não existe.

  • 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 Cofre da Chave do Azure não existe.

  • 409 AzureKeyVaultKeyInUse - A chave está sendo usada atualmente pelo servidor.

  • 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 pelos recursos disponíveis.

  • 429 SubscriptionTooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

  • 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Por favor, 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 ao Cofre de Chaves do Azure falharam

  • 503 AzureKeyVaultGenericConnectionError - A operação não pôde ser concluída porque foi encontrado um erro ao tentar recuperar informações do Cofre da Chave.

  • 503 TooManyRequests - Solicitações além do máximo de solicitações que podem ser processadas pelos recursos disponíveis.

Exemplos

Creates or updates a managed instance key

Pedido de amostra

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

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

Resposta da amostra

Código de estado:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}
Código de estado:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/managedInstances/keys",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-01T00:00:00Z",
    "autoRotationEnabled": false
  }
}
Código de estado:
202

Definições

Name Description
ManagedInstanceKey

Uma chave de instância gerenciada.
ServerKeyType

O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.

ManagedInstanceKey

Object

Uma chave de instância gerenciada.

Name 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.
name

string

Nome do recurso.
properties.autoRotationEnabled

boolean

Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.
properties.creationDate

string (date-time)

A data de criação da chave.
properties.serverKeyType

ServerKeyType

O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.
properties.thumbprint

string

Impressão digital da chave.
properties.uri

string

O URI da chave. Se ServerKeyType for AzureKeyVault, o URI será necessário.
type

string

Tipo de recurso.

ServerKeyType

Enumeração

O tipo de chave como 'ServiceManaged', 'AzureKeyVault'.

Valor Description
AzureKeyVault
ServiceManaged