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

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

EncryptionProtector

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

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

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

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.
EncryptionProtector

Serverkrypteringsskyddet.
EncryptionProtectorName
ErrorAdditionalInfo

Resurshanteringsfelet ytterligare information.
ErrorDetail

Detaljerna om felet.
ErrorResponse

Felsvar
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

EncryptionProtector

Objekt

Serverkrypteringsskyddet.

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.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.
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"

EncryptionProtectorName

Uppräkning
Värde Description
current

ström

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

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.