Sql Resources - Create Update Client Encryption Key

Referencia

Szolgáltatás:: Cosmos DB Resource Provider

API-verzió:: 2025-04-15

ClientEncryptionKey létrehozása vagy frissítése. Ezt az API-t olyan eszközökkel kell meghívni, mint az Azure PowerShell (nem közvetlenül).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/clientEncryptionKeys/{clientEncryptionKeyName}?api-version=2025-04-15

URI-paraméterek

Name	In	Kötelező	Típus	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB-adatbázisfiók neve.
clientEncryptionKeyName	path	True	string	Cosmos DB ClientEncryptionKey neve.
databaseName	path	True	string	Cosmos DB-adatbázis neve.
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.
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álandó API-verzió.

Kérelem törzse

Name	Típus	Description
createUpdateClientEncryptionKeyParameters	ClientEncryptionKeyCreateUpdateParameters	Az ügyfél titkosítási kulcsának megadásához szükséges paraméterek.

Válaszok

Name	Típus	Description
200 OK	ClientEncryptionKeyGetResults	Az ügyféltitkosítási kulcs létrehozása vagy frissítése sikeresen befejeződött.
202 Accepted		Az ügyféltitkosítási kulcs létrehozása vagy frissítése aszinkron módon fejeződik be. Fejlécek azure-AsyncOperation: string location: string

Name

Típus

Description

200 OK

ClientEncryptionKeyGetResults

Az ügyféltitkosítási kulcs létrehozása vagy frissítése sikeresen befejeződött.

202 Accepted

Az ügyféltitkosítási kulcs létrehozása vagy frissítése aszinkron módon fejeződik be.

Fejlécek

azure-AsyncOperation: string
location: string

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	Személyesítse meg a felhasználói fiókját

Példák

CosmosDBClientEncryptionKeyCreateUpdate

Mintakérelem

PUT https://management.azure.com/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName?api-version=2025-04-15

{
  "properties": {
    "resource": {
      "id": "cekName",
      "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256",
      "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==",
      "keyWrapMetadata": {
        "name": "customerManagedKey",
        "type": "AzureKeyVault",
        "value": "AzureKeyVault Key URL",
        "algorithm": "RSA-OAEP"
      }
    }
  }
}


import com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyCreateUpdateParameters;
import com.azure.resourcemanager.cosmos.models.ClientEncryptionKeyResource;
import com.azure.resourcemanager.cosmos.models.KeyWrapMetadata;

