Server Keys - Create Or Update

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-02-01-preview

Parâmetros do URI

Name In Required Type Description
keyName
path True
  • string

O nome da chave do servidor a operar (atualizado ou criado). O nome-chave deve estar no formato de "vault_key_version". Por exemplo, se o keyId for https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion , então 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 Gestor de Recursos Azure ou do portal.

serverName
path True
  • string

O nome do servidor.

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 chave do servidor como 'ServiceManaged', 'AzureKeyVault'.

properties.uri
  • string

O URI da chave do servidor. Se o ServerKeyType for AzureKeyVault, então o URI é necessário.

Respostas

Name Type Description
200 OK

Atualizou com sucesso a chave do servidor.

201 Created

Criou com sucesso a chave do servidor.

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 criação 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 criar não existe ou não tem nenhum objeto de propriedade.

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

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri key vault 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 inesperada do Cofre de Chaves 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 da chave Azure Key Vault é inválida.

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

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

  • 400 AzureKeyVaultInvalidUri - Uma resposta inválida do Cofre da Chave Azure. Por favor, utilize um Cofre de Chave Azure válido URI.

  • 400 AzureKeyVaultMissingPermissions - Falta o servidor com permissões necessárias no Cofre da Chave Azure.

  • 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 do Diretório Azure Ative.

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque um Diretor de Serviço de Biblioteca Azure Ative Não encontrou erro.

  • 400 AzureKeyVaultMalformedVaultUri - O uri key vault fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError - Criar secundário de secundário (um processo conhecido como chaining) não é suportado ao permitir a encriptação de dados transparente usando o Cofre da Chave Azure (BYOK).

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

  • 400 SecurityInvalidAzureKeyVaultRecoveryLevel - O uri key vault 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 inesperada do Cofre de Chaves 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 da chave Azure Key Vault é inválida.

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

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

  • 400 AzureKeyVaultInvalidUri - Uma resposta inválida do Cofre da Chave Azure. Por favor, utilize um Cofre de Chave Azure válido URI.

  • 400 AzureKeyVaultMissingPermissions - Falta o servidor com permissões necessárias no Cofre da Chave Azure.

  • 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 do Diretório Azure Ative.

  • 400 AdalServicePrincipalNotFound - A operação não pôde ser concluída porque um Diretor de Serviço de Biblioteca Azure Ative Não encontrou erro.

  • 400 AzureKeyVaultMalformedVaultUri - O uri key vault fornecido não é válido.

  • 400 SecurityAzureKeyVaultGeoChainError - Criar secundário de secundário (um processo conhecido como chaining) não é suportado ao permitir a encriptação de dados transparente usando o Cofre da Chave Azure (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.

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

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

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

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

  • 409 ServerKeyUriAlreadyExists - A chave do 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 da 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 Cofre da Chave Azure falharam

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

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

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

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-02-01-preview
{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

Sample Response

{
  "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
  }
}
{
  "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
  }
}

Definições

ServerKey

Uma chave do servidor.

ServerKeyType

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

ServerKey

Uma chave do servidor.

Name Type Description
id
  • string

Identificação de recursos.

kind
  • string

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

location
  • string

Localização de recursos.

name
  • string

Nome de recurso.

properties.autoRotationEnabled
  • boolean

Chave de rotação automática de opt-in bandeira. Ou verdadeiro ou falso.

properties.creationDate
  • string

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

properties.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 o ServerKeyType for AzureKeyVault, então o URI é necessário.

type
  • string

Tipo de recurso.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string