Delen via

Server Keys - Create Or Update

Service:
SQL Database
API-versie:
2025-01-01

Hiermee maakt of werkt u een serversleutel bij.

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

URI-parameters

Name In Vereist Type Description
keyName
 path True

string

De naam van de serversleutel die moet worden opgehaald.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is hoofdletterongevoelig.
serverName
 path True

string

De naam van de server.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
properties.serverKeyType True

ServerKeyType

Het serversleuteltype, zoals ServiceManaged, AzureKeyVault.
properties.uri

string

De URI van de serversleutel. Als het ServerKeyType AzureKeyVault is, is de URI vereist. De AKV-URI moet in dit formaat zijn: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' of kan ''https://YourVaultName.vault.azure.net/keys/YourKeyName zijn

Antwoorden

Name Type Description
200 OK

ServerKey

De update-operatie van de resource 'ServerKey' is geslaagd
201 Created

ServerKey

De aanmaakoperatie 'ServerKey' van de bron is geslaagd

Kopteksten

  • Location: string
  • Retry-After: integer
202 Accepted

Resourcebewerking geaccepteerd.

Kopteksten

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

Creates or updates a server key
Creates or updates a server key with versionless key

Creates or updates a server key

Voorbeeldaanvraag

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

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "name": "sqlcrudtest-4645",
  "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"
  }
}
Statuscode:
201 
{
  "name": "sqlcrudtest-4645",
  "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"
  }
}
Statuscode:
202

Creates or updates a server key with versionless key

Voorbeeldaanvraag

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

{
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "name": "sqlcrudtest-4645",
  "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"
  }
}
Statuscode:
201 
{
  "name": "sqlcrudtest-4645",
  "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"
  }
}
Statuscode:
202

Definities

Name Description
createdByType

Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
ServerKey

Een serversleutel.
ServerKeyType

Het type versleutelingsbeveiliging, zoals 'ServiceManaged', 'AzureKeyVault'.
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

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

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

ServerKey

Object

Een serversleutel.

Name Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
kind

string

Soort versleutelingsbeveiliging. Dit is metadata die wordt gebruikt voor de Azure-portaalervaring.
location

string

Resourcelocatie.
name

string

De naam van de resource
properties.autoRotationEnabled

boolean

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

string (date-time)

De aanmaakdatum van de serversleutel.
properties.keyVersion

string

De versie 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 in dit formaat zijn: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' of kan ''https://YourVaultName.vault.azure.net/keys/YourKeyName zijn
systemData

systemData

Azure Resource Manager metadata met creationBy en modifiedBy informatie.
type

string

Het type bron. Bijvoorbeeld: "Microsoft. Compute/virtualMachines" of "Microsoft. Opslag/opslagAccounts"

ServerKeyType

Opsomming

Het type versleutelingsbeveiliging, zoals 'ServiceManaged', 'AzureKeyVault'.

Waarde Description
ServiceManaged

ServiceManaged
AzureKeyVault

AzureKeyVault

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string (date-time)

Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.