Dela via

Server Keys - Get

  • Referens
Tjänst:
SQL Database
API-version:
2023-08-01

Hämtar en servernyckel.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2023-08-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

ErrorResponse

Felsvar: ***

  • 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd

  • 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd

  • 400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet.

  • 400 InvalidKeyType – typen skapa servernyckel 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 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

  • 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte

  • 404 ResourceNotFound – Den begärda resursen hittades inte.

Exempel

Get the server key

Exempelbegäran

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=2023-08-01

Exempelsvar

Statuskod:
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
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar
ServerKey

En servernyckel.
ServerKeyType

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

ServerKey

Objekt

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-portalen.
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 (date-time)

Datum då servernyckeln skapades.
properties.serverKeyType

ServerKeyType

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".
properties.subregion

string

Underregion för servernyckeln.
properties.thumbprint

string

Tumavtryck för servernyckeln.
properties.uri

string

URI:n för servernyckeln. Om ServerKeyType är AzureKeyVault krävs URI:n. AKV-URI:n måste vara i det här formatet: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"
type

string

Resurstyp.

ServerKeyType

Uppräkning

Servernyckeltypen som "ServiceManaged", "AzureKeyVault".

Värde Description
AzureKeyVault
ServiceManaged