Server Keys - List By Server

Tjänst:: SQL Database

API-version:: 2025-01-01

Hämtar en lista över servernycklar.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serverName	path	True	string	Namnet på servern.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	ServerKeyListResult	Azure-operationen slutfördes framgångsrikt.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List the server keys by server

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Resurshanteringsfelet ytterligare information.
ErrorDetail	Detaljerna om felet.
ErrorResponse	Felsvar
ServerKey	En servernyckel.
ServerKeyListResult	Svaret från en ServerKey-listoperation.
ServerKeyType	Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".
systemData	Metadata som rör skapande och senaste ändring av resursen.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objekt

Resurshanteringsfelet ytterligare information.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Detaljerna om felet.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felet objektet.

ServerKey

Objekt

En servernyckel.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. T.ex. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Typ av krypteringsskydd. Detta är metadata som används för Azure-portalupplevelsen.
location	string	Resursplats.
name	string	Namnet på resursen
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.keyVersion	string	Versionen av servernyckeln.
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' eller kan vara 'https://YourVaultName.vault.azure.net/keys/YourKeyName'
systemData	systemData	Azure Resource Manager-metadata som innehåller creationBy och modifiedBy-information.
type	string	Resurstypen. T.ex. "Microsoft. Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

ServerKeyListResult

Objekt

Svaret från en ServerKey-listoperation.

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	ServerKey[]	ServerKey-elementen på denna sida

ServerKeyType

Uppräkning

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

Värde	Description
ServiceManaged	ServiceManaged
AzureKeyVault	AzureKeyVault

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.