Delen via

Server Keys - List By Server

  • Referentie
Service:
SQL Database
API-versie:
2023-08-01

Hiermee haalt u een lijst met serversleutels op.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
serverName
 path True

string

De naam van de server.
subscriptionId
 path True

string

De abonnements-id waarmee een Azure-abonnement wordt geïdentificeerd.
api-version
 query True

string

De API-versie die moet worden gebruikt voor de aanvraag.

Antwoorden

Name Type Description
200 OK

ServerKeyListResult

De lijst met serversleutels is opgehaald.
Other Status Codes

ErrorResponse

Foutreacties: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicterende bewerking verzonden terwijl het exemplaar de status gestopt/gestopt heeft

  • 400 ManagedInstanceStarting - Conflicterende bewerking verzonden terwijl het exemplaar de beginstatus heeft

  • 400 InvalidKeyName : er is een ongeldige waarde opgegeven voor de serversleutelnaam.

  • 400 InvalidKeyType : het type serversleutel maken wordt niet ondersteund.

  • 400 InvalidUpsertKeyType - Door de service beheerde TDE-sleutels worden beheerd door de service. Door de service beheerde TDE-sleutels bieden geen ondersteuning voor maken of bijwerken door de gebruiker.

  • 400 InvalidKeyUpsertRequest: de aanvraag voor de serversleutel maken bestaat niet of heeft geen eigenschappenobject.

  • 404 ServerNotInSubscriptionResourceGroup - Opgegeven server bestaat niet in de opgegeven resourcegroep en het opgegeven abonnement.

  • 404 SubscriptionDoesNotHaveServer - De aangevraagde server is niet gevonden

Voorbeelden

List the server keys by server

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
ServerKey

Een serversleutel.
ServerKeyListResult

Een lijst met serversleutels.
ServerKeyType

Het serversleuteltype, zoals ServiceManaged, AzureKeyVault.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ServerKey

Object

Een serversleutel.

Name Type Description
id

string

Resource-id.
kind

string

Soort versleutelingsbeveiliging. Dit zijn metagegevens die worden gebruikt voor de Azure Portal-ervaring.
location

string

Resourcelocatie.
name

string

Resourcenaam.
properties.autoRotationEnabled

boolean

Aanmeldingsvlag voor automatische rotatie van sleutels. Waar of onwaar.
properties.creationDate

string (date-time)

De aanmaakdatum van de serversleutel.
properties.serverKeyType

ServerKeyType

Het serversleuteltype, zoals ServiceManaged, AzureKeyVault.
properties.subregion

string

Subregio van de serversleutel.
properties.thumbprint

string

Vingerafdruk van de serversleutel.
properties.uri

string

De URI van de serversleutel. Als het ServerKeyType AzureKeyVault is, is de URI vereist. De AKV-URI moet deze indeling hebben: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion'
type

string

Resourcetype.

ServerKeyListResult

Object

Een lijst met serversleutels.

Name Type Description
nextLink

string

Koppeling om de volgende pagina met resultaten op te halen.
value

ServerKey[]

Matrix met resultaten.

ServerKeyType

Inventarisatie

Het serversleuteltype, zoals ServiceManaged, AzureKeyVault.

Waarde Description
AzureKeyVault
ServiceManaged