Assets - Get Encryption Key

Servicio:

Media Services

Versión de la API:

2022-08-01

Obtiene la clave de almacenamiento de recursos.
Obtiene las claves de cifrado de almacenamiento de recursos usadas para descifrar el contenido creado por la versión 2 de la API de Media Services.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de Media Services.
assetName	path	True	string	Nombre del recurso.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	StorageEncryptedAssetDecryptionData	Aceptar
Other Status Codes	ErrorResponse	Información detallada del error.

Ejemplos

Get Asset Storage Encryption Keys

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
AssetFileEncryptionMetadata	Metadatos de cifrado de Asset File Storage.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
StorageEncryptedAssetDecryptionData	Datos necesarios para descifrar archivos de recursos cifrados con cifrado de almacenamiento heredado.

AssetFileEncryptionMetadata

Metadatos de cifrado de Asset File Storage.

Nombre	Tipo	Description
assetFileId	string	Id. de archivo de recurso.
assetFileName	string	Nombre del archivo de recurso.
initializationVector	string	Vector de inicialización del archivo de recursos.

ErrorAdditionalInfo

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.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

StorageEncryptedAssetDecryptionData

Datos necesarios para descifrar archivos de recursos cifrados con cifrado de almacenamiento heredado.

Nombre	Tipo	Description
assetFileEncryptionMetadata	AssetFileEncryptionMetadata[]	Metadatos de cifrado de archivos de recursos.
key	string	Clave de cifrado de Almacenamiento de archivos de recursos.