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

Name In Required Type Description
keyName
path True
  • string

O nome da chave do servidor a ser operada (atualizada ou criada). O nome da chave deve estar no formato "vault_key_version". Por exemplo, se a keyId for , o nome da https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion 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

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 ServerKeyType for AzureKeyVault, o URI será necessário.

Respostas

Name Type Description
200 OK

Atualização bem-sucedida da chave do servidor.

201 Created

A chave do servidor foi criada com êxito.

202 Accepted

Aceito

Other Status Codes

Respostas de erro: **_

_ 400 InvalidKeyName – Um valor inválido foi dado para o nome da chave do servidor.

  • 400 InvalidKeyType – Não há suporte para o tipo criar chave de servidor.

  • 400 InvalidUpsertKeyType – as chaves TDE gerenciadas pelo serviço são gerenciadas pelo serviço. As chaves TDE gerenciadas pelo serviço não são suportadas por criar ou atualizar pelo usuário.

  • 400 InvalidKeyUpsertRequest – a solicitação criar chave de servidor 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 Azure Key Vault principal expirou.

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

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

  • 400 AzureKeyVaultMismatchError – região Key Vault inesperada encontrada na resposta http.

  • 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 Azure Key Vault chave está desabilitada.

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

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

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

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

  • 400 AzureKeyVaultMissingPermissions – o servidor não tem as permissões necessárias no Azure Key Vault.

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

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

  • 400 AdalServicePrincipalNotFound – A operação não pôde ser concluída porque um erro de entidade de serviço Azure Active Directory biblioteca não encontrada foi encontrado.

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

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

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

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

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

  • 400 AzureKeyVaultMismatchError – região Key Vault inesperada encontrada na resposta http.

  • 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 Azure Key Vault chave está desabilitada.

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

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

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

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

  • 400 AzureKeyVaultMissingPermissions – o servidor não tem as permissões necessárias no Azure Key Vault.

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

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

  • 400 AdalServicePrincipalNotFound – A operação não pôde ser concluída porque um erro de entidade de serviço Azure Active Directory biblioteca não encontrada foi encontrado.

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

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

  • 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.

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

  • 409 AzureKeyVaultKeyInUse – a chave está sendo usada no momento pelo servidor.

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

  • 409 AzureKeyVaultKeyInUse – a chave está sendo usada no momento pelo servidor.

  • 503 AzureKeyVaultConnectionFailed – A operação não pôde ser concluída no servidor porque as tentativas de se conectar 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ções .

  • 503 AzureKeyVaultConnectionFailed – A operação não pôde ser concluída no servidor porque as tentativas de se conectar 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ções .

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 de servidor.

ServerKeyType

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

ServerKey

Uma chave de servidor.

Name Type Description
id
  • string

ID do recurso.

kind
  • string

Tipo de protetor de criptografia. São metadados usados para a portal do Azure experiência.

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

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.

type
  • string

Tipo de recurso.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string