Managed Instance Keys - List By Instance

Obtient une liste de clés d’instance managée.

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

Paramètres URI

Nom Dans Obligatoire Type Description
managedInstanceName
path True

string

Nom de l’instance managée.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.

subscriptionId
path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.

api-version
query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

$filter
query

string

Expression de filtre OData qui filtre les éléments de la collection.

Réponses

Nom Type Description
200 OK

ManagedInstanceKeyListResult

Opération Azure terminée avec succès.

Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

List the keys for a managed instance.

Exemple de requête

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

Exemple de réponse

{
  "value": [
    {
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/managedInstances/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "autoRotationEnabled": false,
        "creationDate": "2020-11-15T00:00:00Z",
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
      }
    },
    {
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/managedInstances/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "kind": "azurekeyvault",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "autoRotationEnabled": false,
        "creationDate": "2020-11-15T00:00:00Z",
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB"
      }
    },
    {
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/managedInstances/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/keys/ServiceManaged",
      "kind": "servicemanaged",
      "properties": {
        "serverKeyType": "ServiceManaged"
      }
    }
  ]
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur

ManagedInstanceKey

Clé d’instance managée.

ManagedInstanceKeyListResult

La réponse d’une opération de liste ManagedInstanceKey.

ServerKeyType

Type de protecteur de chiffrement tel que « ServiceManaged », « AzureKeyVault ».

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.

type

string

Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d’erreur.

details

ErrorDetail[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

ManagedInstanceKey

Clé d’instance managée.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »

kind

string

Type de protecteur de chiffrement. Ce sont des métadonnées utilisées pour l’expérience du portail Azure.

name

string

Nom de la ressource

properties.autoRotationEnabled

boolean

Indicateur d’opt-in de rotation automatique de clé. True ou false.

properties.creationDate

string (date-time)

Date de création de clé.

properties.serverKeyType

ServerKeyType

Type de clé tel que « ServiceManaged », « AzureKeyVault ».

properties.thumbprint

string

Empreinte numérique de la touche.

properties.uri

string

URI de la clé. Si ServerKeyType est AzureKeyVault, l’URI est requis.

systemData

systemData

Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.

type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

ManagedInstanceKeyListResult

La réponse d’une opération de liste ManagedInstanceKey.

Nom Type Description
nextLink

string (uri)

Le lien vers la page suivante des éléments

value

ManagedInstanceKey[]

Les éléments ManagedInstanceKey sur cette page

ServerKeyType

Type de protecteur de chiffrement tel que « ServiceManaged », « AzureKeyVault ».

Valeur Description
ServiceManaged

ServiceManaged

AzureKeyVault

AzureKeyVault

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.