Fonctions de l'API REST
Les fonctions suivantes prennent en charge les entités Microsoft Azure Media Services en effectuant diverses tâches telles que l’annulation de travaux, la récupération des clés de protection, etc.
CancelJob. Prend le paramètre suivant : jobid de Edm.String type.
GetProtectionKeyId. Prend le paramètre suivant : contentKeyType de Edm.Int32 type. Retourne Edm.String.
GetProtectionKey. Prend le paramètre suivant : protectionKeyId de Edm.String type. Retourne Edm.String.
CreateFileInfos. Prend le paramètre suivant : assetid de Edm.String type.
RebindContentKey. Prend les paramètres suivants : id de Edm.String type, x509Certificate de Edm.String type. Retourne Edm.String.
Publish. Prend le paramètre suivant : assetid de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset type.
GetKeyDeliveryUrl. Prend les paramètres suivants : contentKey de Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey type, keyDeliveryType de Edm.String type. Retourne Edm.Int32.
Start. Prend le paramètre suivant : streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type.
Start. Prend le paramètre suivant : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.
Start. Prend le paramètre suivant : programme de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program type.
Stop. Prend le paramètre suivant : streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type.
Stop. Prend le paramètre suivant : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.
Stop. Prend le paramètre suivant : programme de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program type.
Scale. Prend les paramètres suivants : streamingEndpoint de Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint type, scaleUnits de Edm.String type.
ShowSlate. Prend les paramètres suivants : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, durée du Edm.Time type, assetId de Edm.String type.
StartAdvertisement. Prend les paramètres suivants : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, durée du Edm.Time type, cueId de Edm.Int32 type, showSlate de Edm.Boolean type.
HideSlate. Prend le paramètre suivant : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.
EndAdvertisement. Prend les paramètres suivants : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type, cueId de Edm.Int32 type.
Reset. Prend le paramètre suivant : canal de Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel type.
Important
Lors de l’accès aux entités dans Media Services, vous devez définir les valeurs et les champs d’en-tête spécifiques dans vos requêtes HTTP.
Pour plus d’informations, consultez Configuration du développement d’API REST Media Services et Connexion à Media Services avec l’API REST Media Services.
Le reste de la rubrique présente quelques exemples d’appel de fonctions à l’aide de REST.
CancelJob
Un travail en cours d'exécution peut être annulé en appelant CancelJob et en transmettant son ID.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Exemple de demande
Pour obtenir la dernière version x-ms-version:, consultez REST Media Services.
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
Une entité File est créée à l'aide de la fonction CreateFileInfos, en transmettant l'ID d'élément multimédia associé au fichier multimédia que vous avez chargé dans le stockage d'objets blob. Pour plus d'informations, consultez Chargement d'un fichier vers le stockage d'objets blob.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Exemple de demande
Pour obtenir la dernière version x-ms-version:, consultez REST Media Services.
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 fonction GetProtectionKeyId récupère une empreinte de certificat X.509 utilisée pour vérifier que le certificat correct est installé sur votre ordinateur lors du chiffrement de la clé de contenu définie par l'utilisateur. Les valeurs possibles pour le paramètre contentKeyType sont mappées aux valeurs d'énumération ContentKeyType sur l'entité ContentKey. Pour plus d'informations, consultez Propriétés de l'entité ContentKey.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Exemple de demande
Pour obtenir la dernière version x-ms-version:, consultez REST Media Services.
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 récupère le certificat X.509 spécifique qui doit être utilisé pour chiffrer la clé de contenu définie par l'utilisateur.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Exemple de demande
Pour obtenir la dernière version x-ms-version:, consultez REST Media Services.
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
Si vous souhaitez récupérer votre clé de contenu chiffrée à partir de Media Services, appelez RebindContentKey et transmettez votre ID ContentKey et le certificat X.509 (avec uniquement la clé publique) qui a été utilisé pour chiffrer les clés de contenu de chiffrement de stockage/de protection commune. Si vous appelez RebindContentKey et transmettez une chaîne vide au paramètre x509Certificate, votre clé de contenu est encodée en Base64 et renvoyée en clair.
| Méthode | URI de demande | Version HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Exemple de demande
Pour obtenir la dernière version x-ms-version:, consultez REST Media Services.
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