Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Získá seznam klíčů spravované instance.

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

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
managedInstanceName	path	True	string	Název spravované instance.
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje prostředek. Tuto hodnotu můžete získat z rozhraní API azure Resource Manager nebo z portálu.
subscriptionId	path	True	string	ID předplatného, které identifikuje předplatné Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít pro požadavek.
$filter	query		string	Výraz filtru OData, který filtruje prvky v kolekci.

Odpovědi

Name	Typ	Description
200 OK	ManagedInstanceKeyListResult	Seznam klíčů spravovaných instancí se úspěšně načetl.
Other Status Codes		Chybové odpovědi: *** 400 InvalidKeyName – pro název klíče serveru byla zadána neplatná hodnota. 400 InvalidKeyType – typ klíče pro vytvoření serveru není podporován. 400 InvalidUpsertKeyType – klíče transparentního šifrování dat spravované službou jsou spravované službou. Klíče transparentního šifrování dat spravované službou nepodporují vytvoření nebo aktualizaci uživatelem. 400 InvalidKeyUpsertRequest – požadavek na vytvoření klíče serveru neexistuje nebo nemá žádný objekt properties. 404 SubscriptionDoesNotHaveServer – požadovaný server nebyl nalezen. 404 ServerNotInSubscriptionResourceGroup – zadaný server neexistuje v zadané skupině prostředků a předplatném.

Příklady

List the keys for a managed instance.

Sample Request

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

import com.azure.core.util.Context;

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

Definice

Name	Description
ManagedInstanceKey	Klíč spravované instance.
ManagedInstanceKeyListResult	Seznam klíčů spravované instance.
ServerKeyType	Typ klíče, například ServiceManaged, AzureKeyVault.

ManagedInstanceKey

Klíč spravované instance.

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh ochrany šifrování. Toto jsou metadata používaná pro Azure Portal prostředí.
name	string	Název prostředku.
properties.autoRotationEnabled	boolean	Příznak automatického otočení klíče. Buď pravda, nebo nepravda.
properties.creationDate	string	Datum vytvoření klíče.
properties.serverKeyType	ServerKeyType	Typ klíče, například ServiceManaged, AzureKeyVault.
properties.thumbprint	string	Kryptografický otisk klíče.
properties.uri	string	Identifikátor URI klíče. Pokud je ServerKeyType AzureKeyVault, je identifikátor URI povinný.
type	string	Typ prostředku.

ManagedInstanceKeyListResult

Seznam klíčů spravované instance.

Name	Typ	Description
nextLink	string	Odkaz na načtení další stránky výsledků
value	ManagedInstanceKey[]	Pole výsledků

ServerKeyType

Typ klíče, například ServiceManaged, AzureKeyVault.

Name	Typ	Description
AzureKeyVault	string
ServiceManaged	string