Vývoj pomocí rozhraní API služby Media Services v3

  • Článek

Logo Media Services v3

Upozornění

Služba Azure Media Services bude vyřazena 30. června 2024. Další informace najdete v průvodci vyřazením AMS.

Jako vývojář můžete používat klientské knihovny pro (.NET, Python, Node.js, Java a Go), které umožňují interakci s rozhraním REST API a snadno vytvářet, spravovat a udržovat vlastní pracovní postupy médií. Rozhraní API služby Media Services v3 je založené na specifikaci OpenAPI (dříve označované jako Swagger).

Tento článek popisuje pravidla, která se vztahují na entity a rozhraní API při vývoji pomocí Media Services v3.

Upozornění

Nedoporučujeme se pokoušet zabalit rozhraní REST API pro Media Services přímo do kódu vlastní knihovny, protože správný postup pro produkční účely by vyžadoval implementaci úplné logiky opakování služby Azure Resource Management a pochopení, jak spravovat dlouhotrvající operace v rozhraních API pro správu prostředků Azure. Klientské sady SDK pro různé jazyky ( .NET, Java, TypeScript, Python atd.) to zpracují automaticky a snižuje riziko problémů s logikou opakování nebo neúspěšnými voláními rozhraní API. Všechny klientské sady SDK to už za vás zpracují.

Přístup k rozhraní API služby Azure Media Services

Abyste mohli získat autorizaci pro přístup k prostředkům a rozhraní API služby Media Services, musíte se nejprve ověřit. Služba Media Services podporuje ověřování na základě Azure Active Directory (Azure AD). K dispozici jsou dvě běžné možnosti ověřování:

  • Ověřování instančních objektů: Slouží k ověřování služeb (například webových aplikací, aplikací funkcí, aplikací logiky, rozhraní API nebo mikroslužeb). Mezi aplikace, které běžně využívají tuto metodu ověřování, patří aplikace spouštějící služby démonů, služby střední úrovně nebo naplánované úlohy. Například pro webové aplikace by vždy měla existovat střední vrstva, která se připojuje ke službě Media Services pomocí instančního objektu.
  • Ověřování uživatelů: Slouží k ověřování lidí, kteří pomocí aplikace pracují s prostředky služby Media Services. Interaktivní aplikace by nejprve měla uživatele vyzvat k zadání přihlašovacích údajů. Příkladem je aplikace konzoly pro správu, kterou autorizovaní uživatelé používají k monitorování úloh kódování nebo živého streamování.

Rozhraní API služby Media Services vyžaduje, aby uživatel nebo aplikace provádějící požadavky rozhraní REST API měli přístup k prostředku účtu služby Media Services a používali roli Přispěvatel nebo Vlastník. K rozhraní API je možné přistupovat s rolí Čtenář, ale budou k dispozici pouze operace Get nebo List . Další informace najdete v tématu Řízení přístupu na základě role v Azure (Azure RBAC) pro účty Media Services.

Místo vytváření instančního objektu zvažte přístup k rozhraní API služby Media Services prostřednictvím Azure Resource Manageru s využitím spravovaných identit pro prostředky Azure. Další informace o spravovaných identitách pro prostředky Azure najdete v tématu Co jsou spravované identity pro prostředky Azure.

Azure AD instančního objektu

Aplikace Azure AD a instanční objekt by měly být ve stejném tenantovi. Po vytvoření aplikace udělte roli přispěvatele nebo vlastníka aplikace přístup k účtu Media Services.

Pokud si nejste jistí, jestli máte oprávnění k vytvoření aplikace Azure AD, přečtěte si téma Požadovaná oprávnění.

Na následujícím obrázku čísla představují tok požadavků v chronologickém pořadí:

Ověřování aplikací střední vrstvy pomocí AAD z webového rozhraní API

  1. Aplikace střední vrstvy vyžaduje přístupový token Azure AD, který má následující parametry:

    • Azure AD koncového bodu tenanta.
    • Identifikátor URI prostředku služby Media Services
    • Identifikátor URI prostředku pro REST Media Services
    • Azure AD hodnoty aplikace: ID klienta a tajný klíč klienta.

    Pokud chcete získat všechny potřebné hodnoty, projděte si téma Přístup k rozhraní API služby Azure Media Services.

  2. Přístupový token Azure AD se odešle do střední vrstvy.

  3. Střední vrstva odešle požadavek do rozhraní REST API služby Azure Media s tokenem Azure AD.

  4. Střední vrstva získá zpět data ze služby Media Services.

