Server Keys - Create Or Update

Szolgáltatás:

MySQL

API-verzió:

2020-01-01

Létrehoz vagy frissít egy MySQL-kiszolgálókulcsot.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
keyName	path	True	string	Annak a MySQL-kiszolgálókulcsnak a neve, amelyen (frissítve vagy létrehozva) kell működnie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serverName	path	True	string	A kiszolgáló neve.
subscriptionId	path	True	string minLength: 1	A cél-előfizetés azonosítója.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.serverKeyType	True	ServerKeyType	A kulcs típusa, például az "AzureKeyVault".
properties.uri		string	A kulcs URI-ja.

Válaszok

Name	Típus	Description
200 OK	ServerKey	Sikeresen frissítette a MySQL-kiszolgálókulcsot.
202 Accepted	ServerKey	Folyamatban lévő művelet
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Példák

Creates or updates a MySQL Server key

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Állapotkód:

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

Definíciók

Name	Description
CloudError	Hibaválasz a Batch szolgáltatástól.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorResponse	Hibaválasz
ServerKey	MySQL-kiszolgálókulcs.
ServerKeyType	A kulcs típusa, például az "AzureKeyVault".

CloudError

Objektum

Hibaválasz a Batch szolgáltatástól.

Name	Típus	Description
error	ErrorResponse	Hibaválasz Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorResponse[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ServerKey

Objektum

MySQL-kiszolgálókulcs.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	string	A kulcs védelmére használt titkosítási védő típusa.
name	string	Az erőforrás neve
properties.creationDate	string (date-time)	A kulcs létrehozásának dátuma.
properties.serverKeyType	ServerKeyType	A kulcs típusa, például az "AzureKeyVault".
properties.uri	string	A kulcs URI-ja.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ServerKeyType

Enumerálás

A kulcs típusa, például az "AzureKeyVault".

Érték	Description
AzureKeyVault