Content Key Policies - Update
コンテンツ キー ポリシーを更新する
Media Services アカウントに既存のコンテンツ キー ポリシーを更新する
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}?api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
account
|
path | True |
string |
Media Services アカウント名。 |
content
|
path | True |
string |
コンテンツ キー ポリシー名。 |
resource
|
path | True |
string |
Azure サブスクリプション内のリソース グループの名前。 |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションの一意識別子。 |
api-version
|
query | True |
string |
クライアント要求で使用される API のバージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.options | True |
キー ポリシーのオプション。 |
|
properties.description |
string |
ポリシーの説明。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
詳細なエラー情報。 |
例
Update a Content Key Policy
要求のサンプル
PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction?api-version=2022-08-01
{
"properties": {
"description": "Updated Policy",
"options": [
{
"name": "ClearKeyOption",
"configuration": {
"@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"
},
"restriction": {
"@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
}
}
]
}
}
応答のサンプル
{
"name": "PolicyWithClearKeyOptionAndTokenRestriction",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction",
"type": "Microsoft.Media/mediaservices/contentKeyPolicies",
"properties": {
"policyId": "8352435b-ebea-4681-aae7-e19277771f64",
"created": "2017-12-01T00:00:00Z",
"lastModified": "2018-08-08T18:29:30.303Z",
"description": "Updated Policy",
"options": [
{
"policyOptionId": "7d3f4bc1-d2bf-43a3-b02e-a7e31ab15d43",
"name": "ClearKeyOption",
"configuration": {
"@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"
},
"restriction": {
"@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
}
}
]
}
}
定義
ContentKeyPolicy
コンテンツ キー ポリシー リソース。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties.created |
string |
ポリシーの作成日 |
properties.description |
string |
ポリシーの説明。 |
properties.lastModified |
string |
ポリシーの最終変更日 |
properties.options |
キー ポリシーのオプション。 |
|
properties.policyId |
string |
従来のポリシー ID。 |
systemData |
このリソースに関連するシステム メタデータ。 |
|
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
ContentKeyPolicyClearKeyConfiguration
DRM 以外のキーの構成を表します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ContentKeyPolicyFairPlayConfiguration
FairPlay ライセンスの構成を指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ask |
string |
FairPlay アプリケーションの秘密キーとして使用する必要があるキー。 これは base64 でエンコードする必要があります。 |
fairPlayPfx |
string |
PKCS 12 (pfx) 形式の FairPlay 証明書の Base64 表現 (秘密キーを含む)。 |
fairPlayPfxPassword |
string |
PKCS 12 (pfx) 形式の FairPlay 証明書を暗号化するパスワード。 |
offlineRentalConfiguration |
オフライン レンタル ポリシー |
|
rentalAndLeaseKeyType |
レンタル キーとリース キーの種類。 |
|
rentalDuration |
integer |
レンタル期間。 0 以上である必要があります。 |
ContentKeyPolicyFairPlayOfflineRentalConfiguration
名前 | 型 | 説明 |
---|---|---|
playbackDurationSeconds |
integer |
再生時間 |
storageDurationSeconds |
integer |
保管期間 |
ContentKeyPolicyFairPlayRentalAndLeaseKeyType
レンタル キーとリース キーの種類。
名前 | 型 | 説明 |
---|---|---|
DualExpiry |
string |
オフライン レンタルのデュアル有効期限。 |
PersistentLimited |
string |
コンテンツ キーは永続化でき、有効な期間はレンタル期間の値によって制限されます |
PersistentUnlimited |
string |
コンテンツ キーは、無制限の期間で保持できます |
Undefined |
string |
キーの期間が指定されていません。 |
Unknown |
string |
現在の API バージョンでは使用できない ContentKeyPolicyFairPlayRentalAndLeaseKeyType を表します。 |
ContentKeyPolicyOpenRestriction
開いている制限を表します。 ライセンスまたはキーは、すべての要求で配信されます。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ContentKeyPolicyOption
ポリシー オプションを表します。
名前 | 型 | 説明 |
---|---|---|
configuration | ContentKeyPolicyConfiguration: |
キー配信の構成。 |
name |
string |
ポリシー オプションの説明。 |
policyOptionId |
string |
従来のポリシー オプション ID。 |
restriction | ContentKeyPolicyRestriction: |
この構成でキーを配信するために満たす必要がある要件 |
ContentKeyPolicyPlayReadyConfiguration
PlayReady ライセンスの構成を指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
licenses |
PlayReady ライセンス。 |
|
responseCustomData |
string |
カスタム応答データ。 |
ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader
コンテンツ キー ID が PlayReady ヘッダーにあることを指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier
PlayReady 構成でコンテンツ キー ID を指定することを指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
keyId |
string |
コンテンツ キー ID。 |
ContentKeyPolicyPlayReadyContentType
PlayReady コンテンツ タイプ。
名前 | 型 | 説明 |
---|---|---|
UltraVioletDownload |
string |
紫外線ダウンロード コンテンツ タイプ。 |
UltraVioletStreaming |
string |
紫外線ストリーミング コンテンツ タイプ。 |
Unknown |
string |
現在の API バージョンでは使用できない ContentKeyPolicyPlayReadyContentType を表します。 |
Unspecified |
string |
指定されていないコンテンツ タイプ。 |
ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction
明示的なアナログ テレビ出力制限制御ビットを構成します。 詳細については、「PlayReady コンプライアンス 規則」を参照してください。
名前 | 型 | 説明 |
---|---|---|
bestEffort |
boolean |
この制限がベスト エフォートベースで適用されるかどうかを示します。 |
configurationData |
integer |
制限制御ビットを構成します。 0 ~ 3 の範囲にする必要があります。 |
ContentKeyPolicyPlayReadyLicense
PlayReady ライセンス
名前 | 型 | 説明 |
---|---|---|
allowTestDevices |
boolean |
テスト デバイスでライセンスを使用できるかどうかを示すフラグ。 |
beginDate |
string |
ライセンスの開始日 |
contentKeyLocation | ContentKeyPolicyPlayReadyContentKeyLocation: |
コンテンツ キーの場所。 |
contentType |
PlayReady コンテンツ タイプ。 |
|
expirationDate |
string |
ライセンスの有効期限。 |
gracePeriod |
string |
ライセンスの猶予期間。 |
licenseType |
ライセンスの種類。 |
|
playRight |
ライセンス PlayRight |
|
relativeBeginDate |
string |
ライセンスの相対開始日。 |
relativeExpirationDate |
string |
ライセンスの相対的な有効期限日。 |
securityLevel |
セキュリティ レベル。 |
ContentKeyPolicyPlayReadyLicenseType
ライセンスの種類。
名前 | 型 | 説明 |
---|---|---|
NonPersistent |
string |
非永続的なライセンス。 |
Persistent |
string |
永続的なライセンス。 オフライン再生を許可します。 |
Unknown |
string |
現在の API バージョンでは使用できない ContentKeyPolicyPlayReadyLicenseType を表します。 |
ContentKeyPolicyPlayReadyPlayRight
PlayReady ライセンスで Play Right を構成します。
名前 | 型 | 説明 |
---|---|---|
agcAndColorStripeRestriction |
integer |
ライセンスで自動ゲイン制御 (AGC) とカラー ストライプを構成します。 0 ~ 3 の範囲にする必要があります。 |
allowPassingVideoContentToUnknownOutput |
ライセンスの不明な出力処理設定を構成します。 |
|
analogVideoOpl |
integer |
圧縮デジタル オーディオの出力保護レベルを指定します。 |
compressedDigitalAudioOpl |
integer |
圧縮デジタル オーディオの出力保護レベルを指定します。 |
compressedDigitalVideoOpl |
integer |
圧縮デジタル ビデオの出力保護レベルを指定します。 |
digitalVideoOnlyContentRestriction |
boolean |
ライセンスのアナログ コンポーネント ビデオ制限のイメージ制約を有効にします。 |
explicitAnalogTelevisionOutputRestriction |
Content |
ライセンスで明示的なアナログ テレビ出力制限を構成します。 構成データは、0 ~ 3 の範囲である必要があります。 |
firstPlayExpiration |
string |
ライセンスがコンテンツの再生に最初に使用された後にライセンスが有効な時間。 |
imageConstraintForAnalogComponentVideoRestriction |
boolean |
ライセンスのアナログ コンポーネント ビデオ制限のイメージ制約を有効にします。 |
imageConstraintForAnalogComputerMonitorRestriction |
boolean |
ライセンスのアナログ コンポーネント ビデオ制限のイメージ制約を有効にします。 |
scmsRestriction |
integer |
ライセンスでシリアル コピー管理システム (SCMS) を構成します。 0 ~ 3 の範囲にする必要があります。 |
uncompressedDigitalAudioOpl |
integer |
非圧縮デジタル オーディオの出力保護レベルを指定します。 |
uncompressedDigitalVideoOpl |
integer |
非圧縮デジタル ビデオの出力保護レベルを指定します。 |
ContentKeyPolicyPlayReadyUnknownOutputPassingOption
ライセンスの不明な出力処理設定を構成します。
名前 | 型 | 説明 |
---|---|---|
Allowed |
string |
保護されたコンテンツのビデオ部分を不明な出力に渡すことが許可されます。 |
AllowedWithVideoConstriction |
string |
保護されたコンテンツのビデオ部分を不明な出力に渡すことは許可されますが、解像度は制限されています。 |
NotAllowed |
string |
保護されたコンテンツのビデオ部分を不明な出力に渡すことは許可されません。 |
Unknown |
string |
現在の API バージョンでは使用できない ContentKeyPolicyPlayReadyUnknownOutputPassingOption を表します。 |
ContentKeyPolicyRestrictionTokenType
トークンの種類。
名前 | 型 | 説明 |
---|---|---|
Jwt |
string |
JSON Web トークン。 |
Swt |
string |
単純な Web トークン。 |
Unknown |
string |
現在の API バージョンでは使用できない ContentKeyPolicyRestrictionTokenType を表します。 |
ContentKeyPolicyRsaTokenKey
トークン検証用の RSA キーを指定します
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
exponent |
string |
RSA パラメーター指数 |
modulus |
string |
RSA パラメーターの剰余 |
ContentKeyPolicySymmetricTokenKey
トークン検証の対称キーを指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
keyValue |
string |
キーのキー値 |
ContentKeyPolicyTokenClaim
トークン要求を表します。
名前 | 型 | 説明 |
---|---|---|
claimType |
string |
トークン要求の種類。 |
claimValue |
string |
トークン要求の値。 |
ContentKeyPolicyTokenRestriction
トークン制限を表します。 指定されたトークンは、ライセンスまたはキーの配信を成功させるために、これらの要件と一致している必要があります。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
alternateVerificationKeys | ContentKeyPolicyRestrictionTokenKey[]: |
代替検証キーの一覧。 |
audience |
string |
トークンの対象ユーザー。 |
issuer |
string |
トークン発行者。 |
openIdConnectDiscoveryDocument |
string |
OpenID 接続検出ドキュメント。 |
primaryVerificationKey | ContentKeyPolicyRestrictionTokenKey: |
プライマリ検証キー。 |
requiredClaims |
必要なトークン要求の一覧。 |
|
restrictionTokenType |
トークンの種類。 |
ContentKeyPolicyUnknownConfiguration
現在の API バージョンでは使用できない ContentKeyPolicyConfiguration を表します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ContentKeyPolicyUnknownRestriction
現在の API バージョンでは使用できない ContentKeyPolicyRestriction を表します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
ContentKeyPolicyWidevineConfiguration
Widevine ライセンスの構成を指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
widevineTemplate |
string |
Widevine テンプレート。 |
ContentKeyPolicyX509CertificateTokenKey
トークン検証の証明書を指定します。
名前 | 型 | 説明 |
---|---|---|
@odata.type |
string:
#Microsoft. |
派生型の識別子。 |
rawBody |
string |
PKCS 12 形式の証明書の生データ フィールド (.NET の X509Certificate2) |
createdByType
リソースを作成した ID の種類。
名前 | 型 | 説明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
SecurityLevel
セキュリティ レベル。
名前 | 型 | 説明 |
---|---|---|
SL150 |
string |
開発中またはテスト中のクライアントの場合。 不正使用に対する保護はありません。 |
SL2000 |
string |
商用コンテンツを使用する強化されたデバイスとアプリケーションの場合。 ソフトウェアまたはハードウェアの保護。 |
SL3000 |
string |
セキュリティ強化されたデバイスの場合のみ。 ハードウェア保護。 |
Unknown |
string |
現在の API バージョンでは使用できない SecurityLevel を表します。 |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |