Server Keys - List By Server

Service:

SQL Database

API Version:

2021-11-01

Pobiera listę kluczy serwera.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServerKeyListResult	Pomyślnie pobrano listę kluczy serwera.
Other Status Codes		Odpowiedzi na błędy: *** 400 InvalidKeyName — podano nieprawidłową wartość dla nazwy klucza serwera. 400 InvalidKeyType — typ klucza serwera tworzenia nie jest obsługiwany. 400 InvalidUpsertKeyType — klucze TDE zarządzane przez usługę są zarządzane przez usługę. Klucze TDE zarządzane przez usługę nie obsługują tworzenia ani aktualizowania przez użytkownika. 400 InvalidKeyUpsertRequest — żądanie klucza serwera tworzenia nie istnieje lub nie ma obiektu właściwości. 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

Przykłady

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": {}
    }
  ]
}

Definicje

Nazwa	Opis
ServerKey	Klucz serwera.
ServerKeyListResult	Lista kluczy serwera.
ServerKeyType	Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

ServerKey

Klucz serwera.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj ochrony szyfrowania. Są to metadane używane w środowisku Azure Portal.
location	string	Lokalizacja zasobu.
name	string	Nazwa zasobu.
properties.autoRotationEnabled	boolean	Flaga automatycznego obrotu klucza. Prawda lub fałsz.
properties.creationDate	string	Data utworzenia klucza serwera.
properties.serverKeyType	ServerKeyType	Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Podregion klucza serwera.
properties.thumbprint	string	Odcisk palca klucza serwera.
properties.uri	string	Identyfikator URI klucza serwera. Jeśli parametr ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI usługi AKV musi być w tym formacie: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type	string	Typ zasobu.

ServerKeyListResult

Lista kluczy serwera.

Nazwa	Typ	Opis
nextLink	string	Link, aby pobrać następną stronę wyników.
value	ServerKey[]	Tablica wyników.

ServerKeyType

Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

Nazwa	Typ	Opis
AzureKeyVault	string
ServiceManaged	string