Server Keys - Create Or Update

  • Referência
Service:
SQL Database
API Version:
2021-11-01

Cria ou atualiza uma chave de servidor.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
keyName
 path True

string

O nome da chave do servidor em que será operada (atualizada ou criada). O nome da chave deve estar no formato "vault_key_version". Por exemplo, se keyId for https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, o nome da chave do servidor deverá ser formatado como: YourVaultName_YourKeyName_YourKeyVersion
resourceGroupName
 path True

string

O nome do grupo de recursos que contém o recurso. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
serverName
 path True

string

O nome do servidor.
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 da solicitação

Nome Obrigatório Tipo Description
properties.serverKeyType True

ServerKeyType

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

string

O URI da chave do servidor. Se ServerKeyType for AzureKeyVault, o URI será necessário. O URI do AKV deve estar neste formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

Respostas

Nome Tipo Description
200 OK

ServerKey

A chave do servidor foi atualizada com êxito.
201 Created

ServerKey

A chave do servidor foi criada com êxito.
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 - Não há suporte para o tipo de chave create server.

  • 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 de criação de chave de servidor não existe ou não tem nenhum objeto properties.

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

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

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

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

  • 400 AzureKeyVaultRsaKeyNotSupported – o cofre de chaves fornecido usa o tamanho da chave RSA ou o tipo de chave RSA sem suporte. O tamanho da chave RSA com suporte é 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 de Key Vault do Azure está desabilitada.

  • 400 AzureKeyVaultInvalidExpirationDate - A operação não pôde ser concluída porque a data de validade da chave Key Vault 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 chave habilitada.

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

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

  • 400 PerDatabaseCMKRestoreNotSupported – A restauração do banco de dados não tem suporte quando a CMK no nível do banco de dados está configurada na versão prévia.

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

  • 400 PerDatabaseCMKHSNotSupported – A CMK no nível do banco de dados na versão prévia não é compatível com a edição Hiperescala.

  • 400 AzureKeyVaultInvalidUri – uma resposta inválida do Azure Key Vault. Use um URI de Key Vault do Azure válido.

  • 400 AzureKeyVaultMissingPermissions – faltam permissões necessárias para o servidor no Key Vault do Azure.

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

  • 400 AkvEndpointNotReachableFromNode - O ponto de extremidade do AKV '{0}' não está acessível do 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 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 da biblioteca do Azure Active Directory não encontrada erro foi encontrada.

  • 400 AzureKeyVaultMalformedVaultUri – o URI de Key Vault fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError – Não há suporte para a criação secundária do secundário (um processo conhecido como encadeamento) ao habilitar o Transparent Data Encryption usando o BYOK (Azure Key Vault).

  • 400 PerDatabaseCMKDWNotSupported – A CMK no nível do banco de dados na versão prévia não tem suporte para a edição Datawarehouse.

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

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

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

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

  • 400 AzureKeyVaultRsaKeyNotSupported – o cofre de chaves fornecido usa o tamanho da chave RSA ou o tipo de chave RSA sem suporte. O tamanho da chave RSA com suporte é 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 de Key Vault do Azure está desabilitada.

  • 400 AzureKeyVaultInvalidExpirationDate - A operação não pôde ser concluída porque a data de validade da chave Key Vault 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 chave habilitada.

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

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

  • 400 PerDatabaseCMKRestoreNotSupported – A restauração do banco de dados não tem suporte quando a CMK no nível do banco de dados está configurada na versão prévia.

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

  • 400 PerDatabaseCMKHSNotSupported – A CMK no nível do banco de dados na versão prévia não é compatível com a edição Hiperescala.

  • 400 AzureKeyVaultInvalidUri – uma resposta inválida do Azure Key Vault. Use um URI de Key Vault do Azure válido.

  • 400 AzureKeyVaultMissingPermissions – faltam permissões necessárias para o servidor no Key Vault do Azure.

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

  • 400 AkvEndpointNotReachableFromNode - O ponto de extremidade do AKV '{0}' não está acessível do 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 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 da biblioteca do Azure Active Directory não encontrada erro foi encontrada.

  • 400 AzureKeyVaultMalformedVaultUri – o URI de Key Vault fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError – Não há suporte para a criação secundária do secundário (um processo conhecido como encadeamento) ao habilitar o Transparent Data Encryption usando o BYOK (Azure Key Vault).

  • 400 PerDatabaseCMKDWNotSupported – A CMK no nível do banco de dados na versão prévia não tem suporte 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 de Key Vault do Azure não existe.

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

  • 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 de Key Vault do Azure não existe.

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

  • 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 do máximo de solicitações que podem ser processadas por recursos disponíveis.

  • 500 OperationTimedOut - A operação atingiu o tempo limite e foi revertida automaticamente. Tente executar a operação novamente.

  • 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 Key Vault informações .

  • 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 Key Vault informações .

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

Exemplos

Creates or updates a server key

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}
Status code:
202

Definições

Nome Description
ServerKey

Uma chave do servidor.
ServerKeyType

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

ServerKey

Uma chave do servidor.

Nome Tipo Description
id

string

ID do recurso.
kind

string

Tipo de protetor de criptografia. Esses são os metadados usados para a experiência de 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 chave. Verdadeiro ou falso.
properties.creationDate

string

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

ServerKeyType

O tipo de chave do servidor, como 'ServiceManaged', 'AzureKeyVault'.
properties.subregion

string

Sub-região da chave do servidor.
properties.thumbprint

string

Impressão digital da chave do servidor.
properties.uri

string

O URI da chave do servidor. Se ServerKeyType for AzureKeyVault, o URI será necessário. O URI do AKV deve estar neste formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type

string

Tipo de recurso.

ServerKeyType

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

Nome Tipo Description
AzureKeyVault

string

ServiceManaged

string