Ukázky

Projděte si následující ukázky, které ukazují, jak se připojit pomocí Azure AD instančního objektu:

Zásady vytváření názvů

Na názvy prostředků služby Azure Media Services v3 (například prostředky, úlohy, transformace) se vztahují omezení vytváření názvů Azure Resource Manageru. V souladu s Azure Resource Managerem jsou názvy prostředků vždy jedinečné. Jako názvy prostředků tedy můžete použít jakékoli řetězce jedinečného identifikátoru (například identifikátory GUID).

Názvy prostředků Media Services nemůžou obsahovat: '<', '>', '%', '&', ':', '\', '?', '/', '*', '+', '.', znak jednoduchých uvozovek ani žádné řídicí znaky. Všechny ostatní znaky jsou povolené. Maximální délka názvu prostředku je 260 znaků.

Další informace o pojmenování Azure Resource Manager najdete v tématu Požadavky na pojmenování a Zásady vytváření názvů.

Názvy souborů nebo objektů blob v rámci prostředku

Názvy souborů nebo objektů blob v rámci prostředku musí splňovat požadavky na název objektu blob i požadavky na název NTFS. Důvodem těchto požadavků je, že se soubory můžou ke zpracování zkopírovat z úložiště objektů blob na místní disk NTFS.

Dlouhotrvající operace

Operace označené x-ms-long-running-operation v souborech swagger služby Azure Media Services jsou dlouhotrvající operace.

Podrobnosti o sledování asynchronních operací Azure najdete v tématu Asynchronní operace.

Služba Media Services má následující dlouhotrvající operace:

Po úspěšném odeslání dlouhé operace se zobrazí "201 Vytvořeno" a musíte se dotázat na dokončení operace pomocí VRÁCENÉHO ID operace.

Článek o sledování asynchronních operací Azure podrobně vysvětluje, jak sledovat stav asynchronních operací Azure prostřednictvím hodnot vrácených v odpovědi.

Pro danou živou událost nebo kterýkoli z jejích přidružených živých výstupů je podporována pouze jedna dlouhotrvající operace. Po spuštění se musí dokončit dlouhotrvající operace před spuštěním následné dlouhotrvající operace se stejnou událostí LiveEvent nebo souvisejícími živými výstupy. U živých událostí s více živými výstupy musíte počkat na dokončení dlouhotrvající operace na jednom živém výstupu a teprve potom aktivovat dlouho běžící operaci na jiném živém výstupu.

Sady SDK

Poznámka

Sady SDK služby Azure Media Services v3 nejsou zaručené, že budou bezpečné pro přístup z více vláken. Při vývoji vícevláknové aplikace byste měli přidat vlastní logiku synchronizace vláken pro ochranu klienta nebo použít nový objekt AzureMediaServicesClient pro každé vlákno. Měli byste také dávat pozor na problémy s více vlákny způsobené volitelnými objekty poskytnutými vaším kódem klientovi (jako je instance HttpClient v .NET).

Sada SDK Reference
.NET SDK Referenční informace k .NET
Java SDK Referenční informace k Javě
Python SDK Referenční informace k Pythonu
Node.js SDK Referenční informace k Node.js
Go SDK Referenční informace k jazyku Go

Viz také

Průzkumník Azure Media Services

Azure Media Services Explorer (AMSE) je nástroj dostupný zákazníkům s Windows, kteří chtějí získat informace o službě Media Services. AMSE je aplikace Winforms/C#, která pomocí Media Services nahrává, stahuje, kóduje, streamuje video a živý obsah. Nástroj AMSE je určený pro klienty, kteří chtějí službu Media Services testovat bez psaní kódu. Kód AMSE je k dispozici jako prostředek pro zákazníky, kteří chtějí vyvíjet pomocí Media Services.

AMSE je open source projekt, podporu poskytuje komunita (problémy je možné nahlásit na webu https://github.com/Azure/Azure-Media-Services-Explorer/issues). Tento projekt přijal pravidla chování pro Microsoft Open Source. Další informace najdete v nejčastějších dotazech k pravidlům chování nebo se obraťte na opencode@microsoft.com další dotazy nebo připomínky.

Filtrování, řazení, stránkování entit Media Services

Viz Filtrování, řazení a stránkování entit Azure Media Services.

Získání nápovědy a podpory

Službu Media Services můžete kontaktovat s dotazy nebo můžete sledovat naše aktualizace jedním z následujících způsobů: