Server Keys - List By Server

Service:

SQL Database

API Version:

2021-11-01

Obtém uma lista de chaves de servidor.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	O ID da subscrição que identifica uma subscrição do Azure.
api-version	query	True	string	A versão da API a utilizar para o pedido.

Respostas

Name	Tipo	Description
200 OK	ServerKeyListResult	Foi obtida com êxito a lista de chaves de servidor.
Other Status Codes		Respostas de Erro: *** 400 InvalidKeyName – foi atribuído um valor inválido para o nome da chave de servidor. 400 InvalidKeyType – o tipo de chave de servidor de criação não é suportado. 400 InvalidUpsertKeyType – as chaves TDE geridas pelo serviço são geridas pelo serviço. As chaves de Encriptação de Dados Transparente geridas pelo serviço não suportam Criar ou Atualizar pelo utilizador. 400 InvalidKeyUpsertRequest – o pedido de criação de chave de servidor não existe ou não tem nenhum objeto de propriedades. 404 SubscriptionDoesNotHaveServer – O servidor pedido não foi encontrado 404 ServerNotInSubscriptionResourceGroup - O servidor especificado não existe no grupo de recursos e na subscrição especificados.

Exemplos

List the server keys by server

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ServerKeys ListByServer. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyList.json
     */
    /**
     * Sample code: List the server keys by server.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheServerKeysByServer(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().listByServer("sqlcrudtest-7398",
            "sqlcrudtest-4645", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

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

Name	Description
ServerKey	Uma chave de servidor.
ServerKeyListResult	Uma lista de chaves de servidor.
ServerKeyType	O tipo de chave de servidor, como "ServiceManaged", "AzureKeyVault".

ServerKey

Uma chave de servidor.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de protetor de encriptação. Estes são os metadados utilizados para a experiência de portal do Azure.
location	string	Localização do recurso.
name	string	Nome do recurso.
properties.autoRotationEnabled	boolean	Sinalizador de opção ativa de ativação ativa da rotação automática de chaves. Verdadeiro ou falso.
properties.creationDate	string	A data de criação da chave de servidor.
properties.serverKeyType	ServerKeyType	O tipo de chave de servidor, como "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Sub-região da chave do servidor.
properties.thumbprint	string	Thumbprint da chave do servidor.
properties.uri	string	O URI da chave do servidor. Se ServerKeyType for AzureKeyVault, o URI é necessário. O URI do AKV tem de estar neste formato: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type	string	Tipo de recurso.

ServerKeyListResult

Uma lista de chaves de servidor.

Name	Tipo	Description
nextLink	string	Ligação para obter a página seguinte dos resultados.
value	ServerKey[]	Matriz de resultados.

ServerKeyType

O tipo de chave de servidor, como "ServiceManaged", "AzureKeyVault".

Name	Tipo	Description
AzureKeyVault	string
ServiceManaged	string