Server Keys - Create Or Update

Servicio:

MySQL

Versión de la API:

2020-01-01

Crea o actualiza una clave del servidor MySQL.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
keyName	path	True	string	Nombre de la clave del servidor MySQL en la que se va a operar (actualizado o creado).
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serverName	path	True	string	Nombre del servidor.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.serverKeyType	True	ServerKeyType	Tipo de clave como "AzureKeyVault".
properties.uri		string	Identificador URI de la clave.

Respuestas

Nombre	Tipo	Description
200 OK	ServerKey	Se actualizó correctamente la clave del servidor MySQL.
202 Accepted	ServerKey	Operación en curso
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Ejemplos

Creates or updates a MySQL Server key

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901?api-version=2020-01-01

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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.rdbms.mysql import MySQLManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-rdbms
# USAGE
    python server_key_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MySQLManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ffffffff-ffff-ffff-ffff-ffffffffffff",
    )

    response = client.server_keys.begin_create_or_update(
        server_name="testserver",
        key_name="someVault_someKey_01234567890123456789012345678901",
        resource_group_name="testrg",
        parameters={
            "properties": {
                "serverKeyType": "AzureKeyVault",
                "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2020-01-01/examples/ServerKeyCreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.MySql.Models;
using Azure.ResourceManager.MySql;

// Generated from example definition: specification/mysql/resource-manager/Microsoft.DBforMySQL/legacy/stable/2020-01-01/examples/ServerKeyCreateOrUpdate.json
// this example is just showing the usage of "ServerKeys_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MySqlServerKeyResource created on azure
// for more information of creating MySqlServerKeyResource, please refer to the document of MySqlServerKeyResource
string subscriptionId = "ffffffff-ffff-ffff-ffff-ffffffffffff";
string resourceGroupName = "testrg";
string serverName = "testserver";
string keyName = "someVault_someKey_01234567890123456789012345678901";
ResourceIdentifier mySqlServerKeyResourceId = MySqlServerKeyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, keyName);
MySqlServerKeyResource mySqlServerKey = client.GetMySqlServerKeyResource(mySqlServerKeyResourceId);

// invoke the operation
MySqlServerKeyData data = new MySqlServerKeyData
{
    ServerKeyType = MySqlServerKeyType.AzureKeyVault,
    Uri = new Uri("https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901"),
};
ArmOperation<MySqlServerKeyResource> lro = await mySqlServerKey.UpdateAsync(WaitUntil.Completed, data);
MySqlServerKeyResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
MySqlServerKeyData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "omeVault_someKey_01234567890123456789012345678901",
  "type": "Microsoft.DBforMySQL/servers/keys",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
    "creationDate": "2017-05-01T00:00:00.0Z"
  }
}

status code:

202

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMySQL/servers/testserver/keys/someVault_someKey_01234567890123456789012345678901",
  "name": "omeVault_someKey_01234567890123456789012345678901",
  "type": "Microsoft.DBforMySQL/servers/keys",
  "kind": "azurekeyvault",
  "properties": {
    "serverKeyType": "AzureKeyVault",
    "uri": "https://someVault.vault.azure.net/keys/someKey/01234567890123456789012345678901",
    "creationDate": "2017-05-01T00:00:00.0Z"
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio Batch.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorResponse	Respuesta de error
ServerKey	Una clave del servidor MySQL.
ServerKeyType	Tipo de clave como "AzureKeyVault".

CloudError

Object

Respuesta de error del servicio Batch.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorResponse[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ServerKey

Object

Una clave del servidor MySQL.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	Tipo de protector de cifrado usado para proteger la clave.
name	string	Nombre del recurso
properties.creationDate	string (date-time)	Fecha de creación de la clave.
properties.serverKeyType	ServerKeyType	Tipo de clave como "AzureKeyVault".
properties.uri	string	Identificador URI de la clave.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ServerKeyType

Enumeración

Tipo de clave como "AzureKeyVault".

Valor	Description
AzureKeyVault