Udostępnij za pośrednictwem


Server Keys - Get

Pobiera klucz serwera.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
keyName
path True

string

Nazwa klucza serwera do pobrania.

resourceGroupName
path True

string

Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.

serverName
path True

string

Nazwa serwera.

subscriptionId
path True

string

Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.

api-version
query True

string

Wersja interfejsu API do użycia dla żądania.

Odpowiedzi

Nazwa Typ Opis
200 OK

ServerKey

Pomyślnie pobrano określony klucz serwera.

Other Status Codes

Odpowiedzi na błędy: ***

  • 400 InvalidKeyName — podano nieprawidłową wartość dla nazwy klucza serwera.

  • 400 InvalidKeyType — typ klucza serwera tworzenia nie jest obsługiwany.

  • 400 InvalidUpsertKeyType — klucze TDE zarządzane przez usługę są zarządzane przez usługę. Klucze TDE zarządzane przez usługę nie obsługują tworzenia ani aktualizowania przez użytkownika.

  • 400 InvalidKeyUpsertRequest — żądanie tworzenia klucza serwera nie istnieje lub nie ma obiektu właściwości.

  • 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera

  • 404 ServerNotInSubscriptionResourceGroup — określony serwer nie istnieje w określonej grupie zasobów i subskrypcji.

  • 404 ResourceNotFound — żądany zasób nie został znaleziony.

Przykłady

Get the server key

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
ServerKey

Klucz serwera.

ServerKeyType

Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

ServerKey

Klucz serwera.

Nazwa Typ Opis
id

string

Identyfikator zasobu.

kind

string

Rodzaj ochrony szyfrowania. Są to metadane używane w środowisku Azure Portal.

location

string

Lokalizacja zasobu.

name

string

Nazwa zasobu.

properties.autoRotationEnabled

boolean

Flaga zgody na automatyczne obracanie kluczy. Prawda lub fałsz.

properties.creationDate

string

Data utworzenia klucza serwera.

properties.serverKeyType

ServerKeyType

Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

properties.subregion

string

Podregion klucza serwera.

properties.thumbprint

string

Odcisk palca klucza serwera.

properties.uri

string

Identyfikator URI klucza serwera. Jeśli parametr ServerKeyType to AzureKeyVault, wymagany jest identyfikator URI. Identyfikator URI usługi AKV musi mieć następujący format: "https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion"

type

string

Typ zasobu.

ServerKeyType

Typ klucza serwera, taki jak "ServiceManaged", "AzureKeyVault".

Nazwa Typ Opis
AzureKeyVault

string

ServiceManaged

string