Server Keys - List By Server

Dienst:

SQL Database

API-Version:

2023-08-01

Ruft eine Liste der Serverschlüssel ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
serverName	path	True	string	Der Name des Servers.
subscriptionId	path	True	string	Die Abonnement-ID, die ein Azure-Abonnement identifiziert.
api-version	query	True	string	Die API-Version, die für die Anforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ServerKeyListResult	Die Liste der Serverschlüssel wurde erfolgreich abgerufen.
Other Status Codes	ErrorResponse	Fehlerantworten: *** 400 ManagedInstanceStoppingOrStopped – Konfliktierender Vorgang, der während der Instanz beendet/beendet wird 400 ManagedInstanceStarting – Konfliktierender Vorgang, der während der Instanz im Startzustand liegt 400 InvalidKeyName – Für den Serverschlüsselnamen wurde ein ungültiger Wert angegeben. 400 InvalidKeyType – Der Serverschlüsseltyp 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 nicht das Erstellen oder Aktualisieren durch den Benutzer. 400 InvalidKeyUpsertRequest – Die Anforderung zum Erstellen von Serverschlüsseln ist nicht vorhanden oder weist kein Eigenschaftenobjekt auf. 404 ServerNotInSubscriptionResourceGroup – Der angegebene Server ist in der angegebenen Ressourcengruppe und dem angegebenen Abonnement nicht vorhanden. 404 SubscriptionDoesNotHaveServer – Der angeforderte Server wurde nicht gefunden.

Beispiele

List the server keys by server

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ServerKey	Ein Serverschlüssel.
ServerKeyListResult	Eine Liste der Serverschlüssel.
ServerKeyType	Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

ServerKey

Objekt

Ein Serverschlüssel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Verschlüsselungsschutzkomponente. Dies sind Metadaten, die für die Azure-Portaloberfläche verwendet werden.
location	string	Ressourcenspeicherort.
name	string	Ressourcenname.
properties.autoRotationEnabled	boolean	Kennzeichen für die automatische Drehung der Schlüsseldrehung. Entweder wahr oder falsch.
properties.creationDate	string (date-time)	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 der ServerKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss in diesem Format vorliegen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Ressourcentyp.

ServerKeyListResult

Objekt

Eine Liste der Serverschlüssel.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Seite mit Ergebnissen.
value	ServerKey[]	Array von Ergebnissen.

ServerKeyType

Enumeration

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

Wert	Beschreibung
AzureKeyVault
ServiceManaged