Server Keys - Create Or Update
Erstellt oder aktualisiert einen Serverschlüssel.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/keys/{keyName}?api-version=2021-11-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
key
|
path | True |
string |
Der Name des Serverschlüssels, auf dem betrieben (aktualisiert oder erstellt) werden soll. Der Schlüsselname muss das Format "vault_key_version" aufweisen. Wenn die keyId beispielsweise lautet https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion, sollte der Name des Serverschlüssels wie folgt formatiert werden: YourVaultName_YourKeyName_YourKeyVersion |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die die Ressource enthält. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden. |
server
|
path | True |
string |
Name des Servers |
subscription
|
path | True |
string |
Abonnement-ID für ein Azure-Abonnement. |
api-version
|
query | True |
string |
API-Version, die für die Anforderung verwendet werden soll. |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
properties.serverKeyType | True |
Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault". |
|
properties.uri |
string |
Der URI des Serverschlüssels. Wenn serverKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss das folgende Format aufweisen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Der Serverschlüssel wurde erfolgreich aktualisiert. |
|
201 Created |
Der Serverschlüssel wurde erfolgreich erstellt. |
|
202 Accepted |
Akzeptiert |
|
Other Status Codes |
Fehlerantworten: ***
|
Beispiele
Creates or updates a server key
Beispielanforderung
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=2021-11-01
{
"properties": {
"serverKeyType": "AzureKeyVault",
"uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"
}
}
Beispiel für eine Antwort
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/keys/someVault_someKey_01234567890123456789012345678901",
"name": "sqlcrudtest-4645",
"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/someVault_someKey_01234567890123456789012345678901",
"name": "sqlcrudtest-4645",
"type": "Microsoft.Sql/servers/keys",
"location": "Japan East",
"kind": "azurekeyvault",
"properties": {
"thumbprint": "00112233445566778899AABBCCDDEEFFAABBCCDD",
"creationDate": "2020-11-15T00:00:00Z",
"autoRotationEnabled": false
}
}
Definitionen
Name | Beschreibung |
---|---|
Server |
Ein Serverschlüssel. |
Server |
Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault". |
ServerKey
Ein Serverschlüssel.
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Ressourcen-ID |
kind |
string |
Art der Verschlüsselungsschutzvorrichtung. Dies sind Metadaten, die für die Azure-Portal-Benutzeroberfläche verwendet werden. |
location |
string |
Ressourcenspeicherort |
name |
string |
Name der Ressource. |
properties.autoRotationEnabled |
boolean |
Aktivierungsflag für die automatische Schlüsselrotation. Entweder true oder false. |
properties.creationDate |
string |
Das Erstellungsdatum des Serverschlüssels. |
properties.serverKeyType |
Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault". |
|
properties.subregion |
string |
Unterregion des Serverschlüssels. |
properties.thumbprint |
string |
Fingerabdruck des Serverschlüssels. |
properties.uri |
string |
Der URI des Serverschlüssels. Wenn serverKeyType AzureKeyVault ist, ist der URI erforderlich. Der AKV-URI muss das folgende Format aufweisen: 'https://YourVaultName.vault.azure.net/keys/YourKeyName/YourKeyVersion' |
type |
string |
Der Ressourcentyp. |
ServerKeyType
Der Serverschlüsseltyp wie "ServiceManaged", "AzureKeyVault".
Name | Typ | Beschreibung |
---|---|---|
AzureKeyVault |
string |
|
ServiceManaged |
string |