Поделиться через


Content Key Policies - Get

Получение политики ключей содержимого
Получение сведений о политике ключей содержимого в учетной записи Служб мультимедиа

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}?api-version=2022-08-01

Параметры URI

Имя В Обязательно Тип Описание
accountName
path True

string

Имя учетной записи Служб мультимедиа.

contentKeyPolicyName
path True

string

Имя политики ключа содержимого.

resourceGroupName
path True

string

Имя группы ресурсов в подписке Azure.

subscriptionId
path True

string

Уникальный идентификатор подписки Microsoft Azure.

api-version
query True

string

Версия API, которая будет использоваться с клиентским запросом.

Ответы

Имя Тип Описание
200 OK

ContentKeyPolicy

ОК

Other Status Codes

ErrorResponse

Подробные сведения об ошибке.

Примеры

Get a Content Key Policy by name

Образец запроса

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions?api-version=2022-08-01

Пример ответа

{
  "name": "PolicyWithMultipleOptions",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions",
  "type": "Microsoft.Media/mediaservices/contentKeyPolicies",
  "properties": {
    "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a",
    "created": "2015-12-01T00:00:00Z",
    "lastModified": "2016-12-02T00:00:00Z",
    "description": "A policy with multiple options.",
    "options": [
      {
        "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f",
        "configuration": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration"
        },
        "restriction": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction",
          "issuer": "http://testacs",
          "audience": "urn:test",
          "primaryVerificationKey": {
            "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey",
            "keyValue": ""
          },
          "alternateVerificationKeys": [],
          "requiredClaims": [
            {
              "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier"
            },
            {
              "claimType": "DRM",
              "claimValue": "Widevine"
            }
          ],
          "restrictionTokenType": "Jwt"
        }
      },
      {
        "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f",
        "configuration": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration",
          "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}"
        },
        "restriction": {
          "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction"
        }
      }
    ]
  }
}

Определения

Имя Описание
ContentKeyPolicy

Ресурс политики ключей содержимого.

ContentKeyPolicyClearKeyConfiguration

Представляет конфигурацию для ключей, не относящихся к DRM.

ContentKeyPolicyFairPlayConfiguration

Задает конфигурацию для лицензий FairPlay.

ContentKeyPolicyFairPlayOfflineRentalConfiguration
ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Тип ключа аренды и аренды.

ContentKeyPolicyOpenRestriction

Представляет открытое ограничение. Лицензия или ключ будут доставлены при каждом запросе.

ContentKeyPolicyOption

Представляет параметр политики.

ContentKeyPolicyPlayReadyConfiguration

Задает конфигурацию для лицензий PlayReady.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Указывает, что идентификатор ключа содержимого находится в заголовке PlayReady.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Указывает, что идентификатор ключа содержимого указан в конфигурации PlayReady.

ContentKeyPolicyPlayReadyContentType

Тип контента PlayReady.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Настраивает биты элемента управления явным ограничением вывода аналогового телевидения. Дополнительные сведения см. в разделе Правила соответствия playReady.

ContentKeyPolicyPlayReadyLicense

Лицензия PlayReady

ContentKeyPolicyPlayReadyLicenseType

Тип лицензии.

ContentKeyPolicyPlayReadyPlayRight

Настраивает право воспроизведения в лицензии PlayReady.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Настраивает параметры обработки неизвестных выходных данных для лицензии.

ContentKeyPolicyRestrictionTokenType

Тип маркера.

ContentKeyPolicyRsaTokenKey

Указывает ключ RSA для проверки маркера.

ContentKeyPolicySymmetricTokenKey

Задает симметричный ключ для проверки маркера.

ContentKeyPolicyTokenClaim

Представляет утверждение маркера.

ContentKeyPolicyTokenRestriction

Представляет ограничение маркера. Предоставленный маркер должен соответствовать этим требованиям для успешной доставки лицензии или ключа.

ContentKeyPolicyUnknownConfiguration

Представляет объект ContentKeyPolicyConfiguration, недоступный в текущей версии API.

ContentKeyPolicyUnknownRestriction

Представляет объект ContentKeyPolicyRestriction, недоступный в текущей версии API.

ContentKeyPolicyWidevineConfiguration

Задает конфигурацию для лицензий Widevine.

