Managed Instance Keys - List By Instance

Service:

SQL Database

API Version:

2021-11-01

Obtient une liste de clés de instance managées.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
managedInstanceName	path	True	string	Nom de l'instance managée.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.
$filter	query		string	Expression de filtre OData qui filtre les éléments de la collection.

Réponses

Nom	Type	Description
200 OK	ManagedInstanceKeyListResult	Récupération réussie de la liste des clés de instance managées.
Other Status Codes		Réponses d’erreur : *** 400 InvalidKeyName : une valeur non valide a été donnée pour le nom de clé du serveur. 400 InvalidKeyType : le type de clé de serveur create n’est pas pris en charge. 400 InvalidUpsertKeyType : les clés TDE gérées par le service sont gérées par le service. Les clés TDE gérées par le service ne prennent pas en charge la création ou la mise à jour par l’utilisateur. 400 InvalidKeyUpsertRequest : la demande de clé de serveur de création n’existe pas ou n’a pas d’objet de propriétés. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 ServerNotInSubscriptionResourceGroup : le serveur spécifié n’existe pas dans le groupe de ressources et l’abonnement spécifiés.

Exemples

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

Définitions

Nom	Description
ManagedInstanceKey	Clé de instance managée.
ManagedInstanceKeyListResult	Liste des clés de instance managées.
ServerKeyType	Type de clé comme « ServiceManaged », « AzureKeyVault ».

ManagedInstanceKey

Clé de instance managée.

Nom	Type	Description
id	string	ID de la ressource
kind	string	Type de protecteur de chiffrement. Il s’agit des métadonnées utilisées pour l’expérience Portail Azure.
name	string	Nom de la ressource.
properties.autoRotationEnabled	boolean	Indicateur d’option d’option de rotation automatique des touches. true ou false.
properties.creationDate	string	Date de création de la clé.
properties.serverKeyType	ServerKeyType	Type de clé comme « ServiceManaged », « AzureKeyVault ».
properties.thumbprint	string	Empreinte de la clé.
properties.uri	string	URI de la clé. Si ServerKeyType est AzureKeyVault, l’URI est requis.
type	string	Type de ressource.

ManagedInstanceKeyListResult

Liste des clés de instance managées.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	ManagedInstanceKey[]	Tableau de résultats.

ServerKeyType

Type de clé comme « ServiceManaged », « AzureKeyVault ».

Nom	Type	Description
AzureKeyVault	string
ServiceManaged	string