Content Key Policies - Update
Обновление политики ключей содержимого
Обновления существующей политики ключей содержимого в учетной записи Служб мультимедиа
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 |
Имя учетной записи Служб мультимедиа. |
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 |
ОК |
|
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"
}
}
]
}
}
Определения
Имя | Описание |
---|---|
Content |
Ресурс политики ключей содержимого. |
Content |
Представляет конфигурацию для ключей, не относящихся к DRM. |
Content |
Задает конфигурацию для лицензий FairPlay. |
Content |
|
Content |
Тип ключа аренды и аренды. |
Content |
Представляет открытое ограничение. Лицензия или ключ будут доставлены при каждом запросе. |
Content |
Представляет параметр политики. |
Content |
Задает конфигурацию для лицензий PlayReady. |
Content |
Указывает, что идентификатор ключа содержимого находится в заголовке PlayReady. |
Content |
Указывает, что идентификатор ключа содержимого указан в конфигурации PlayReady. |
Content |
Тип контента PlayReady. |
Content |
Настраивает биты элемента управления явным ограничением вывода аналогового телевидения. Дополнительные сведения см. в разделе Правила соответствия требованиям PlayReady. |
Content |
Лицензия PlayReady |
Content |
Тип лицензии. |
Content |
Настраивает право воспроизведения в лицензии PlayReady. |
Content |
Настраивает параметры обработки неизвестных выходных данных лицензии. |
Content |
Тип маркера. |
Content |
Указывает ключ RSA для проверки маркера. |
Content |
Задает симметричный ключ для проверки маркера. |
Content |
Представляет утверждение маркера. |
Content |
Представляет ограничение маркера. Предоставленный маркер должен соответствовать этим требованиям для успешной доставки лицензии или ключа. |
Content |
Представляет объект ContentKeyPolicyConfiguration, недоступный в текущей версии API. |
Content |
Представляет свойство ContentKeyPolicyRestriction, недоступное в текущей версии API. |
Content |
Задает конфигурацию для лицензий Widevine. |
Content |
Указывает сертификат для проверки маркера. |
created |
Тип удостоверения, создавшего ресурс. |
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Сообщение об ошибке |
Security |
Уровень безопасности. |
system |
Метаданные, относящиеся к созданию и последнему изменению ресурса. |
ContentKeyPolicy
Ресурс политики ключей содержимого.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.created |
string |
Дата создания политики. |
properties.description |
string |
Описание политики. |
properties.lastModified |
string |
Дата последнего изменения политики. |
properties.options |
Параметры политик ключей. |
|
properties.policyId |
string |
Устаревший идентификатор политики. |
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 |
Представление сертификата FairPlay в Base64 в формате PKCS 12 (pfx) (включая закрытый ключ). |
fairPlayPfxPassword |
string |
Сертификат FairPlay для шифрования паролей в формате PKCS 12 (pfx). |
offlineRentalConfiguration |
Политика автономной аренды |
|
rentalAndLeaseKeyType |
Тип ключа аренды и аренды. |
|
rentalDuration |
integer |
Продолжительность аренды. Должно быть больше или равно 0. |
ContentKeyPolicyFairPlayOfflineRentalConfiguration
Имя | Тип | Описание |
---|---|---|
playbackDurationSeconds |
integer |
Длительность воспроизведения |
storageDurationSeconds |
integer |
Длительность хранения |
ContentKeyPolicyFairPlayRentalAndLeaseKeyType
Тип ключа аренды и аренды.
Имя | Тип | Описание |
---|---|---|
DualExpiry |
string |
Двойной срок действия для автономной аренды. |
PersistentLimited |
string |
Ключ содержимого можно сохранить, а действительная длительность ограничена значением "Длительность аренды" |
PersistentUnlimited |
string |
Ключ содержимого можно сохранять с неограниченной длительностью |
Undefined |
string |
Длительность ключа не указана. |
Unknown |
string |
Представляет contentKeyPolicyFairPlayRentalAndLeaseKeyType, который недоступен в текущей версии API. |
ContentKeyPolicyOpenRestriction
Представляет открытое ограничение. Лицензия или ключ будут доставлены при каждом запросе.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
ContentKeyPolicyOption
Представляет параметр политики.
Имя | Тип | Описание |
---|---|---|
configuration | ContentKeyPolicyConfiguration: |
Конфигурация доставки ключей. |
name |
string |
Описание параметра политики. |
policyOptionId |
string |
Идентификатор устаревшего параметра политики. |
restriction | ContentKeyPolicyRestriction: |
Требования, которые должны быть выполнены для доставки ключей с этой конфигурацией |
ContentKeyPolicyPlayReadyConfiguration
Задает конфигурацию для лицензий PlayReady.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
licenses |
Лицензии PlayReady. |
|
responseCustomData |
string |
Пользовательские данные ответа. |
ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader
Указывает, что идентификатор ключа содержимого находится в заголовке PlayReady.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier
Указывает, что идентификатор ключа содержимого указан в конфигурации PlayReady.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
keyId |
string |
Идентификатор ключа содержимого. |
ContentKeyPolicyPlayReadyContentType
Тип контента PlayReady.
Имя | Тип | Описание |
---|---|---|
UltraVioletDownload |
string |
Тип контента для скачивания в ультрафиолетовом режиме. |
UltraVioletStreaming |
string |
Тип контента ультрафиолетовой потоковой передачи. |
Unknown |
string |
Представляет contentKeyPolicyPlayReadyContentType, который недоступен в текущей версии API. |
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 |
Представляет ContentKeyPolicyPlayReadyLicenseType, который недоступен в текущей версии API. |
ContentKeyPolicyPlayReadyPlayRight
Настраивает право воспроизведения в лицензии PlayReady.
Имя | Тип | Описание |
---|---|---|
agcAndColorStripeRestriction |
integer |
Настраивает автоматическое управление получением (AGC) и цветовую полосу в лицензии. Значение должно находиться в диапазоне от 0 до 3 включительно. |
allowPassingVideoContentToUnknownOutput |
Настраивает параметры обработки неизвестных выходных данных лицензии. |
|
analogVideoOpl |
integer |
Задает уровень защиты выходных данных для сжатого цифрового звука. |
compressedDigitalAudioOpl |
integer |
Задает уровень защиты выходных данных для сжатого цифрового звука. |
compressedDigitalVideoOpl |
integer |
Указывает уровень защиты выходных данных для сжатого цифрового видео. |
digitalVideoOnlyContentRestriction |
boolean |
Включает ограничение изображения для аналогового компонента video в лицензии. |
explicitAnalogTelevisionOutputRestriction |
Content |
Настраивает явное ограничение вывода аналогового телевидения в лицензии. Данные конфигурации должны находиться в диапазоне от 0 до 3 включительно. |
firstPlayExpiration |
string |
Время, в течение которого лицензия действительна после того, как лицензия впервые используется для воспроизведения содержимого. |
imageConstraintForAnalogComponentVideoRestriction |
boolean |
Включает ограничение изображения для аналогового компонента video в лицензии. |
imageConstraintForAnalogComputerMonitorRestriction |
boolean |
Включает ограничение изображения для аналогового компонента video в лицензии. |
scmsRestriction |
integer |
Настраивает систему управления последовательным копированием (SCMS) в лицензии. Значение должно находиться в диапазоне от 0 до 3 включительно. |
uncompressedDigitalAudioOpl |
integer |
Задает уровень защиты выходных данных для несжатого цифрового звука. |
uncompressedDigitalVideoOpl |
integer |
Задает уровень защиты выходных данных для несжатого цифрового видео. |
ContentKeyPolicyPlayReadyUnknownOutputPassingOption
Настраивает параметры обработки неизвестных выходных данных лицензии.
Имя | Тип | Описание |
---|---|---|
Allowed |
string |
Передача части видео защищенного содержимого в неизвестный вывод разрешена. |
AllowedWithVideoConstriction |
string |
Передача части видео защищенного содержимого в неизвестный вывод разрешена, но с ограниченным разрешением. |
NotAllowed |
string |
Передача части видео защищенного содержимого в неизвестный вывод не допускается. |
Unknown |
string |
Представляет свойство ContentKeyPolicyPlayReadyUnknownOutputPassingOption, недоступное в текущей версии API. |
ContentKeyPolicyRestrictionTokenType
Тип маркера.
Имя | Тип | Описание |
---|---|---|
Jwt |
string |
Веб-токен JSON. |
Swt |
string |
Простой веб-маркер. |
Unknown |
string |
Представляет ContentKeyPolicyRestrictionTokenType, который недоступен в текущей версии API. |
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 Connect. |
primaryVerificationKey | ContentKeyPolicyRestrictionTokenKey: |
Первичный ключ проверки. |
requiredClaims |
Список обязательных утверждений маркера. |
|
restrictionTokenType |
Тип маркера. |
ContentKeyPolicyUnknownConfiguration
Представляет объект ContentKeyPolicyConfiguration, недоступный в текущей версии API.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
ContentKeyPolicyUnknownRestriction
Представляет свойство ContentKeyPolicyRestriction, недоступное в текущей версии API.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
ContentKeyPolicyWidevineConfiguration
Задает конфигурацию для лицензий Widevine.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
widevineTemplate |
string |
Шаблон Widevine. |
ContentKeyPolicyX509CertificateTokenKey
Указывает сертификат для проверки маркера.
Имя | Тип | Описание |
---|---|---|
@odata.type |
string:
#Microsoft. |
Дискриминатор для производных типов. |
rawBody |
string |
Поле необработанных данных сертификата в формате PKCS 12 (X509Certificate2 в .NET) |
createdByType
Тип удостоверения, создавшего ресурс.
Имя | Тип | Описание |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Тип дополнительных сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Сообщение об ошибке
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
SecurityLevel
Уровень безопасности.
Имя | Тип | Описание |
---|---|---|
SL150 |
string |
Для клиентов, которые разрабатываются или тестируются. Нет защиты от несанкционированного использования. |
SL2000 |
string |
Для защищенных устройств и приложений, использующих коммерческое содержимое. Защита программного или аппаратного обеспечения. |
SL3000 |
string |
Только для защищенных устройств. Защита оборудования. |
Unknown |
string |
Представляет securityLevel, который недоступен в текущей версии API. |
systemData
Метаданные, относящиеся к созданию и последнему изменению ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Удостоверение, которое в последний раз изменял ресурс. |
lastModifiedByType |
Тип удостоверения, изменяющего ресурс в последний раз. |