ContentKeyPolicyX509CertificateTokenKey

Указывает сертификат для проверки маркера.

createdByType

Тип удостоверения, создавшего ресурс.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Сообщение об ошибке

SecurityLevel

Уровень безопасности.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

ContentKeyPolicy

Ресурс политики ключей содержимого.

Имя Тип Описание
id

string

Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса.

properties.created

string

Дата создания политики.

properties.description

string

Описание политики.

properties.lastModified

string

Дата последнего изменения политики.

properties.options

ContentKeyPolicyOption[]

Параметры политик ключей.

properties.policyId

string

Устаревший идентификатор политики.

systemData

systemData

Системные метаданные, относящиеся к этому ресурсу.

type

string

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

ContentKeyPolicyClearKeyConfiguration

Представляет конфигурацию для ключей, не относящихся к DRM.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration

Дискриминатор для производных типов.

ContentKeyPolicyFairPlayConfiguration

Задает конфигурацию для лицензий FairPlay.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration

Дискриминатор для производных типов.

ask

string

Ключ, который должен использоваться в качестве ключа секрета приложения FairPlay. Он должен быть закодирован в кодировке Base64.

fairPlayPfx

string

Представление сертификата FairPlay в Base64 в формате PKCS 12 (pfx) (включая закрытый ключ).

fairPlayPfxPassword

string

Пароль, шифрующий сертификат FairPlay в формате PKCS 12 (pfx).

offlineRentalConfiguration

ContentKeyPolicyFairPlayOfflineRentalConfiguration

Политика автономной аренды

rentalAndLeaseKeyType

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Тип ключа аренды и аренды.

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.Media.ContentKeyPolicyOpenRestriction

Дискриминатор для производных типов.

ContentKeyPolicyOption

Представляет параметр политики.

Имя Тип Описание
configuration ContentKeyPolicyConfiguration:

Конфигурация доставки ключей.

name

string

Описание параметра политики.

policyOptionId

string

Устаревший идентификатор параметра политики.

restriction ContentKeyPolicyRestriction:

Требования, которые должны быть выполнены для доставки ключей с этой конфигурацией

ContentKeyPolicyPlayReadyConfiguration

Задает конфигурацию для лицензий PlayReady.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration

Дискриминатор для производных типов.

licenses

ContentKeyPolicyPlayReadyLicense[]

Лицензии PlayReady.

responseCustomData

string

Пользовательские данные ответа.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Указывает, что идентификатор ключа содержимого находится в заголовке PlayReady.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Дискриминатор для производных типов.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Указывает, что идентификатор ключа содержимого указан в конфигурации PlayReady.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Дискриминатор для производных типов.

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

ContentKeyPolicyPlayReadyContentType

Тип контента PlayReady.

expirationDate

string

Дата окончания срока действия лицензии.

gracePeriod

string

Льготный период лицензии.

licenseType

ContentKeyPolicyPlayReadyLicenseType

Тип лицензии.

playRight

ContentKeyPolicyPlayReadyPlayRight

Лицензия PlayRight

relativeBeginDate

string

Относительная дата начала лицензии.

relativeExpirationDate

string

Относительная дата окончания срока действия лицензии.

securityLevel

SecurityLevel

Уровень безопасности.

ContentKeyPolicyPlayReadyLicenseType

Тип лицензии.

Имя Тип Описание
NonPersistent

string

Непостояная лицензия.

Persistent

string

Постоянная лицензия. Разрешает воспроизведение в автономном режиме.

Unknown

string

Представляет ContentKeyPolicyPlayReadyLicenseType, который недоступен в текущей версии API.

ContentKeyPolicyPlayReadyPlayRight

Настраивает право воспроизведения в лицензии PlayReady.

Имя Тип Описание
agcAndColorStripeRestriction

integer

Настраивает автоматическое управление получением (AGC) и цветовую полосу в лицензии. Значение должно находиться в диапазоне от 0 до 3 включительно.

allowPassingVideoContentToUnknownOutput

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Настраивает параметры обработки неизвестных выходных данных для лицензии.

analogVideoOpl

integer

Указывает уровень защиты выходных данных для сжатого цифрового звука.

compressedDigitalAudioOpl

integer

Указывает уровень защиты выходных данных для сжатого цифрового звука.

compressedDigitalVideoOpl

integer

