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 do URI

Name Em Necessário Tipo Description
keyName
 path True

string

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

string

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

string

O nome do servidor.
subscriptionId
 path True

string

O ID da subscrição que identifica uma subscrição do Azure.
api-version
 query True

string

A versão da API a utilizar para o pedido.

Corpo do Pedido

Name Necessário Tipo Description
properties.serverKeyType True

ServerKeyType

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

string

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

Respostas

Name Tipo Description
200 OK

ServerKey

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

ServerKey

A chave de servidor foi criada com êxito.
202 Accepted

Aceite
Other Status Codes

Respostas de Erro: ***

  • 400 InvalidKeyName – foi atribuído um valor inválido para o nome da chave de servidor.

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

  • 400 InvalidUpsertKeyType – as chaves TDE geridas pelo serviço são geridas pelo serviço. As chaves de Encriptação de Dados Transparente geridas pelo serviço não suportam Criar ou Atualizar pelo utilizador.

  • 400 InvalidKeyUpsertRequest – o pedido de criação de chave de servidor não existe ou não tem nenhum objeto de propriedades.

  • 400 SecurityAdalPrincipalCertExpiredError – não foi possível concluir a operação porque o certificado principal do Azure Key Vault expirou.

  • 400 AkvHostNotResolvingFromNode – o anfitrião AKV "{0}" não é resolvível a partir 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 a material de chave utilizado como protetor de Encriptação de Dados Transparente.

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

  • 400 AzureKeyVaultKeyDisabled – não foi possível concluir a operação no servidor porque a chave de Key Vault do Azure está desativada.

  • 400 AzureKeyVaultInvalidExpirationDate – não foi possível concluir a operação porque a data de expiração da chave de Key Vault do Azure é inválida.

  • 400 SameKeyUriNotFoundOnRemoteServer – o servidor secundário não tem o material de chave do mesmo cofre de chaves que o protetor de encriptação do servidor primário com a rotação automática de chaves ativada.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – não foi possível concluir a operação porque o URI de Key Vault do Azure é nulo ou está vazio.

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

  • 400 PerDatabaseCMKRestoreNotSupported – o restauro da base de dados não é suportado quando a CMK ao nível da base de dados está configurada em pré-visualização.

  • 400 AzureKeyVaultNoServerIdentity – a identidade do servidor não está configurada corretamente.

  • 400 PerDatabaseCMKHSNotSupported – A CMK ao nível da base de dados em pré-visualização não é suportada para a edição Hyperscale.

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

  • 400 AzureKeyVaultMissingPermissions – o servidor tem as permissões necessárias em falta no Key Vault do Azure.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId fornecido pelo utilizador não tem acesso ao KeyId fornecido

  • 400 AkvEndpointNotReachableFromNode – o ponto final AKV "{0}" não está acessível a partir do SQL, no servidor "{1}".

  • 400 SecurityAzureKeyVaultInvalidKeyName – não foi possível concluir a operação devido a um nome de Chave de Servidor inválido.

  • 400 AdalGenericError – não foi possível concluir a operação porque foi encontrado um erro do Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – não foi possível concluir a operação porque não foi encontrado um erro de Principal de Serviço da biblioteca do Azure Active Directory.

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

  • 400 SecurityAzureKeyVaultGeoChainError – a criação de uma secundária secundária (um processo conhecido como encadeamento) não é suportada ao ativar a Encriptação de Dados Transparente com o Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - A CMK ao nível da base de dados em pré-visualização não é suportada para a edição Datawarehouse.

  • 400 SecurityAdalPrincipalCertExpiredError – não foi possível concluir a operação porque o certificado principal do Azure Key Vault expirou.

  • 400 AkvHostNotResolvingFromNode – o anfitrião AKV "{0}" não é resolvível a partir 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 a material de chave utilizado como protetor de Encriptação de Dados Transparente.

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

  • 400 AzureKeyVaultKeyDisabled – não foi possível concluir a operação no servidor porque a chave de Key Vault do Azure está desativada.

  • 400 AzureKeyVaultInvalidExpirationDate – não foi possível concluir a operação porque a data de expiração da chave de Key Vault do Azure é inválida.

  • 400 SameKeyUriNotFoundOnRemoteServer – o servidor secundário não tem o material de chave do mesmo cofre de chaves que o protetor de encriptação do servidor primário com a rotação automática de chaves ativada.

  • 400 SecurityAzureKeyVaultUrlNullOrEmpty – não foi possível concluir a operação porque o URI de Key Vault do Azure é nulo ou está vazio.

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

  • 400 PerDatabaseCMKRestoreNotSupported – o restauro da base de dados não é suportado quando a CMK ao nível da base de dados está configurada em pré-visualização.

  • 400 AzureKeyVaultNoServerIdentity – a identidade do servidor não está configurada corretamente.

  • 400 PerDatabaseCMKHSNotSupported – A CMK ao nível da base de dados em pré-visualização não é suportada para a edição Hyperscale.

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

  • 400 AzureKeyVaultMissingPermissions – o servidor tem as permissões necessárias em falta no Key Vault do Azure.

  • 400 UmiMissingAkvPermissions – PrimaryUserAssignedIdentityId fornecido pelo utilizador não tem acesso ao KeyId fornecido

  • 400 AkvEndpointNotReachableFromNode – o ponto final AKV "{0}" não está acessível a partir do SQL, no servidor "{1}".

  • 400 SecurityAzureKeyVaultInvalidKeyName – não foi possível concluir a operação devido a um nome de Chave de Servidor inválido.

  • 400 AdalGenericError – não foi possível concluir a operação porque foi encontrado um erro do Azure Active Directory.

  • 400 AdalServicePrincipalNotFound – não foi possível concluir a operação porque não foi encontrado um erro de Principal de Serviço da biblioteca do Azure Active Directory.

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

  • 400 SecurityAzureKeyVaultGeoChainError – a criação de uma secundária secundária (um processo conhecido como encadeamento) não é suportada ao ativar a Encriptação de Dados Transparente com o Azure Key Vault (BYOK).

  • 400 PerDatabaseCMKDWNotSupported - A CMK ao nível da base de dados em pré-visualização não é suportada para a edição Datawarehouse.

  • 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado

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

  • 404 ResourceNotFound – o recurso pedido não foi encontrado.

  • 404 OperationIdNotFound – a operação com o ID não existe.

  • 409 ServerKeyNameAlreadyExists – a chave de servidor já existe no servidor.

  • 409 ServerKeyUriAlreadyExists – o URI da chave de servidor já existe no servidor.

  • 409 ServerKeyDoesNotExists – a chave de servidor não existe.

  • 409 AzureKeyVaultKeyNameNotFound – não foi possível concluir a operação porque o nome da Chave de Key Vault do Azure não existe.

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

  • 409 ServerKeyNameAlreadyExists – a chave de servidor já existe no servidor.

  • 409 ServerKeyUriAlreadyExists – o URI da chave de servidor já existe no servidor.

  • 409 ServerKeyDoesNotExists – a chave de servidor não existe.

  • 409 AzureKeyVaultKeyNameNotFound – não foi possível concluir a operação porque o nome da Chave de Key Vault do Azure não existe.

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

  • 409 OperationCancelled - A operação foi cancelada pelo utilizador.

  • 409 OperationInterrupted - Não foi possível concluir a operação no recurso porque foi interrompida por outra operação no mesmo recurso.

  • 429 SubscriptionTooManyCreateUpdateRequests – pedidos para além do máximo de pedidos que podem ser processados por recursos disponíveis.

  • 429 SubscriptionTooManyRequests – pedidos para além do máximo de pedidos que podem ser processados por recursos disponíveis.

  • 500 OperationTimedOut – a operação excedeu o limite de tempo e foi revertida automaticamente. Repita a operação.

  • 503 AzureKeyVaultConnectionFailed – Não foi possível concluir a operação no servidor porque as tentativas de ligação ao Azure Key Vault falharam

  • 503 AzureKeyVaultGenericConnectionError – não foi possível concluir a operação porque foi encontrado um erro ao tentar obter Key Vault informações .

  • 503 AzureKeyVaultConnectionFailed – Não foi possível concluir a operação no servidor porque as tentativas de ligação ao Azure Key Vault falharam

  • 503 AzureKeyVaultGenericConnectionError – não foi possível concluir a operação porque foi encontrado um erro ao tentar obter Key Vault informações .

  • 503 TooManyRequests – pedidos para além do máximo de pedidos que podem ser processados 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

Name Description
ServerKey

Uma chave de servidor.
ServerKeyType

O tipo de chave de servidor, como "ServiceManaged", "AzureKeyVault".

ServerKey

Uma chave de servidor.

Name Tipo Description
id

string

ID do Recurso.
kind

string

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

string

Localização do recurso.
name

string

Nome do recurso.
properties.autoRotationEnabled

boolean

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

string

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

ServerKeyType

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

string

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

string

Thumbprint da chave do servidor.
properties.uri

string

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

string

Tipo de recurso.

ServerKeyType

O tipo de chave de servidor, como "ServiceManaged", "AzureKeyVault".

Name Tipo Description
AzureKeyVault

string

ServiceManaged

string