Sdílet prostřednictvím


Server Keys - List By Server

Získá seznam klíčů serveru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
path True

string

Název skupiny prostředků, která prostředek obsahuje. Tuto hodnotu můžete získat z rozhraní API Resource Manager Azure nebo z portálu.

serverName
path True

string

Název serveru.

subscriptionId
path True

string

ID předplatného, které identifikuje předplatné Azure.

api-version
query True

string

Verze rozhraní API, která se má použít pro požadavek.

Odpovědi

Name Typ Description
200 OK

ServerKeyListResult

Seznam klíčů serveru se úspěšně načetl.

Other Status Codes

Chybové odpovědi: ***

  • 400 InvalidKeyName – Pro název klíče serveru byla zadána neplatná hodnota.

  • 400 InvalidKeyType – Typ klíče pro vytvoření serveru není podporován.

  • 400 InvalidUpsertKeyType – klíče transparentního šifrování dat spravované službou spravuje služba. Klíče transparentního šifrování dat spravované službou nepodporují vytvoření nebo aktualizaci uživatelem.

  • 400 InvalidKeyUpsertRequest – požadavek na vytvoření klíče serveru neexistuje nebo nemá žádný objekt properties.

  • 404 SubscriptionDoesNotHaveServer – Požadovaný server se nenašel.

  • 404 ServerNotInSubscriptionResourceGroup – zadaný server v zadané skupině prostředků a předplatném neexistuje.

Příklady

List the server keys by server

Ukázkový požadavek

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

Ukázková odpověď

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "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/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "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/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "location": "Japan East",
      "kind": "servicemanaged",
      "properties": {}
    }
  ]
}

Definice

Name Description
ServerKey

Klíč serveru.

ServerKeyListResult

Seznam klíčů serveru.

ServerKeyType

Typ klíče serveru, například ServiceManaged, AzureKeyVault.

ServerKey

Klíč serveru.

Name Typ Description
id

string

ID prostředku.

kind

string

Druh ochrany šifrování. Jedná se o metadata používaná pro Azure Portal prostředí.

location

string

Umístění prostředku.

name

string

Název prostředku.

properties.autoRotationEnabled

boolean

Příznak výslovného souhlasu s obměnou klávesou. Buď true, nebo false.

properties.creationDate

string

Datum vytvoření klíče serveru.

properties.serverKeyType

ServerKeyType

Typ klíče serveru, například ServiceManaged, AzureKeyVault.

properties.subregion

string

Podoblast klíče serveru

properties.thumbprint

string

Kryptografický otisk klíče serveru.

properties.uri

string

Identifikátor URI klíče serveru. Pokud je parametr ServerKeyType AzureKeyVault, vyžaduje se identifikátor URI. Identifikátor URI AKV musí být v tomto formátu:https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion

type

string

Typ prostředku.

ServerKeyListResult

Seznam klíčů serveru.

Name Typ Description
nextLink

string

Odkaz na načtení další stránky výsledků

value

ServerKey[]

Pole výsledků

ServerKeyType

Typ klíče serveru, například ServiceManaged, AzureKeyVault.

Name Typ Description
AzureKeyVault

string

ServiceManaged

string