Server Keys - List By Server

  • Referência
Serviço:
SQL Database
Versão da API:
2021-11-01

Obtém uma lista de chaves do servidor.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
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.

Respostas

Nome Tipo Description
200 OK

ServerKeyListResult

Recuperou com êxito a lista de chaves do servidor.
Other Status Codes

Respostas de erro: ***

  • 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 SubscriptionDoesNotHaveServer – O servidor solicitado não foi encontrado

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

Exemplos

List the server keys by server

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?api-version=2021-11-01

Resposta de exemplo

Código de status:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "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/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "azurekeyvault",
      "properties": {
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB",
        "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/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Definições

Nome Description
ServerKey

Uma chave do servidor.
ServerKeyListResult

Uma lista de chaves do servidor.
ServerKeyType

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

ServerKey

Uma chave do 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 de 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 chave. Verdadeiro ou falso.
properties.creationDate

string

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

string

Tipo de recurso.

ServerKeyListResult

Uma lista de chaves do servidor.

Nome Tipo Description
nextLink

string

Link para recuperar a próxima página de resultados.
value

ServerKey[]

Matriz de resultados.

ServerKeyType

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

Nome Tipo Description
AzureKeyVault

string

ServiceManaged

string