Dela via


Content Key Policies - Get

Hämta en innehållsnyckelprincip
Hämta information om en princip för innehållsnyckel i Media Services-kontot

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

URI-parametrar

Name I Obligatorisk Typ Description
accountName
path True

string

Namnet på Media Services-kontot.

contentKeyPolicyName
path True

string

Namn på innehållsnyckelprincip.

resourceGroupName
path True

string

Namnet på resursgruppen i Azure-prenumerationen.

subscriptionId
path True

string

Den unika identifieraren för en Microsoft Azure-prenumeration.

api-version
query True

string

Den version av API:et som ska användas med klientbegäran.

Svar

Name Typ Description
200 OK

ContentKeyPolicy

OK

Other Status Codes

ErrorResponse

Detaljerad felinformation.

Exempel

Get a Content Key Policy by name

Exempelbegäran

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

Exempelsvar

{
  "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"
        }
      }
    ]
  }
}

Definitioner

Name Description
ContentKeyPolicy

En principresurs för innehållsnyckel.

ContentKeyPolicyClearKeyConfiguration

Representerar en konfiguration för icke-DRM-nycklar.

ContentKeyPolicyFairPlayConfiguration

Anger en konfiguration för FairPlay-licenser.

ContentKeyPolicyFairPlayOfflineRentalConfiguration
ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Uthyrnings- och lånenyckeltypen.

ContentKeyPolicyOpenRestriction

Representerar en öppen begränsning. Licens eller nyckel levereras vid varje begäran.

ContentKeyPolicyOption

Representerar ett principalternativ.

ContentKeyPolicyPlayReadyConfiguration

Anger en konfiguration för PlayReady-licenser.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Anger att innehållsnyckelns ID finns i PlayReady-huvudet.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Anger att innehållsnyckelns ID anges i PlayReady-konfigurationen.

ContentKeyPolicyPlayReadyContentType

Innehållstypen PlayReady.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Konfigurerar kontrollbitarna explicit analog tv-utdatabegränsning. Mer information finns i Efterlevnadsregler för PlayReady.

ContentKeyPolicyPlayReadyLicense

PlayReady-licensen

ContentKeyPolicyPlayReadyLicenseType

Licenstypen.

ContentKeyPolicyPlayReadyPlayRight

Konfigurerar Uppspelningsrätt i PlayReady-licensen.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Konfigurerar inställningar för okänd utdatahantering för licensen.

ContentKeyPolicyRestrictionTokenType

Typ av token.

ContentKeyPolicyRsaTokenKey

Anger en RSA-nyckel för tokenverifiering

ContentKeyPolicySymmetricTokenKey

Anger en symmetrisk nyckel för tokenvalidering.

ContentKeyPolicyTokenClaim

Representerar ett tokenanspråk.

ContentKeyPolicyTokenRestriction

Representerar en tokenbegränsning. Angivna token måste matcha dessa krav för lyckad licens eller nyckelleverans.

ContentKeyPolicyUnknownConfiguration

Representerar en ContentKeyPolicyConfiguration som inte är tillgänglig i den aktuella API-versionen.

ContentKeyPolicyUnknownRestriction

Representerar en ContentKeyPolicyRestriction som inte är tillgänglig i den aktuella API-versionen.

ContentKeyPolicyWidevineConfiguration

Anger en konfiguration för Widevine-licenser.

ContentKeyPolicyX509CertificateTokenKey

Anger ett certifikat för tokenverifiering.

createdByType

Den typ av identitet som skapade resursen.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

SecurityLevel

Säkerhetsnivån.

systemData

Metadata som rör skapande och senaste ändring av resursen.

ContentKeyPolicy

En principresurs för innehållsnyckel.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.created

string

Datumet då principen skapades

properties.description

string

En beskrivning av principen.

properties.lastModified

string

Senaste ändringsdatum för principen

properties.options

ContentKeyPolicyOption[]

Alternativen för nyckelprincip.

properties.policyId

string

Det äldre princip-ID:t.

systemData

systemData

Systemmetadata som är relaterade till den här resursen.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ContentKeyPolicyClearKeyConfiguration

Representerar en konfiguration för icke-DRM-nycklar.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration

Diskriminator för härledda typer.

ContentKeyPolicyFairPlayConfiguration

Anger en konfiguration för FairPlay-licenser.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration

Diskriminator för härledda typer.

ask

string

Nyckeln som måste användas som FairPlay-programhemlighetsnyckel. Detta måste vara base64-kodat.

fairPlayPfx

string

Base64-representationen av FairPlay-certifikatet i PKCS 12-format (pfx) (inklusive privat nyckel).

fairPlayPfxPassword

string

Lösenordet som krypterar FairPlay-certifikatet i PKCS 12-format (pfx).

offlineRentalConfiguration

ContentKeyPolicyFairPlayOfflineRentalConfiguration

Offlineuthyrningsprincip

rentalAndLeaseKeyType

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Uthyrnings- och lånenyckeltypen.

rentalDuration

integer

Hyreslängden. Måste vara större än eller lika med 0.

