Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Hämtar en lista över hanterade instansnycklar.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
managedInstanceName	path	True	string	Namnet på den hanterade instansen.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
subscriptionId	path	True	string	Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version	query	True	string	DEN API-version som ska användas för begäran.
$filter	query		string	Ett OData-filteruttryck som filtrerar element i samlingen.

Svar

Name	Typ	Description
200 OK	ManagedInstanceKeyListResult	Listan över hanterade instansnycklar har hämtats.
Other Status Codes		Felsvar: *** 400 InvalidKeyName – ett ogiltigt värde angavs för servernyckelnamnet. 400 InvalidKeyType – Nyckeltypen Skapa server stöds inte. 400 InvalidUpsertKeyType – Tjänsthanterade TDE-nycklar hanteras av tjänsten. Tjänsthanterade TDE-nycklar stöder inte skapa eller uppdatera av användaren. 400 InvalidKeyUpsertRequest – Begäran om att skapa servernyckeln finns inte eller har inget egenskapsobjekt. 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

Exempel

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

Definitioner

Name	Description
ManagedInstanceKey	En hanterad instansnyckel.
ManagedInstanceKeyListResult	En lista över hanterade instansnycklar.
ServerKeyType	Nyckeltypen, till exempel "ServiceManaged", "AzureKeyVault".

ManagedInstanceKey

En hanterad instansnyckel.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av krypteringsskydd. Det här är metadata som används för Azure Portal upplevelse.
name	string	Resursnamn.
properties.autoRotationEnabled	boolean	Opt-in-flagga för automatisk rotation av nycklar. Antingen sant eller falskt.
properties.creationDate	string	Datumet då nyckeln skapades.
properties.serverKeyType	ServerKeyType	Nyckeltypen, till exempel "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Tumavtryck för nyckeln.
properties.uri	string	Nyckelns URI. Om ServerKeyType är AzureKeyVault krävs URI:n.
type	string	Resurstyp.

ManagedInstanceKeyListResult

En lista över hanterade instansnycklar.

Name	Typ	Description
nextLink	string	Länk för att hämta nästa sida med resultat.
value	ManagedInstanceKey[]	Matris med resultat.

ServerKeyType

Nyckeltypen, till exempel "ServiceManaged", "AzureKeyVault".

Name	Typ	Description
AzureKeyVault	string
ServiceManaged	string