Funzioni dell'API REST
Le funzioni seguenti supportano le entità Servizi multimediali di Microsoft Azure eseguendo varie attività, ad esempio l'annullamento di processi, il recupero delle chiavi di protezione e così via.
CancelJob. Accetta il parametro seguente: jobid di Edm.String tipo.
GetProtectionKeyId. Accetta il parametro seguente: contentKeyType di Edm.Int32 tipo. Restituisce Edm.String.
GetProtectionKey. Accetta il parametro seguente: protectionKeyId di Edm.String tipo. Restituisce Edm.String.
CreateFileInfos. Accetta il parametro seguente: assetid di Edm.String tipo.
RebindContentKey. Accetta i parametri seguenti: id di Edm.String tipo, x509Certificate di Edm.String tipo. Restituisce Edm.String.
Publish. Accetta il parametro seguente: assetid di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset tipo.
GetKeyDeliveryUrl. Accetta i parametri seguenti: contentKey di Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey tipo , keyDeliveryType di Edm.String tipo. Restituisce Edm.Int32.
Start. Accetta il parametro seguente: streamingEndpoint di Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Start. Accetta il parametro seguente: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Start. Accetta il parametro seguente: programma di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Stop. Accetta il parametro seguente: streamingEndpoint di Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Stop. Accetta il parametro seguente: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Stop. Accetta il parametro seguente: programma di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Scale. Accetta i parametri seguenti: streamingEndpoint di Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo, scaleUnits di Edm.String tipo.
ShowSlate. Accetta i parametri seguenti: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, durata del Edm.Time tipo, assetId di Edm.String tipo.
StartAdvertisement. Accetta i parametri seguenti: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, durata di Edm.Time tipo, cueId di tipo, showSlate di Edm.BooleanEdm.Int32 tipo.
HideSlate. Accetta il parametro seguente: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
EndAdvertisement. Accetta i parametri seguenti: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, cueId di Edm.Int32 tipo.
Reset. Accetta il parametro seguente: canale di Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Importante
Quando si accede alle entità in Servizi multimediali, è necessario impostare valori e campi di intestazione specifici nelle richieste HTTP.
Per altre informazioni, vedere Configurazione per lo sviluppo di API REST di Servizi multimediali e connessione a Servizi multimediali con l'API REST di Servizi multimediali.
Il resto dell'argomento illustra alcuni esempi di come chiamare le funzioni usando REST.
CancelJob
L'esecuzione dei processi può essere annullata chiamando CancelJob e passando l'ID di un processo attualmente in esecuzione.
| Metodo | URI richiesta | Versione HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-codificadvalue' | HTTP/1.1 |
Richiesta di esempio
Per ottenere l'ultima versione x-ms-version:, vedere REST servizi multimediali.
GET https://<accountname>.restv2.<location>.media.azure.net/api/CancelJob?jobid='nb%3ajid%3aUUID%3a9e9533ba-2b9b-fa4c-a33d-73eebd49039b' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
CreateFileInfos
Un entità File viene creata usando la funzione CreateFileInfos e passando l'ID asset associato al file multimediale caricato nella risorsa di archiviazione BLOB. Per altre informazioni, vedere l'argomento relativo al caricamento di un file nella risorsa di archiviazione BLOB.
| Metodo | URI richiesta | Versione HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-codificadvalue' | HTTP/1.1 |
Richiesta di esempio
Per ottenere l'ultima versione x-ms-version:, vedere REST servizi multimediali.
GET https://<accountname>.restv2.<location>.media.azure.net/api/CreateFileInfos?assetid='nb%3Acid%3AUUID%3Ac80d312d-7cb1-44aa-bb23-2c35d10c44bd' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
Content-Length: 0
GetProtectionKeyId
La funzione GetProtectionKeyId recupera un'identificazione personale del certificato X.509 che viene usata per assicurarsi che nel computer sia installato il certificato corretto durante la crittografia della chiave simmetrica definita dall'utente. I valori possibili per il parametro contentKeyType corrispondono ai valori di enumerazione ContentKeyType dell'entità ContentKey. Per altre informazioni, vedere Proprietà dell'entità ContentKey.
| Metodo | URI richiesta | Versione HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Richiesta di esempio
Per ottenere l'ultima versione x-ms-version:, vedere REST servizi multimediali.
GET https://<accountname>.restv2.<location>.media.azure.net/api/GetProtectionKeyId?contentKeyType=1 HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
GetProtectionKey
GetProtectionKey recupera il certificato X.509 specifico da usare per crittografare la chiave simmetrica definita dall'utente.
| Metodo | URI richiesta | Versione HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Richiesta di esempio
Per ottenere l'ultima versione x-ms-version:, vedere REST servizi multimediali.
GET https://<accountname>.restv2.<location>.media.azure.net/api/GetProtectionKey?ProtectionKeyId='B2FE17BEF56FFCB9A3FC4267D0F2AFE25CD2DE22' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
RebindContentKey
Se si vuole recuperare la chiave di contenuto crittografata da Servizi multimediali, chiamare RebindContentKey e passare l'ID ContentKey e il certificato X.509 (con solo la chiave pubblica) usata per crittografare le chiavi di contenuto di archiviazione cancellate/comuni di protezione. Se si chiama RebindContentKey e si passa una stringa vuota al parametro x509Certificate, la chiave simmetrica viene codificata con Base64 e viene restituita non crittografata.
| Metodo | URI richiesta | Versione HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-codificadvalue' | HTTP/1.1 |
Richiesta di esempio
Per ottenere l'ultima versione x-ms-version:, vedere REST servizi multimediali.
GET https://<accountname>.restv2.<location>.media.azure.net/api/RebindContentKey?id='nb%3akid%3aUUID%3a2eeba14e-613e-4af7-a926-413372cca8d5'&x509Certificate='' HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net