Server Keys - Get

Service:

SQL Database

API Version:

2021-11-01

Ottiene una chiave del server.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
keyName	path	True	string	Nome della chiave del server da recuperare.
resourceGroupName	path	True	string	Nome del gruppo di risorse contenente la risorsa. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
serverName	path	True	string	Nome del server.
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.

Risposte

Nome	Tipo	Descrizione
200 OK	ServerKey	È stata recuperata correttamente la chiave del server specificata.
Other Status Codes		Risposte di errore: 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 del server non esiste o non ha alcun oggetto proprietà. 404 SubscriptionDoesNotHaveServer - Il server richiesto non è stato trovato 404 ServerNotInSubscriptionResourceGroup - Il server specificato non esiste nel gruppo di risorse e nella sottoscrizione specificati. 404 ResourceNotFound: la risorsa richiesta non è stata trovata.

Esempio

Get the server key

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for ServerKeys Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerKeyGet.json
     */
    /**
     * Sample code: Get the server key.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getTheServerKey(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerKeys().getWithResponse("sqlcrudtest-7398",
            "sqlcrudtest-4645", "someVault_someKey_01234567890123456789012345678901", 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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers/keys",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
    "creationDate": "2020-11-15T00:00:00Z",
    "autoRotationEnabled": false
  }
}

Definizioni

Nome	Descrizione
ServerKey	Una chiave del server.
ServerKeyType	Tipo di chiave del server, ad esempio 'ServiceManaged', 'AzureKeyVault'.

ServerKey

Una chiave del server.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di protezione di crittografia. Si tratta di metadati usati per l'esperienza di portale di Azure.
location	string	Percorso della risorsa.
name	string	Nome risorsa.
properties.autoRotationEnabled	boolean	Flag di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.creationDate	string	Data di creazione della chiave del server.
properties.serverKeyType	ServerKeyType	Tipo di chiave del server, ad esempio 'ServiceManaged', 'AzureKeyVault'.
properties.subregion	string	Sottoarea della chiave del server.
properties.thumbprint	string	Identificazione personale della chiave del server.
properties.uri	string	URI della chiave del server. Se ServerKeyType è AzureKeyVault, è necessario l'URI. L'URI AKV deve essere in questo formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Tipo di risorsa.

ServerKeyType

Tipo di chiave del server, ad esempio 'ServiceManaged', 'AzureKeyVault'.

Nome	Tipo	Descrizione
AzureKeyVault	string
ServiceManaged	string