Server Keys - Get

Serviço:: SQL Database

Versão da API:: 2025-01-01

Obtém uma chave de servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
keyName	path	True	string	O nome da chave do servidor a ser recuperada.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	ServerKey	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get the server key

Get the server key with versionless key

Get the server key

Pedido de amostra

HTTP

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=2025-01-01

Resposta da amostra

Código de estado:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "location": "Japan East",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "creationDate": "2024-11-15T00:00:00Z",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

Get the server key with versionless key

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "kind": "azurekeyvault",
  "location": "Japan East",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "creationDate": "2024-11-15T00:00:00Z",
    "keyVersion": "01234567890123456789012345678901",
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
  }
}

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ServerKey	Uma chave de servidor.
ServerKeyType	O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ServerKey

Object

Uma chave de servidor.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de protetor de criptografia. Estes são metadados usados para a experiência do portal Azure.
location	string	Localização do recurso.
name	string	O nome do recurso
properties.autoRotationEnabled	boolean	Sinalizador de opção de rotação automática de chave. Verdadeiro ou falso.
properties.creationDate	string (date-time)	A data de criação da chave do servidor.
properties.keyVersion	string	A versã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 AKV deve estar neste formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' ou pode ser 'https://YourVaultName.vault.azure.net/keys/YourKeyName'
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft. Computação/Máquinas Virtuais" ou "Microsoft. ContasArmazenamento/Armazenamento"

ServerKeyType

Enumeração

O tipo de protetor de criptografia como 'ServiceManaged', 'AzureKeyVault'.

Valor	Description
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Server Keys - Get

Parâmetros do URI

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

Get the server key

Pedido de amostra

Resposta da amostra

Get the server key with versionless key

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerKey

ServerKeyType

systemData