/**
 * Samples for SqlResources CreateUpdateClientEncryptionKey.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/
     * CosmosDBSqlClientEncryptionKeyCreateUpdate.json
     */
    /**
     * Sample code: CosmosDBClientEncryptionKeyCreateUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void cosmosDBClientEncryptionKeyCreateUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cosmosDBAccounts().manager().serviceClient().getSqlResources()
            .createUpdateClientEncryptionKey("rgName", "accountName", "databaseName", "cekName",
                new ClientEncryptionKeyCreateUpdateParameters().withResource(new ClientEncryptionKeyResource()
                    .withId("cekName").withEncryptionAlgorithm("AEAD_AES_256_CBC_HMAC_SHA256")
                    .withWrappedDataEncryptionKey("U3dhZ2dlciByb2Nrcw==".getBytes())
                    .withKeyWrapMetadata(new KeyWrapMetadata().withName("customerManagedKey").withType("AzureKeyVault")
                        .withValue("AzureKeyVault Key URL").withAlgorithm("RSA-OAEP"))),
                com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_sql_client_encryption_key_create_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 = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subId",
    )

    response = client.sql_resources.begin_create_update_client_encryption_key(
        resource_group_name="rgName",
        account_name="accountName",
        database_name="databaseName",
        client_encryption_key_name="cekName",
        create_update_client_encryption_key_parameters={
            "properties": {
                "resource": {
                    "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256",
                    "id": "cekName",
                    "keyWrapMetadata": {
                        "algorithm": "RSA-OAEP",
                        "name": "customerManagedKey",
                        "type": "AzureKeyVault",
                        "value": "AzureKeyVault Key URL",
                    },
                    "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.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

package armcosmos_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cosmos/armcosmos/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/011ecc5633300a5eefe43dde748f269d39e96458/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json
func ExampleSQLResourcesClient_BeginCreateUpdateClientEncryptionKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcosmos.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewSQLResourcesClient().BeginCreateUpdateClientEncryptionKey(ctx, "rgName", "accountName", "databaseName", "cekName", armcosmos.ClientEncryptionKeyCreateUpdateParameters{
		Properties: &armcosmos.ClientEncryptionKeyCreateUpdateProperties{
			Resource: &armcosmos.ClientEncryptionKeyResource{
				EncryptionAlgorithm: to.Ptr("AEAD_AES_256_CBC_HMAC_SHA256"),
				ID:                  to.Ptr("cekName"),
				KeyWrapMetadata: &armcosmos.KeyWrapMetadata{
					Name:      to.Ptr("customerManagedKey"),
					Type:      to.Ptr("AzureKeyVault"),
					Algorithm: to.Ptr("RSA-OAEP"),
					Value:     to.Ptr("AzureKeyVault Key URL"),
				},
				WrappedDataEncryptionKey: []byte("U3dhZ2dlciByb2Nrcw=="),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ClientEncryptionKeyGetResults = armcosmos.ClientEncryptionKeyGetResults{
	// 	Name: to.Ptr("cekName"),
	// 	Type: to.Ptr("Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName"),
	// 	Properties: &armcosmos.ClientEncryptionKeyGetProperties{
	// 		Resource: &armcosmos.ClientEncryptionKeyGetPropertiesResource{
	// 			EncryptionAlgorithm: to.Ptr("AEAD_AES_256_CBC_HMAC_SHA256"),
	// 			ID: to.Ptr("cekName"),
	// 			KeyWrapMetadata: &armcosmos.KeyWrapMetadata{
	// 				Name: to.Ptr("customerManagedKey"),
	// 				Type: to.Ptr("AzureKeyVault"),
	// 				Algorithm: to.Ptr("RSA-OAEP"),
	// 				Value: to.Ptr("AzureKeyVault Key URL"),
	// 			},
	// 			WrappedDataEncryptionKey: []byte("U3dhZ2dlciByb2Nrcw=="),
	// 			Etag: to.Ptr("00000000-0000-0000-7a1f-bc0828e801d7"),
	// 			Rid: to.Ptr("tNc4AAAAAAAQkjzWAgAAAA=="),
	// 			Ts: to.Ptr[float32](1626425552),
	// 		},
	// 	},
	// }
}

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

const { CosmosDBManagementClient } = require("@azure/arm-cosmosdb");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
 *
 * @summary Create or update a ClientEncryptionKey. This API is meant to be invoked via tools such as the Azure Powershell (instead of directly).
 * x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2025-04-15/examples/CosmosDBSqlClientEncryptionKeyCreateUpdate.json
 */
