Assets - Get Encryption Key

Servizio:

Media Services

Versione API:

2022-08-01

Ottiene la chiave di archiviazione asset
Ottiene le chiavi di crittografia dell'archiviazione asset usate per decrittografare il contenuto creato dalla versione 2 dell'API Servizi multimediali

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey?api-version=2022-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account di Servizi multimediali.
assetName	path	True	string	Nome asset.
resourceGroupName	path	True	string	Nome del gruppo di risorse all'interno della sottoscrizione di Azure.
subscriptionId	path	True	string	Identificatore univoco per una sottoscrizione di Microsoft Azure.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Risposte

Nome	Tipo	Descrizione
200 OK	StorageEncryptedAssetDecryptionData	OK
Other Status Codes	ErrorResponse	Informazioni dettagliate sull'errore.

Esempio

Get Asset Storage Encryption Keys

Esempio di richiesta

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/assets/ClimbingMountSaintHelens/getEncryptionKey?api-version=2022-08-01

Java

/**
 * Samples for Assets GetEncryptionKey.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/assets-get-
     * encryption-keys.json
     */
    /**
     * Sample code: Get Asset Storage Encryption Keys.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void
        getAssetStorageEncryptionKeys(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.assets().getEncryptionKeyWithResponse("contosorg", "contosomedia", "ClimbingMountSaintHelens",
            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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.media import AzureMediaServices

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python assetsgetencryptionkeys.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 = AzureMediaServices(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.assets.get_encryption_key(
        resource_group_name="contoso",
        account_name="contosomedia",
        asset_name="ClimbingMountSaintHelens",
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/assets-get-encryption-keys.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

Go

package armmediaservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/assets-get-encryption-keys.json
func ExampleAssetsClient_GetEncryptionKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmediaservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAssetsClient().GetEncryptionKey(ctx, "contoso", "contosomedia", "ClimbingMountSaintHelens", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.StorageEncryptedAssetDecryptionData = armmediaservices.StorageEncryptedAssetDecryptionData{
	// 	AssetFileEncryptionMetadata: []*armmediaservices.AssetFileEncryptionMetadata{
	// 		{
	// 			AssetFileID: to.Ptr("a9536fa7-bd5d-4f84-a137-d1290982fe95"),
	// 			AssetFileName: to.Ptr("AssetFile0"),
	// 			InitializationVector: to.Ptr("-988929866"),
	// 		},
	// 		{
	// 			AssetFileID: to.Ptr("f4060046-94ac-422d-824c-3f1d6aa3ecf2"),
	// 			AssetFileName: to.Ptr("AssetFile1"),
	// 			InitializationVector: to.Ptr("1604993689"),
	// 		},
	// 		{
	// 			AssetFileID: to.Ptr("485968d3-ddae-4b13-98e7-901201a9620b"),
	// 			AssetFileName: to.Ptr("AssetFile2"),
	// 			InitializationVector: to.Ptr("100082635"),
	// 	}},
	// 	Key: []byte("AAAAAAAAAAAAAAAAAAAAAA=="),
	// }
}

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

JavaScript

const { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API
 *
 * @summary Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/assets-get-encryption-keys.json
 */
async function getAssetStorageEncryptionKeys() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const assetName = "ClimbingMountSaintHelens";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.assets.getEncryptionKey(resourceGroupName, accountName, assetName);
  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

dotnet

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

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/assets-get-encryption-keys.json
// this example is just showing the usage of "Assets_GetEncryptionKey" 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 MediaAssetResource created on azure
// for more information of creating MediaAssetResource, please refer to the document of MediaAssetResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contoso";
string accountName = "contosomedia";
string assetName = "ClimbingMountSaintHelens";
ResourceIdentifier mediaAssetResourceId = MediaAssetResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, assetName);
MediaAssetResource mediaAsset = client.GetMediaAssetResource(mediaAssetResourceId);

// invoke the operation
StorageEncryptedAssetDecryptionInfo result = await mediaAsset.GetEncryptionKeyAsync();

Console.WriteLine($"Succeeded: {result}");

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

Risposta di esempio

Codice di stato:

200

{
  "key": "AAAAAAAAAAAAAAAAAAAAAA==",
  "assetFileEncryptionMetadata": [
    {
      "initializationVector": "-988929866",
      "assetFileName": "AssetFile0",
      "assetFileId": "a9536fa7-bd5d-4f84-a137-d1290982fe95"
    },
    {
      "initializationVector": "1604993689",
      "assetFileName": "AssetFile1",
      "assetFileId": "f4060046-94ac-422d-824c-3f1d6aa3ecf2"
    },
    {
      "initializationVector": "100082635",
      "assetFileName": "AssetFile2",
      "assetFileId": "485968d3-ddae-4b13-98e7-901201a9620b"
    }
  ]
}

Definizioni

Nome	Descrizione
AssetFileEncryptionMetadata	Metadati di crittografia dell'archiviazione file asset.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
StorageEncryptedAssetDecryptionData	Dati necessari per decrittografare i file di asset crittografati con la crittografia di archiviazione legacy.

AssetFileEncryptionMetadata

Metadati di crittografia dell'archiviazione file asset.

Nome	Tipo	Descrizione
assetFileId	string	ID file asset.
assetFileName	string	Nome file asset.
initializationVector	string	Vettore di inizializzazione file asset.

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

StorageEncryptedAssetDecryptionData

Dati necessari per decrittografare i file di asset crittografati con la crittografia di archiviazione legacy.

Nome	Tipo	Descrizione
assetFileEncryptionMetadata	AssetFileEncryptionMetadata[]	Metadati di crittografia dei file di asset.
key	string	Chiave di crittografia dell'archiviazione file asset.