Compartilhar via


Server Keys - Get

Obtém uma chave de servidor.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
keyName
path True

string

O nome da chave do servidor a ser recuperada.

resourceGroupName
path True

string

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

serverName
path True

string

O nome do servidor.

subscriptionId
path True

string

A ID da assinatura que identifica uma assinatura do Azure.

api-version
query True

string

A versão da API a ser usada para a solicitação.

Respostas

Nome Tipo Description
200 OK

ServerKey

Recuperou com êxito a chave do servidor especificada.

Other Status Codes

ErrorResponse

Respostas de erro: ***

  • 400 ManagedInstanceStoppingOrStopped – Operação conflitante enviada enquanto a instância está no estado de parada/parada

  • 400 ManagedInstanceStarting – Operação conflitante enviada enquanto a instância está no estado inicial

  • 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 criar 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 dão suporte a 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.

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

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

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

Exemplos

Get the server key

Solicitação de exemplo

GET 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=2023-08-01

Resposta de exemplo

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

Nome Description
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ServerKey

Uma chave de servidor.

ServerKeyType

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

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

ServerKey

Uma chave de servidor.

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

location

string

Local do recurso.

name

string

Nome do recurso.

properties.autoRotationEnabled

boolean

Sinalizador de aceitação de rotação automática de chaves. Verdadeiro ou falso.

properties.creationDate

string (date-time)

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 o ServerKeyType for AzureKeyVault, o URI será necessário. O URI do AKV é necessário para estar nesse formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'

type

string

Tipo de recurso.

ServerKeyType

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

Valor Description
ServiceManaged
AzureKeyVault