Server Keys - Get

Service:

SQL Database

API Version:

2021-11-01

Hämtar en servernyckel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
keyName	path	True	string	Namnet på den servernyckel som ska hämtas.
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.
serverName	path	True	string	Namnet på servern.
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.

Svar

Name	Typ	Description
200 OK	ServerKey	Den angivna servernyckeln 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. 404 ResourceNotFound – Den begärda resursen hittades inte.

Exempel

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
  }
}

Definitioner

Name	Description
ServerKey	En servernyckel.
ServerKeyType	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

ServerKey

En servernyckel.

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.
location	string	Resursplats.
name	string	Resursnamn.
properties.autoRotationEnabled	boolean	Opt-in-flagga för automatisk rotation av nycklar. Antingen sant eller falskt.
properties.creationDate	string	Datum då servernyckeln skapades.
properties.serverKeyType	ServerKeyType	Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.subregion	string	Servernyckelns underregion.
properties.thumbprint	string	Tumavtryck för servernyckeln.
properties.uri	string	URI för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste ha följande format: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type	string	Resurstyp.

ServerKeyType

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

Name	Typ	Description
AzureKeyVault	string
ServiceManaged	string