Condividi tramite

Server Keys - List By Server

Servizio:
SQL Database
Versione API:
2025-01-01

Ottiene un elenco di chiavi del server.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
serverName
 path True

string

Il nome del server.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

ServerKeyListResult

Operazione Azure completata con successo.
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

List the server keys by server

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
200 
{
  "value": [
    {
      "name": "someVault_someKey_01234567890123456789012345678901",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
      "kind": "azurekeyvault",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "creationDate": "2024-11-15T00:00:00Z",
        "thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD"
      }
    },
    {
      "name": "myVault_myKey_11111111111111111111111111111111",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/myVault_myKey_11111111111111111111111111111111",
      "kind": "azurekeyvault",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "AzureKeyVault",
        "creationDate": "2024-11-15T00:00:00Z",
        "thumbprint": "AAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBB"
      }
    },
    {
      "name": "ServiceManaged",
      "type": "Microsoft.Sql/servers/keys",
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/ServiceManaged",
      "kind": "servicemanaged",
      "location": "Japan East",
      "properties": {
        "serverKeyType": "ServiceManaged"
      }
    }
  ]
}

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore
ServerKey

Una chiave del server.
ServerKeyListResult

La risposta di un'operazione di lista ServerKey.
ServerKeyType

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.

ServerKey

Oggetto

Una chiave del server.

Nome Tipo Descrizione
id

string (arm-id)

ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

Tipo di protezione della crittografia. Questi sono metadati utilizzati per l'esperienza del portale Azure.
location

string

Percorso della risorsa.
name

string

Nome della risorsa
properties.autoRotationEnabled

boolean

Flag di consenso esplicito per la rotazione automatica delle chiavi. True o false.
properties.creationDate

string (date-time)

Data di creazione della chiave del server.
properties.keyVersion

string

La versione della chiave del server.
properties.serverKeyType

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'UI AKV deve essere in questo formato: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' o può essere 'https://YourVaultName.vault.azure.net/keys/YourKeyName'
systemData

systemData

Azure Resource Manager metadati contenenti informazioni createBy e modifiedBy.
type

string

Tipo di risorsa. Ad esempio: "Microsoft. Compute/virtualMachines" oppure "Microsoft. Storage/storageAccounts"

ServerKeyListResult

Oggetto

La risposta di un'operazione di lista ServerKey.

Nome Tipo Descrizione
nextLink

string (uri)

Il link alla pagina successiva degli elementi
value

ServerKey[]

Gli elementi ServerKey in questa pagina

ServerKeyType

Enumerazione

Tipo di protezione di crittografia come "ServiceManaged", "AzureKeyVault".

Valore Descrizione
ServiceManaged

ServiceManaged
AzureKeyVault

AzureKeyVault

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Il timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.