Funções da API REST
As seguintes funções suportam as entidades Serviços de Multimédia do Microsoft Azure ao executar várias tarefas, como cancelar tarefas, obter chaves de proteção, etc.
CancelJob. Utiliza o seguinte parâmetro: jobid do Edm.String tipo.
GetProtectionKeyId. Utiliza o seguinte parâmetro: contentKeyType do Edm.Int32 tipo. Devolve Edm.String.
GetProtectionKey. Utiliza o seguinte parâmetro: protectionKeyId do Edm.String tipo. Devolve Edm.String.
CreateFileInfos. Utiliza o seguinte parâmetro: assetid do Edm.String tipo.
RebindContentKey. Utiliza os seguintes parâmetros: id do Edm.String tipo, x509Certificate do Edm.String tipo. Devolve Edm.String.
Publish. Utiliza o seguinte parâmetro: assetid do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset tipo.
GetKeyDeliveryUrl. Utiliza os seguintes parâmetros: contentKey do Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey tipo, keyDeliveryType do Edm.String tipo. Devolve Edm.Int32.
Start. Utiliza o seguinte parâmetro: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Start. Utiliza o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Start. Utiliza o seguinte parâmetro: programa do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Stop. Utiliza o seguinte parâmetro: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo.
Stop. Utiliza o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Stop. Utiliza o seguinte parâmetro: programa do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Program tipo.
Scale. Utiliza os seguintes parâmetros: streamingEndpoint do Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint tipo, scaleUnits do Edm.String tipo.
ShowSlate. Utiliza 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. Utiliza 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. Utiliza o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
EndAdvertisement. Utiliza os seguintes parâmetros: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo, cueId do Edm.Int32 tipo.
Reset. Utiliza o seguinte parâmetro: canal do Microsoft.Cloud.Media.Vod.Rest.Data.Models.Channel tipo.
Importante
Ao aceder a entidades nos Serviços de Multimédia, tem de definir campos e valores de cabeçalho específicos nos seus pedidos HTTP.
Para obter mais informações, veja Setup for Media Services REST API Development and Connecting to Media Services with the Media Services REST API ( Configurar o Desenvolvimento da API REST dos Serviços de Multimédia e Ligar aos Serviços de Multimédia com a API REST dos Serviços de Multimédia).
O resto do tópico mostra alguns exemplos de como chamar funções com REST.
CancelarJob
A execução de Tarefas pode ser cancelada ao chamar CancelarJob e ao transmitir o ID da Tarefa de uma Tarefa atualmente em execução.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
Pedido de Amostra
Para obter as versões mais recentes x-ms-version:, veja Serviços de Multimédia REST.
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
É criada uma entidade Ficheiro com a função CreateFileInfos e a transmissão do ID do Recurso associado ao ficheiro de multimédia que carregou para o armazenamento de blobs. Para obter mais informações, veja Carregar um ficheiro para o armazenamento de blobs.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
Pedido de Amostra
Para obter as versões mais recentes x-ms-version:, veja Serviços de Multimédia REST.
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 obtém um thumbprint de certificado X.509 que é utilizado para garantir que tem o certificado correto instalado no seu computador ao encriptar a chave de conteúdo definida pelo utilizador. A lista de valores possíveis para o mapa do parâmetro contentKeyType para os valores de enumeração ContentKeyType na entidade ContentKey. Para obter mais informações, veja Propriedades da Entidade ContentKey.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
Pedido de Amostra
Para obter as versões mais recentes x-ms-version:, veja Serviços de Multimédia REST.
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 obtém o certificado X.509 específico que deve ser utilizado para encriptar a sua chave de conteúdo definida pelo utilizador.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
Pedido de Amostra
Para obter as versões mais recentes x-ms-version:, veja Serviços de Multimédia REST.
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 quiser recuperar a chave de conteúdo encriptada dos Serviços de Multimédia, ligue para RebindContentKey e transmita o ID contentKey e o certificado X.509 (apenas com a chave pública) que foi utilizado para encriptar as chaves de conteúdo de encriptação de armazenamento/proteção comum. Se chamar RebindContentKey e transmitir uma cadeia vazia para o parâmetro x509Certificate, a sua chave de conteúdo é codificada com base64 e devolvida de forma clara.
| Método | URI do pedido | Versão HTTP |
|---|---|---|
| GET | <https:// accountname.restv2>.<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
Pedido de Amostra
Para obter as versões mais recentes x-ms-version:, veja Serviços de Multimédia REST.
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