Managed Instance Keys - List By Instance

Dienst:

SQL Database

API-Version:

2021-11-01

Ruft eine Liste der verwalteten instance Schlüssel ab.

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

Mit optionalen Parametern:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/keys?$filter={$filter}&api-version=2021-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
managedInstanceName	path	True	string	Der Name der verwalteten Instanz.
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.
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.
$filter	query		string	Ein OData-Filterausdruck, der Elemente in der Auflistung filtert.

Antworten

Name	Typ	Beschreibung
200 OK	ManagedInstanceKeyListResult	Die Liste der verwalteten instance Schlü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.

Beispiele

List the keys for a managed instance.

Beispielanforderung

HTTP

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

Java

/**
 * Samples for ManagedInstanceKeys ListByInstance.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedInstanceKeyList.json
     */
    /**
     * Sample code: List the keys for a managed instance.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listTheKeysForAManagedInstance(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedInstanceKeys().listByInstance("sqlcrudtest-7398",
            "sqlcrudtest-4645", null, com.azure.core.util.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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/managedInstances/keys",
      "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/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/managedInstances/keys",
      "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/managedInstances/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/managedInstances/keys",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Definitionen

Name	Beschreibung
ManagedInstanceKey	Ein verwalteter instance Schlüssel.
ManagedInstanceKeyListResult	Eine Liste mit verwalteten instance Schlüsseln.
ServerKeyType	Der Schlüsseltyp wie "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

Ein verwalteter instance Schlüssel.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
kind	string	Art der Verschlüsselungsschutzvorrichtung. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden.
name	string	Name der Ressource.
properties.autoRotationEnabled	boolean	Aktivierungsflag für die automatische Schlüsselrotation. Entweder true oder false.
properties.creationDate	string	Das Datum der Schlüsselerstellung.
properties.serverKeyType	ServerKeyType	Der Schlüsseltyp wie "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Fingerabdruck des Schlüssels.
properties.uri	string	Der URI des Schlüssels. Wenn serverKeyType AzureKeyVault ist, ist der URI erforderlich.
type	string	Der Ressourcentyp.

ManagedInstanceKeyListResult

Eine Liste mit verwalteten instance Schlüsseln.

Name	Typ	Beschreibung
nextLink	string	Link zum Abrufen der nächsten Ergebnisseite.
value	ManagedInstanceKey[]	Array von Ergebnissen.

ServerKeyType

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

Name	Typ	Beschreibung
AzureKeyVault	string
ServiceManaged	string