Dela via

Encryption Protectors - Get

Tjänst:
SQL Database
API-version:
2025-01-01

Hämtar ett skydd för serverkryptering.

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

URI-parametrar

Name I Obligatorisk Typ Description
encryptionProtectorName
 path True

EncryptionProtectorName

Namnet på det krypteringsskydd som ska hämtas.
resourceGroupName
 path True

string

Namnet på resursgruppen som innehåller resursen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.
serverName
 path True

string

Namnet på servern.
subscriptionId
 path True

string

Det prenumerations-ID som identifierar en Azure-prenumeration.
api-version
 query True

string

DEN API-version som ska användas för begäran.

Svar

Name Typ Description
200 OK

EncryptionProtector

Det angivna serverkrypteringsskyddet har hämtats.
Other Status Codes

ErrorResponse

Felsvar: ***

  • 400 ManagedInstanceStoppingOrS toppad – Konfliktåtgärd som skickas när instansen är i stopptillstånd

  • 400 ManagedInstanceStarting – Konfliktåtgärd som skickas när instansen är i starttillstånd

  • 400 InvalidKeyName – Ett ogiltigt värde angavs för servernyckelnamnet.

  • 400 InvalidKeyType – typen skapa servernyckel stöds inte.

  • 400 InvalidUpsertKeyType – Tjänsthanterade TDE-nycklar hanteras av tjänsten. Tjänsthanterade TDE-nycklar stöder inte skapa eller uppdatera av användaren.

  • 400 InvalidKeyUpsertRequest – Begäran om att skapa servernyckeln finns inte eller har inget egenskapsobjekt.

  • 400 InvalidEncryptionProtectorName – nyckelnamnet för krypteringsskydd stöds inte.

  • 404 ServerNotInSubscriptionResourceGroup – Den angivna servern finns inte i den angivna resursgruppen och prenumerationen.

  • 404 SubscriptionDoesNotHaveServer – Den begärda servern hittades inte

  • 404 ResourceNotFound – Den begärda resursen hittades inte.

Exempel

Get the encryption protector
Get the encryption protector with versionless key

Get the encryption protector

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey_01234567890123456789012345678901",
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
    "autoRotationEnabled": false
  }
}

Get the encryption protector with versionless key

Exempelbegäran

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

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/encryptionProtector/current",
  "name": "current",
  "type": "Microsoft.Sql/servers/encryptionProtector",
  "location": "Japan East",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyName": "someVault_someKey",
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey",
    "autoRotationEnabled": false,
    "keyVersion": "01234567890123456789012345678901"
  }
}

Definitioner

Name Description
EncryptionProtector

Serverkrypteringsskyddet.
EncryptionProtectorName

Namnet på det krypteringsskydd som ska hämtas.
ErrorAdditionalInfo

Resurshanteringsfelet ytterligare information.
ErrorDetail

Detaljerna om felet.
ErrorResponse

Felsvar
ServerKeyType

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

EncryptionProtector

Objekt

Serverkrypteringsskyddet.

Name Typ Description
id

string

Resursidentifikator.
kind

string

Typ av krypteringsskydd. Det här är metadata som används för Azure-portalen.
location

string

Resursplats.
name

string

Resursnamn.
properties.autoRotationEnabled

boolean

Opt-in-flagga för automatisk rotation av nycklar. Antingen sant eller falskt.
properties.keyVersion

string

Den version av servernyckeln som används som krypteringsskydd
properties.serverKeyName

string

Namnet på servernyckeln.
properties.serverKeyType

ServerKeyType

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".
properties.subregion

string

Underregion för krypteringsskyddet.
properties.thumbprint

string

Tumavtryck för servernyckeln.
properties.uri

string

URI:n för servernyckeln.
type

string

Resurstyp.

EncryptionProtectorName

Uppräkning

Namnet på det krypteringsskydd som ska hämtas.

Värde Description
current

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.

ServerKeyType

Uppräkning

Krypteringsskyddstypen som "ServiceManaged", "AzureKeyVault".

Värde Description
ServiceManaged
AzureKeyVault