Server Keys - List By Server

Ottiene un elenco di chiavi del server.

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

Parametri dell'URI

Name In Required Type Description
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

Name Type Description
200 OK

È stato recuperato correttamente l'elenco delle chiavi del server.

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.

Esempio

List the server keys by server

Sample Request

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

Sample Response

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

Definizioni

ServerKey

Una chiave del server.

ServerKeyListResult

Elenco di chiavi del server.

ServerKeyType

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

ServerKey

Una chiave del server.

Name Type Description
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

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.

ServerKeyListResult

Elenco di chiavi del server.

Name Type Description
nextLink
  • string

Collegamento per recuperare la pagina successiva dei risultati.

value

Matrice di risultati.

ServerKeyType

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

Name Type Description
AzureKeyVault
  • string
ServiceManaged
  • string