async function cosmosDbClientEncryptionKeyCreateUpdate() {
  const subscriptionId = process.env["COSMOSDB_SUBSCRIPTION_ID"] || "subId";
  const resourceGroupName = process.env["COSMOSDB_RESOURCE_GROUP"] || "rgName";
  const accountName = "accountName";
  const databaseName = "databaseName";
  const clientEncryptionKeyName = "cekName";
  const createUpdateClientEncryptionKeyParameters = {
    resource: {
      encryptionAlgorithm: "AEAD_AES_256_CBC_HMAC_SHA256",
      id: "cekName",
      keyWrapMetadata: {
        name: "customerManagedKey",
        type: "AzureKeyVault",
        algorithm: "RSA-OAEP",
        value: "AzureKeyVault Key URL",
      },
      wrappedDataEncryptionKey: Buffer.from("U3dhZ2dlciByb2Nrcw=="),
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CosmosDBManagementClient(credential, subscriptionId);
  const result = await client.sqlResources.beginCreateUpdateClientEncryptionKeyAndWait(
    resourceGroupName,
    accountName,
    databaseName,
    clientEncryptionKeyName,
    createUpdateClientEncryptionKeyParameters,
  );
  console.log(result);
}

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/subId/resourceGroups/rgName/providers/Microsoft.DocumentDB/databaseAccounts/accountName/sqlDatabases/databaseName/clientEncryptionKeys/cekName",
  "name": "cekName",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/clientEncryptionKey",
  "properties": {
    "resource": {
      "id": "cekName",
      "encryptionAlgorithm": "AEAD_AES_256_CBC_HMAC_SHA256",
      "wrappedDataEncryptionKey": "U3dhZ2dlciByb2Nrcw==",
      "keyWrapMetadata": {
        "name": "customerManagedKey",
        "type": "AzureKeyVault",
        "value": "AzureKeyVault Key URL",
        "algorithm": "RSA-OAEP"
      },
      "_rid": "tNc4AAAAAAAQkjzWAgAAAA==",
      "_ts": 1626425552,
      "_etag": "00000000-0000-0000-7a1f-bc0828e801d7"
    }
  }
}

Állapotkód:: 202

Definíciók

Name	Description
ClientEncryptionKeyCreateUpdateParameters	Az ügyfél titkosítási kulcsának megadásához szükséges paraméterek.
ClientEncryptionKeyGetResults	Ügyféltitkosítási kulcs.
ClientEncryptionKeyResource	Cosmos DB ügyféltitkosítási kulcs erőforrás-objektuma.
KeyWrapMetadata	A kulcsburkolás metaadatait jelöli, amelyeket a kulcsburkoló szolgáltató használhat az ügyféltitkosítási kulcsok tördeléséhez/feloldásához.
Resource

ClientEncryptionKeyCreateUpdateParameters

Objektum

Az ügyfél titkosítási kulcsának megadásához szükséges paraméterek.

Name	Típus	Description
properties.resource	ClientEncryptionKeyResource	A ClientEncryptionKey szabványos JSON-formátuma

ClientEncryptionKeyGetResults

Objektum

Ügyféltitkosítási kulcs.

Name	Típus	Description
id	string	Az adatbázisfiók egyedi erőforrás-azonosítója.
name	string	Az adatbázisfiók neve.
properties.resource	Resource
type	string	Az Azure-erőforrás típusa.

ClientEncryptionKeyResource

Objektum

Cosmos DB ügyféltitkosítási kulcs erőforrás-objektuma.

Name	Típus	Description
encryptionAlgorithm	string	Titkosítási algoritmus, amelyet ezzel az ügyféltitkosítási kulccsal együtt használunk az adatok titkosításához/visszafejtéséhez.
id	string	A ClientEncryptionKey neve
keyWrapMetadata	KeyWrapMetadata	A burkolószolgáltató metaadatai, amelyek a burkolt ügyféltitkosítási kulcs kicsomagolásához használhatók.
wrappedDataEncryptionKey	string (byte)	A bájttömbként ábrázolt kulcs burkolt (titkosított) formája.

KeyWrapMetadata

Objektum

A kulcsburkolás metaadatait jelöli, amelyeket a kulcsburkoló szolgáltató használhat az ügyféltitkosítási kulcsok tördeléséhez/feloldásához.

Name	Típus	Description
algorithm	string	Az adattitkosítási kulcs burkolásához és feloldásához használt algoritmus.
name	string	A társított KeyEncryptionKey (más néven CustomerManagedKey) neve.
type	string	A KeyStoreProvider szolgáltatóneve.
value	string	Hivatkozás/ hivatkozás a KeyEncryptionKeyre.

Resource

Objektum

Name	Típus	Description
_etag	string	Egy rendszer által létrehozott tulajdonság, amely az optimista egyidejűség-vezérléshez szükséges erőforrás-etagot jelöli.
_rid	string	Rendszer által létrehozott tulajdonság. Egyedi azonosító.
_ts	number	Egy rendszer által létrehozott tulajdonság, amely az erőforrás utolsó frissített időbélyegét jelöli.
encryptionAlgorithm	string	Titkosítási algoritmus, amelyet ezzel az ügyféltitkosítási kulccsal együtt használunk az adatok titkosításához/visszafejtéséhez.
id	string	A ClientEncryptionKey neve
keyWrapMetadata	KeyWrapMetadata	A burkolószolgáltató metaadatai, amelyek a burkolt ügyféltitkosítási kulcs kicsomagolásához használhatók.
wrappedDataEncryptionKey	string (byte)	A bájttömbként ábrázolt kulcs burkolt (titkosított) formája.

Megosztás a következőn keresztül:

Sql Resources - Create Update Client Encryption Key

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

CosmosDBClientEncryptionKeyCreateUpdate

Mintakérelem

Mintaválasz

Definíciók

ClientEncryptionKeyCreateUpdateParameters

ClientEncryptionKeyGetResults

ClientEncryptionKeyResource

KeyWrapMetadata

Resource