Указывает уровень защиты выходных данных для сжатого цифрового видео.

digitalVideoOnlyContentRestriction

boolean

Включает ограничение изображения для видео с аналоговым компонентом в лицензии.

explicitAnalogTelevisionOutputRestriction

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Настраивает явное ограничение вывода аналогового телевидения в лицензии. Данные конфигурации должны находиться в диапазоне от 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

Представляет свойство ContentKeyPolicyPlayReadyUnknownOutputPassingOption, недоступное в текущей версии API.

ContentKeyPolicyRestrictionTokenType

Тип маркера.

Имя Тип Описание
Jwt

string

Веб-токен JSON.

Swt

string

Простой веб-маркер.

Unknown

string

Представляет ContentKeyPolicyRestrictionTokenType, который недоступен в текущей версии API.

ContentKeyPolicyRsaTokenKey

Указывает ключ RSA для проверки маркера.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyRsaTokenKey

Дискриминатор для производных типов.

exponent

string

Экспонента параметра RSA

modulus

string

Модуль параметра RSA

ContentKeyPolicySymmetricTokenKey

Задает симметричный ключ для проверки маркера.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicySymmetricTokenKey

Дискриминатор для производных типов.

keyValue

string

Значение ключа

ContentKeyPolicyTokenClaim

Представляет утверждение маркера.

Имя Тип Описание
claimType

string

Тип утверждения маркера.

claimValue

string

Значение утверждения токена.

ContentKeyPolicyTokenRestriction

Представляет ограничение маркера. Предоставленный маркер должен соответствовать этим требованиям для успешной доставки лицензии или ключа.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyTokenRestriction

Дискриминатор для производных типов.

alternateVerificationKeys ContentKeyPolicyRestrictionTokenKey[]:

Список альтернативных ключей проверки.

audience

string

Аудитория для маркера.

issuer

string

Издатель маркера.

openIdConnectDiscoveryDocument

string

Документ об обнаружении OpenID connect.

primaryVerificationKey ContentKeyPolicyRestrictionTokenKey:

Первичный ключ проверки.

requiredClaims

ContentKeyPolicyTokenClaim[]

Список обязательных утверждений маркера.

restrictionTokenType

ContentKeyPolicyRestrictionTokenType

Тип маркера.

ContentKeyPolicyUnknownConfiguration

Представляет объект ContentKeyPolicyConfiguration, недоступный в текущей версии API.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownConfiguration

Дискриминатор для производных типов.

ContentKeyPolicyUnknownRestriction

Представляет объект ContentKeyPolicyRestriction, недоступный в текущей версии API.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownRestriction

Дискриминатор для производных типов.

ContentKeyPolicyWidevineConfiguration

Задает конфигурацию для лицензий Widevine.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyWidevineConfiguration

Дискриминатор для производных типов.

widevineTemplate

string

Шаблон Widevine.

ContentKeyPolicyX509CertificateTokenKey

Указывает сертификат для проверки маркера.

Имя Тип Описание
@odata.type string:

#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey

Дискриминатор для производных типов.

rawBody

string

Поле необработанных данных сертификата в формате PKCS 12 (X509Certificate2 в .NET)

createdByType

Тип удостоверения, создавшего ресурс.

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.

type

string

Тип дополнительных сведений.

ErrorDetail

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.

code

string

Код ошибки.

details

ErrorDetail[]

Сведения об ошибке.

message

string

Сообщение об ошибке.

target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект error.

SecurityLevel

Уровень безопасности.

Имя Тип Описание
SL150

string

Для клиентов, которые разрабатываются или тестируются. Нет защиты от несанкционированного использования.

SL2000

string

Для защищенных устройств и приложений, использующих коммерческое содержимое. Защита программного или аппаратного обеспечения.

SL3000

string

Только для защищенных устройств. Аппаратная защита.

Unknown

string

Представляет securityLevel, недоступный в текущей версии API.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).

createdBy

string

Удостоверение, создающее ресурс.

createdByType

createdByType

Тип удостоверения, создавшего ресурс.

lastModifiedAt

string

Метка времени последнего изменения ресурса (UTC)

lastModifiedBy

string

Удостоверение, которое последним изменял ресурс.

lastModifiedByType

createdByType

Тип удостоверения, которое последним изменял ресурс.