Server Keys - Get

Service:

SQL Database

API Version:

2021-11-01

Ruft einen Serverschlüssel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
keyName	path	True	string	Der Name des abzurufenden Serverschlüssels.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
serverName	path	True	string	Name des Servers
subscriptionId	path	True	string	Abonnement-ID für ein Azure-Abonnement.
api-version	query	True	string	API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ServerKey	Der angegebene Serverschlüssel wurde erfolgreich abgerufen.
Other Status Codes		Fehlerantworten: *** 400 InvalidKeyName: Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben. 400 InvalidKeyType: Der Typ "Serverschlüssel erstellen" wird nicht unterstützt. 400 InvalidUpsertKeyType: Vom Dienst verwaltete TDE-Schlüssel werden vom Dienst verwaltet. Vom Dienst verwaltete TDE-Schlüssel unterstützen das Erstellen oder Aktualisieren durch den Benutzer nicht. 400 InvalidKeyUpsertRequest: Die Anforderung zum Erstellen des Serverschlüssels ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 404 SubscriptionDoesNotHaveServer: Der angeforderte Server wurde nicht gefunden 404 ServerNotInSubscriptionResourceGroup: Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 ResourceNotFound: Die angeforderte Ressource wurde nicht gefunden.

Beispiele

Get the server key

Sample Request

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

Java

import com.azure.core.util.Context;

/** Samples for ServerKeys Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyGet.json
     */
    /**
     * Sample code: Get the server key.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().getWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901", 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

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

Definitionen

Name	Beschreibung
ServerKey	Ein Serverschlüssel.
ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".

ServerKey

Ein Serverschlüssel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
kind	string	Art von Verschlüsselungsschutz. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden.
location	string	Ressourcenspeicherort
name	string	Name der Ressource.
properties.autoRotationEnabled	boolean	Key Auto Rotation Opt-In Flag. Entweder true oder false.
properties.creationDate	string	Das Erstellungsdatum des Serverschlüssels.
properties.serverKeyType	ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Unterregion des Serverschlüssels.
properties.thumbprint	string	Fingerabdruck des Serverschlüssels.
properties.uri	string	Der URI des Serverschlüssels. Wenn ServerKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss das folgende Format aufweisen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Der Ressourcentyp.

ServerKeyType

Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".

Name	Typ	Beschreibung
AzureKeyVault	string
ServiceManaged	string