REST API 関数
次の関数は、ジョブの取り消し、保護キーの取得など、さまざまなタスクを実行することで、Microsoft Azure Media Services エンティティをサポートします。
CancelJob
. 次のパラメーターを受け取ります: 型の Edm.String
jobid。
GetProtectionKeyId
. type の contentKeyType パラメーターを Edm.Int32
受け取ります。
Edm.String
が返されます。
GetProtectionKey
. 型の protectionKeyId というパラメーターを Edm.String
受け取ります。
Edm.String
が返されます。
CreateFileInfos
. 次のパラメーターを受け取ります: 型の Edm.String
assetid。
RebindContentKey
. 次のパラメーターを受け取ります。 型の Edm.String
id、型の Edm.String
x509Certificate。
Edm.String
が返されます。
Publish
. 次のパラメーターを受け取ります: 型の Microsoft.Cloud.Media.Vod.Rest.Data.Models.Asset
assetid。
GetKeyDeliveryUrl
. 次のパラメーターを受け取ります。 type の Microsoft.Cloud.Media.Vod.Rest.Data.Models.ContentKey
contentKey、type の Edm.String
keyDeliveryType。
Edm.Int32
が返されます。
Start
. 型の streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
パラメーターを受け取ります。
Start
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル。
Start
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Program
プログラム。
Stop
. 型の streamingEndpointMicrosoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
パラメーターを受け取ります。
Stop
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル。
Stop
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Program
プログラム。
Scale
. 次のパラメーターを受け取ります。 型の Microsoft.Cloud.Media.Vod.Rest.Data.Models.StreamingEndpoint
streamingEndpoint、型の Edm.String
scaleUnits。
ShowSlate
. 次のパラメーターを受け取ります。 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル、型のEdm.Time
期間、型の Edm.String
assetId。
StartAdvertisement
. 次のパラメーターを受け取ります。型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル、型のEdm.Time
期間、型の Edm.Int32
cueId、型の Edm.Boolean
showSlate。
HideSlate
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル。
EndAdvertisement
. 次のパラメーターを受け取ります。 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル、型の Edm.Int32
cueId。
Reset
. 次のパラメーターを受け取ります: 型のMicrosoft.Cloud.Media.Vod.Rest.Data.Models.Channel
チャネル。
重要
Media Services でエンティティにアクセスするときは、HTTP 要求で特定のヘッダー フィールドと値を設定する必要があります。
詳細については、「 Media Services REST API 開発のセットアップ」および「Media Services REST APIを使用した Media Services への接続」を参照してください。
このトピックの残りの部分では、REST を利用して関数を呼び出す方法を、例を用いて紹介します。
CancelJob
実行中のジョブは、CancelJob を呼び出し、現在実行中の Job の Job ID を渡すことでキャンセルできます。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/CancelJob?jobid>='URL-encodedvalue' | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services 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
CreateFileInfos 関数を使用して、BLOB ストレージにユーザーがアップロードしたメディア ファイルに関連付けられた Asset ID を渡すと、File エンティティが作成されます。 詳細については、「Upload a file to blob storage」を参照してください。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/CreateFileInfos?assetid>='URL-encodedvalue' | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services 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
GetProtectionKeyId 関数は、ユーザー定義のコンテンツ キーを暗号化するときに正しい証明書がマシンにインストールされていることを確認するために使用される、X.509 証明書のサムプリントを取得します。 contentKeyType パラメーターで使用可能な値の一覧は、ContentKey エンティティの ContentKeyType 列挙値にマップされます。 詳細については、「ContentKey エンティティ プロパティ」を参照してください。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/GetProtectionKeyId?contentKeyType>=value | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services 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 は、ユーザー定義のコンテンツ キーの暗号化に使用する特定の X.509 証明書を取得します。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/GetProtectionKey?ProtectionKeyId>='value' | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services 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
暗号化されたコンテンツ キーを Media Services から取り戻す場合は、RebindContentKey を呼び出し、クリア ストレージ暗号化/共通保護コンテンツ キーの暗号化に使用された ContentKey ID と X.509 証明書 (公開キーのみ) を渡します。 RebindContentKey を呼び出して、空の文字列を x509Certificate パラメーターに渡すと、コンテンツ キーは Base64 形式でエンコードされ、クリア テキストで返されます。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/RebindContentKey?id>='contentkeyid'&x509Certificate='URL-encodedvalue' | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services 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