ContentKeyPolicyFairPlayOfflineRentalConfiguration

Name Typ Description
playbackDurationSeconds

integer

Uppspelningstid

storageDurationSeconds

integer

Lagringsvaraktighet

ContentKeyPolicyFairPlayRentalAndLeaseKeyType

Uthyrnings- och lånenyckeltypen.

Name Typ Description
DualExpiry

string

Dubbel förfallodatum för offlineuthyrning.

PersistentLimited

string

Innehållsnyckeln kan bevaras och den giltiga varaktigheten begränsas av värdet för Hyresvaraktighet

PersistentUnlimited

string

Innehållsnyckeln kan sparas med en obegränsad varaktighet

Undefined

string

Nyckelvaraktighet har inte angetts.

Unknown

string

Representerar en ContentKeyPolicyFairPlayRentalAndLeaseKeyType som inte är tillgänglig i den aktuella API-versionen.

ContentKeyPolicyOpenRestriction

Representerar en öppen begränsning. Licens eller nyckel levereras vid varje begäran.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyOpenRestriction

Diskriminator för härledda typer.

ContentKeyPolicyOption

Representerar ett principalternativ.

Name Typ Description
configuration ContentKeyPolicyConfiguration:

Konfiguration av nyckelleverans.

name

string

Beskrivning av principalternativ.

policyOptionId

string

Det äldre principalternativ-ID:t.

restriction ContentKeyPolicyRestriction:

De krav som måste uppfyllas för att leverera nycklar med den här konfigurationen

ContentKeyPolicyPlayReadyConfiguration

Anger en konfiguration för PlayReady-licenser.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration

Diskriminator för härledda typer.

licenses

ContentKeyPolicyPlayReadyLicense[]

PlayReady-licenserna.

responseCustomData

string

Anpassade svarsdata.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Anger att innehållsnyckelns ID finns i PlayReady-huvudet.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader

Diskriminator för härledda typer.

ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Anger att innehållsnyckelns ID anges i PlayReady-konfigurationen.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier

Diskriminator för härledda typer.

keyId

string

Innehållsnyckelns ID.

ContentKeyPolicyPlayReadyContentType

Innehållstypen PlayReady.

Name Typ Description
UltraVioletDownload

string

Ultraviolett nedladdningsinnehållstyp.

UltraVioletStreaming

string

Ultraviolett strömmande innehållstyp.

Unknown

string

Representerar en ContentKeyPolicyPlayReadyContentType som inte är tillgänglig i den aktuella API-versionen.

Unspecified

string

Ospecificerad innehållstyp.

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Konfigurerar kontrollbitarna explicit analog tv-utdatabegränsning. Mer information finns i Efterlevnadsregler för PlayReady.

Name Typ Description
bestEffort

boolean

Anger om den här begränsningen tillämpas enligt bästa förmåga.

configurationData

integer

Konfigurerar bitarna för begränsningskontroll. Måste vara mellan 0 och 3 inklusiv.

ContentKeyPolicyPlayReadyLicense

PlayReady-licensen

Name Typ Description
allowTestDevices

boolean

En flagga som anger om testenheter kan använda licensen.

beginDate

string

Licensens startdatum

contentKeyLocation ContentKeyPolicyPlayReadyContentKeyLocation:

Platsen för innehållsnyckeln.

contentType

ContentKeyPolicyPlayReadyContentType

Innehållstypen PlayReady.

expirationDate

string

Förfallodatumet för licensen.

gracePeriod

string

Respitperioden för licensen.

licenseType

ContentKeyPolicyPlayReadyLicenseType

Licenstypen.

playRight

ContentKeyPolicyPlayReadyPlayRight

Licensen PlayRight

relativeBeginDate

string

Det relativa startdatumet för licensen.

relativeExpirationDate

string

Det relativa förfallodatumet för licensen.

securityLevel

SecurityLevel

Säkerhetsnivån.

ContentKeyPolicyPlayReadyLicenseType

Licenstypen.

Name Typ Description
NonPersistent

string

Icke-beständig licens.

Persistent

string

Beständiga licenser. Tillåter offlineuppspelning.

Unknown

string

Representerar en ContentKeyPolicyPlayReadyLicenseType som inte är tillgänglig i den aktuella API-versionen.

ContentKeyPolicyPlayReadyPlayRight

Konfigurerar Uppspelningsrätt i PlayReady-licensen.

Name Typ Description
agcAndColorStripeRestriction

integer

Konfigurerar AGC (Automatic Gain Control) och Color Stripe i licensen. Måste vara mellan 0 och 3 inklusiv.

allowPassingVideoContentToUnknownOutput

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Konfigurerar inställningar för okänd utdatahantering för licensen.

analogVideoOpl

integer

Anger utdataskyddsnivån för komprimerat digitalt ljud.

compressedDigitalAudioOpl

integer

Anger utdataskyddsnivån för komprimerat digitalt ljud.

compressedDigitalVideoOpl

integer

Anger utdataskyddsnivån för komprimerad digital video.

digitalVideoOnlyContentRestriction

boolean

