Funções da API REST
As funções a seguir dão suporte às entidades Serviços de Mídia do Microsoft Azure executando várias tarefas, como cancelar trabalhos, recuperar chaves de proteção e assim por diante.
CancelJob. Usa o seguinte parâmetro: jobid do Edm.String tipo.
GetProtectionKeyId. Usa o seguinte parâmetro: contentKeyType do Edm.Int32 tipo. Retorna Edm.String.
GetProtectionKey. Usa o seguinte parâmetro: protectionKeyId do Edm.String tipo. Retorna Edm.String.
CreateFileInfos. Usa o seguinte parâmetro: assetid do Edm.String tipo.
RebindContentKey. Usa os seguintes parâmetros: id do Edm.String tipo, x509Certificate do Edm.String tipo. Retorna Edm.String.
Publish. Usa o seguinte parâmetro: assetid do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset tipo.
GetKeyDeliveryUrl. Usa os seguintes parâmetros: contentKey do Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey tipo, keyDeliveryType do Edm.String tipo. Retorna Edm.Int32.
Start. Usa o seguinte parâmetro: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Start. Usa o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Start. Usa o seguinte parâmetro: programa do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Stop. Usa o seguinte parâmetro: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Stop. Usa o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Stop. Usa o seguinte parâmetro: programa do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Scale. Usa os seguintes parâmetros: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo, scaleUnits do Edm.String tipo.
ShowSlate. Usa os seguintes parâmetros: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, duração do Edm.Time tipo, assetId do Edm.String tipo.
StartAdvertisement. Usa os seguintes parâmetros: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, duração do Edm.Time tipo, cueId do Edm.Int32 tipo, showSlate do Edm.Boolean tipo.
HideSlate. Usa o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
EndAdvertisement. Usa os seguintes parâmetros: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, cueId do Edm.Int32 tipo.
Reset. Usa o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Importante
Ao acessar entidades nos serviços de mídia, você deve definir valores e campos de cabeçalho específicos nas suas solicitações HTTP.
Para obter mais informações, consulte Instalação para desenvolvimento de API REST dos Serviços de Mídia e Conexão aos Serviços de Mídia com a API REST dos Serviços de Mídia.
O restante do tópico mostra alguns exemplos de como chamar funções usando REST.
CancelJob
Os trabalhos em execução podem ser cancelados chamando CancelJob e passando a ID do trabalho atualmente em execução.
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Solicitação de Exemplo
Para obter o mais recente x-ms-version:, consulte REST dos Serviços de Mídia.
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
Uma entidade arquivo é criada usando a função CreateFileInfos e passando uma ID de ativo que está associada ao arquivo de mídia carregado no armazenamento blob. Para obter mais informações, consulte Upload de um arquivo para o armazenamento blob.
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Solicitação de Exemplo
Para obter o mais recente x-ms-version:, consulte REST dos Serviços de Mídia.
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
A função GetProtectionKeyId recupera uma impressão digital do certificado X.509 que é usada para garantir que você possui o certificado correto instalado na sua máquina ao criptografar a chave de conteúdo definida pelo usuário. A lista de valores possíveis para o parâmetro contentKeyType mapeia para os valores de enumeração ContentKeyType na entidade ContentKey. Para obter mais informações, consulte as Propriedades da entidade ContentKey.
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Solicitação de Exemplo
Para obter o mais recente x-ms-version:, consulte REST dos Serviços de Mídia.
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 o certificado X.509 específico que deve ser usado para criptografar a chave de conteúdo definida pelo usuário.
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Solicitação de Exemplo
Para obter o mais recente x-ms-version:, consulte REST dos Serviços de Mídia.
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 você quiser recuperar sua chave de conteúdo criptografada de volta dos Serviços de Mídia, chame RebindContentKey e passe sua ID contentKey e o certificado X.509 (com apenas a chave pública) que foi usado para criptografar as chaves de conteúdo de criptografia de armazenamento/proteção comum. Se você chamar RebindContentKey e passar uma cadeia de caracteres vazia para o parâmetro x509Certificate, então a sua chave de conteúdo será codificada em base64 e retornada não criptografada.
| Método | URI da solicitação | Versão de HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Solicitação de Exemplo
Para obter o mais recente x-ms-version:, consulte REST dos Serviços de Mídia.
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