Managed Instance Keys - List By Instance

Servizio:

SQL Database

Versione API:

2023-08-01

Ottiene un elenco di chiavi di istanza gestita.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
managedInstanceName	path	True	string	Nome dell'istanza gestita.
resourceGroupName	path	True	string	Nome del gruppo di risorse che contiene la risorsa. È possibile ottenere questo valore dall'API di Azure Resource Manager o dal portale.
subscriptionId	path	True	string	ID sottoscrizione che identifica una sottoscrizione di Azure.
api-version	query	True	string	Versione dell'API da usare per la richiesta.
$filter	query		string	Espressione di filtro OData che filtra gli elementi nella raccolta.

Risposte

Nome	Tipo	Descrizione
200 OK	ManagedInstanceKeyListResult	È stato recuperato correttamente l'elenco delle chiavi dell'istanza gestita.
Other Status Codes	ErrorResponse	Risposte di errore: 400 ManagedInstanceStoppingOrStopped - Operazione in conflitto inviata mentre l'istanza è in stato di arresto/arresto 400 ManagedInstanceStarting - Operazione in conflitto inviata mentre l'istanza è in stato di avvio 400 InvalidKeyName- È stato assegnato un valore non valido per il nome della chiave del server. 400 InvalidKeyType: il tipo di chiave del server di creazione non è supportato. 400 InvalidUpsertKeyType: le chiavi TDE gestite dal servizio vengono gestite dal servizio. Le chiavi TDE gestite dal servizio non supportano La creazione o l'aggiornamento da parte dell'utente. 400 InvalidKeyUpsertRequest: la richiesta di creazione della chiave server non esiste o non dispone di alcun oggetto proprietà. 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato

Esempio

List the keys for a managed instance.

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ManagedInstanceKey	Chiave dell'istanza gestita.
ManagedInstanceKeyListResult	Elenco di chiavi dell'istanza gestita.
ServerKeyType	Tipo di chiave come "ServiceManaged", "AzureKeyVault".

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ManagedInstanceKey

Oggetto

Chiave dell'istanza gestita.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di protezione della crittografia. Si tratta di metadati usati per l'esperienza del portale di Azure.
name	string	Nome risorsa.
properties.autoRotationEnabled	boolean	Flag di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.creationDate	string (date-time)	Data di creazione della chiave.
properties.serverKeyType	ServerKeyType	Tipo di chiave come "ServiceManaged", "AzureKeyVault".
properties.thumbprint	string	Identificazione personale della chiave.
properties.uri	string	URI della chiave. Se ServerKeyType è AzureKeyVault, è necessario l'URI.
type	string	Tipo di risorsa.

ManagedInstanceKeyListResult

Oggetto

Elenco di chiavi dell'istanza gestita.

Nome	Tipo	Descrizione
nextLink	string	Collegamento per recuperare la pagina successiva dei risultati.
value	ManagedInstanceKey[]	Matrice di risultati.

ServerKeyType

Enumerazione

Tipo di chiave come "ServiceManaged", "AzureKeyVault".

Valore	Descrizione
ServiceManaged
AzureKeyVault