Aktiverar bildvillkoret för analog komponentvideobegränsning i licensen.

explicitAnalogTelevisionOutputRestriction

ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction

Konfigurerar den explicita utdatabegränsningen för analog tv i licensen. Konfigurationsdata måste vara mellan 0 och 3.

firstPlayExpiration

string

Hur lång tid licensen är giltig efter att licensen först används för att spela upp innehåll.

imageConstraintForAnalogComponentVideoRestriction

boolean

Aktiverar bildvillkoret för analog komponentvideobegränsning i licensen.

imageConstraintForAnalogComputerMonitorRestriction

boolean

Aktiverar bildvillkoret för analog komponentvideobegränsning i licensen.

scmsRestriction

integer

Konfigurerar SCMS (Serial Copy Management System) i licensen. Måste vara mellan 0 och 3 inklusiv.

uncompressedDigitalAudioOpl

integer

Anger utdataskyddsnivån för okomprimerat digitalt ljud.

uncompressedDigitalVideoOpl

integer

Anger utdataskyddsnivån för okomprimerad digital video.

ContentKeyPolicyPlayReadyUnknownOutputPassingOption

Konfigurerar inställningar för okänd utdatahantering för licensen.

Name Typ Description
Allowed

string

Det är tillåtet att skicka videodelen av skyddat innehåll till okända utdata.

AllowedWithVideoConstriction

string

Det är tillåtet att skicka videodelen av skyddat innehåll till okända utdata, men med begränsad upplösning.

NotAllowed

string

Det är inte tillåtet att skicka videodelen av skyddat innehåll till okända utdata.

Unknown

string

Representerar ett ContentKeyPolicyPlayReadyUnknownOutputPassingOption som inte är tillgängligt i den aktuella API-versionen.

ContentKeyPolicyRestrictionTokenType

Typ av token.

Name Typ Description
Jwt

string

JSON-webbtoken.

Swt

string

Enkel webbtoken.

Unknown

string

Representerar en ContentKeyPolicyRestrictionTokenType som inte är tillgänglig i den aktuella API-versionen.

ContentKeyPolicyRsaTokenKey

Anger en RSA-nyckel för tokenverifiering

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyRsaTokenKey

Diskriminator för härledda typer.

exponent

string

RSA-parameterns exponent

modulus

string

RSA-parametermodulen

ContentKeyPolicySymmetricTokenKey

Anger en symmetrisk nyckel för tokenvalidering.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicySymmetricTokenKey

Diskriminator för härledda typer.

keyValue

string

Nyckelvärdet för nyckeln

ContentKeyPolicyTokenClaim

Representerar ett tokenanspråk.

Name Typ Description
claimType

string

Typ av tokenanspråk.

claimValue

string

Tokenanspråksvärde.

ContentKeyPolicyTokenRestriction

Representerar en tokenbegränsning. Angivna token måste matcha dessa krav för lyckad licens eller nyckelleverans.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyTokenRestriction

Diskriminator för härledda typer.

alternateVerificationKeys ContentKeyPolicyRestrictionTokenKey[]:

En lista över alternativa verifieringsnycklar.

audience

string

Målgruppen för token.

issuer

string

Token-utfärdaren.

openIdConnectDiscoveryDocument

string

OpenID Connect-identifieringsdokumentet.

primaryVerificationKey ContentKeyPolicyRestrictionTokenKey:

Den primära verifieringsnyckeln.

requiredClaims

ContentKeyPolicyTokenClaim[]

En lista över nödvändiga tokenanspråk.

restrictionTokenType

ContentKeyPolicyRestrictionTokenType

Typ av token.

ContentKeyPolicyUnknownConfiguration

Representerar en ContentKeyPolicyConfiguration som inte är tillgänglig i den aktuella API-versionen.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownConfiguration

Diskriminator för härledda typer.

ContentKeyPolicyUnknownRestriction

Representerar en ContentKeyPolicyRestriction som inte är tillgänglig i den aktuella API-versionen.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyUnknownRestriction

Diskriminator för härledda typer.

ContentKeyPolicyWidevineConfiguration

Anger en konfiguration för Widevine-licenser.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyWidevineConfiguration

Diskriminator för härledda typer.

widevineTemplate

string

Widevine-mallen.

ContentKeyPolicyX509CertificateTokenKey

Anger ett certifikat för tokenverifiering.

Name Typ Description
@odata.type string:

#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey

Diskriminator för härledda typer.

rawBody

string

Rådatafältet för ett certifikat i PKCS 12-format (X509Certificate2 i .NET)

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

SecurityLevel

Säkerhetsnivån.

Name Typ Description
SL150

string

För klienter under utveckling eller testning. Inget skydd mot obehörig användning.

SL2000

string

För härdade enheter och program som använder kommersiellt innehåll. Program- eller maskinvaruskydd.

SL3000

string

Endast för härdade enheter. Maskinvaruskydd.

Unknown

string

Representerar en SecurityLevel som inte är tillgänglig i den aktuella API-versionen.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)

lastModifiedBy

string

Identiteten som senast ändrade resursen.

lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.