Správa verzí | Rozhraní Graph API koncepty

  • Článek

Platí pro: Graph API | Azure Active Directory (AD)

Toto téma shrnuje rozdíly verze entity Azure Active Directory (AD) Graph API a operace. Je nutné zadat verzi operace, kterou chcete použít zahrnutím api-version parametr řetězce ve vaší žádosti dotazu. Požadavky bez api-version parametr se odmítne a vrátit (400) – chybný požadavek odpovědi. Volá-li služby starší verze operace, můžete rozhodnout pokračovat v volání starší verze, nebo upravit na volání na novější verzi. Žádné rozdíly ve funkcích mezi verzemi jsou uvedeny v dokumentaci pro entitu, na kterém provádíte volání.

Důležité

Důrazně doporučujeme použít Microsoft Graph místo Azure AD Graph API pro přístup k prostředkům Azure Active Directory. Náš vývojový program jsou nyní soustředit na Microsoft Graph a dále jsou plánované pro Azure AD Graph API. Je velmi omezený počet scénářů, pro které Azure AD Graph API může být vhodné; Další informace najdete v tématu Microsoft Graph nebo Azure AD Graph příspěvku na blogu v Office Dev Center.

Od verze Azure AD Graph API verze 1.5, api-version hodnota parametru pro verze obecné dostupnosti (GA) je zadán jako číselná hodnota. Následující adresa URL ukazuje, jak zadat dotaz na nejvyšší úrovni prostředky pro klienta doménu contoso.com pomocí rozhraní Graph API verze 1.5: https://graph.windows.net/contoso.com?api-version=1.5. Pro předchozí verze rozhraní Graph API api-version hodnota parametru je zadán jako řetězec datum v následujícím formátu: rrrr-MM-DD. Následující adresa URL ukazuje, jak zadat dotaz na nejvyšší úrovni prostředky stejné klienta pomocí rozhraní Graph API verze 2013 – 11-08: https://graph.windows.net/contoso.com?api-version=2013-11-08. Pro funkce verze preview api-version je zadaná hodnota parametru pomocí řetězce "beta" následujícím způsobem: https://graph.windows.net/contoso.com?api-version=beta.

Rozhraní API kontrakt, Správa verzí a nejnovější změny

Jsme se zvýší číslo verze rozhraní API pro všechny nejnovější změny rozhraní API za účelem ochrany klientské aplikace. Jsme rozhodnout se zvýší verze rozhraní API pro pevné změny příliš (například pokud přidáme některé výrazně velké nové funkce).

Ano co se považuje za narušující změně?

  • Odebrání nebo přejmenování parametry rozhraní API a rozhraní API
  • Změny v chování pro existující rozhraní API
  • Změny v kódy chyb a selhání kontrakty
  • Všechno, co by způsobila porušení Princip nejnižších Astonishment

Poznámka:: Přidání nové pole JSON k odpovědím nepředstavuje narušující změně. Naše doprovodné materiály pro vývojáře, kteří generovat vlastní proxy klienta (například klienti WCF) je, že klientské aplikace by měla být připraveny na přijetí vlastnosti a definované dříve službou rozhraní Graph API odvozené typy. I když rozhraní Graph API ještě není kompatibilní s v době psaní tohoto textu OData V4, stále dodržovat pokyny popsané v části Model správy verzí v specifikace OData V4.

Když jsme zvýšit hlavní verzi rozhraní API (například ze 1.5 na 2.0), jsme jsou signalizace, všechny podporu pro existující klienty pomocí předchozí 1.x nebo starší verze, bude zastaralá a již není podporována po dobu 12 měsíců. Podrobnosti najdete zásadách životního cyklu podpory Online služeb Microsoft další podrobnosti.

Podporované verze

V následujících verzích byly vydány pro rozhraní Graph API.

Beta verze

Funkce rozhraní Graph API aktuálně ve verzi preview lze nalézt v buď funkce verze Preview část v koncepty rozhraní Graph API nebo na Blog týmu grafu. Beta verze funkce vyžadují "verze api-version = beta" parametr řetězce dotazu. Když týmem rozhraní Graph API dochází k závěru, že je funkce Náhled připravený pro GA, přidáme této funkce na nejnovější verzi GA (nebo pokud se považuje za narušující změny, které to by způsobilo zvýšena nové číslo verze). Provedeme žádné záruky, že všeobecné bude povýšen funkce preview

Beta verze pokusíme Vyhněte se co nejvíce všechny nejnovější změny, ale nebude Zaručujeme. Čas od času klientským aplikacím pomocí beta verze očekávat nejnovější změny. Najdete v tématu doplňkové podmínky použití pro Microsoft Azure Preview.

Verzi 1.6

Tato část obsahuje seznam změn pro rozhraní Graph API verze 1.6.

Graf rozhraní API verze 1.6 zavádí následující změny funkcí:

Změny entity

Entity Změnit popis
aplikace Přidat addIns vlastnosti, která definuje vlastní chování, které využívání služby můžete využít k volání aplikace v konkrétní kontexty.

Přidat třídy serviceEndpoints navigační vlastnost, která obsahuje kolekci koncové body služby, které jsou k dispozici pro zjišťování.
LicenseDetail Nová entita, který obsahuje licenční informace pro uživatele.
koncového bodu služby Nová entita, která obsahuje informace o zjišťování služby.
ServicePrincipal Přidat addIns vlastnosti, která definuje vlastní chování, které využívání služby můžete využít k volání aplikace v konkrétní kontexty.

Přidat třídy serviceEndpoints navigační vlastnost, která obsahuje kolekci koncové body služby, které jsou k dispozici pro zjišťování.
SubscribedSku Přidat AppliesTo – vlastnost.
TenantDetail Přidat trustedCAsForPasswordlessAuth vlastnosti, která obsahuje sadu certifikačních autorit, které slouží k ověření řetězu při provádění ověřování bez hesla.
TrustedCAsForPasswordlessAuth Nová entita, která představuje sadu certifikačních autorit k ověření řetězu při ověřování bez hesla.
uživatele Přidat creationType vlastnosti, která slouží k označení, že uživatel je místní účet.

Přidat signInNames vlastnosti, která obsahuje kolekci názvů přihlášení použili uživatel místní účet k přihlášení do klienta Azure Active Directory B2C. Tato vlastnost je přejmenován ze alternativeSignInNamesInfo ve verzi beta.

Přidat licenseDetails navigační vlastnost.

Komplexní typ změny

Typ Změnit popis
doplněk Nový typ se používá k definování vlastní chování, které využívání služby můžete využít k volání aplikace v konkrétní kontexty.
CertificateAuthorityInformation Nový typ, který představuje certifikační autorita používaná při ověření řetězu při provádění ověřování bez hesla.
KeyValue Nový typ, který obsahuje pár klíč hodnota, která definuje parametr, který využívání služby můžete použít nebo volání aplikace zadané v doplněk.
ServicePlanInfo Přidat AppliesTo – vlastnost.

Přidat provisioningStatus vlastnost.
SignInName Nový typ uchovávání informací o název přihlášení, který lze použít uživatel místní účet pro přihlášení k klienta služby Azure Active Directory B2C. Tento typ je přejmenován ze LogonIdentifier ve verzi beta.

Akce a funkce změny

Funkce Změnit popis
Změna hesla byla Nová akce, kterou lze volat pro povolení přihlášeného uživatele Chcete-li změnit své heslo.

Verze 1.5

Tato část obsahuje seznam změn pro rozhraní Graph API verze 1.5.

Graf rozhraní API verze 1.5 zavádí následující změny funkcí:

  • Obor názvů schématu rozhraní Graph API se změnil z Microsoft.WindowsAzure.ActiveDirectory k Microsoft.DirectoryServices. To ovlivní všechny entity a komplexní typy vystavené rozhraní Graph API.

  • Byla přidána podpora pro rozšíření schématu adresáře. To umožňuje přidávat vlastnosti, které vyžaduje vaše aplikace a objektů adresáře. Následující entity, které podporují rozšíření schématu: uživatele, skupiny, TenantDetail, zařízení, aplikace, a ServicePrincipal. Pro podporu rozšíření schématu adresáře: ExtensionProperty přidala entity extensionProperties navigační vlastnost byla přidána do aplikaceentitu a nové funkce, getAvailableExtensionProperties, byla přidána na vrátit vlastnosti registrovaných rozšíření podporovány objekty adresáře. Další informace o rozšíření schématu adresáře najdete v tématu rozšíření schématu adresáře.

  • Způsob, ve kterém jsou reprezentované oprávnění se změnil a je, že více naprosto v souladu s koncepty OAuth 2.0, a také s oprávněními způsob, jak jsou reprezentována v součásti Azure. Oprávnění entity, byla odebrána a nahradilo OAuth2PermissionGrant entity. Tato entita představuje delegované obory oprávnění OAuth 2.0, které dorazí v deklaraci identity tokenu oboru přístupu OAuth 2.0. Kromě toho nové AppRoleAssignment entity představuje aplikační role, které lze přiřadit k uživatele, skupiny a objekty služby. Dva spojené, komplexní typy také byly přidány: aplikační role a OAuth2Permission. Tato změna má vysráží přejmenování některé vlastnosti a přidání jiné v následujících entit: aplikace, skupiny, ServicePrincipala uživatele.

  • Role entity je přejmenován na DirectoryRole.

  • Šablony role entity je přejmenován na DirectoryRoleTemplate.

V následujících tabulkách jsou uvedeny entity, komplexní typy a funkce, které byly přidány, změnit nebo odebrat pro tuto verzi.

Změny entity

Entity Změnit popis
aplikace Aktualizovat appId vlastnost z Edm.Guid na Edm.String.

Přidat appRoles vlastnosti, která obsahuje kolekci aplikační role, které aplikace může deklarovat. Tyto role lze přiřadit na uživatele, skupiny nebo objekty služby.

Přidat groupMembershipClaims vlastnost, která je bitová maska, která nakonfiguruje "skupiny" deklarace identity vystavené v uživatele nebo přístupový token OAuth 2.0, který očekává vaší aplikace. Bitová maska hodnoty jsou: 0: None, 1: skupin zabezpečení a role se službou Azure AD, 2: vyhrazené a 4: vyhrazené. Nastavení bitové masky do 7, získají všechny skupiny zabezpečení, distribuční skupiny a role Azure AD, které je přihlášený uživatel členem.

Přidat knownClientApplications vlastnosti, která obsahuje seznam klientských aplikací, které jsou svázané s této prostředků aplikace. Souhlas s žádné známé klientské aplikace bude výsledkem implicitní souhlasu prostředků aplikace prostřednictvím kombinované souhlasu dialogové okno (zobrazující obory oprávnění OAuth vyžadují klienta a prostředek).

Přidat oauth2AllowImplicitFlow vlastnosti, která určuje, zda tato webová aplikace může požadovat tokeny OAuth2.0 implicitního toku. Výchozí hodnota je false.

Přidat oauth2AllowUrlPathMatching vlastnosti, která určuje, zda, v rámci žádostí o token OAuth 2.0, Azure AD bude umožňovat cesta shody se identifikátor URI přesměrování proti replyUrls aplikace. Výchozí hodnota je false.

Přidat oauth2Permissions vlastnosti, která obsahuje kolekci obory oprávnění OAuth 2.0, které zpřístupní webové aplikace rozhraní API (prostředků) pro klientské aplikace. Tyto obory oprávnění může být poskytnuta pro klientské aplikace během souhlasu.

Přidat oauth2RequiredPostResponse vlastnost, která určuje, zda v rámci žádostí o token OAuth 2.0, Azure AD umožní požadavků POST a požadavky GET. Výchozí hodnota je false, která určuje, že pouze GET požadavky, bude možné.

Přidat requiredResourceAccess vlastnosti, která určuje prostředky, které tato aplikace vyžaduje přístup k a sadu obory oprávnění OAuth a aplikační role, které je nutné v každém z těchto prostředků. Tato předběžná konfigurace přístupu požadovaný prostředek jednotky souhlasu činnost koncového uživatele.

Přidat extensionProperties navigační vlastnost, která obsahuje vlastnosti rozšíření, které jsou přidružené k aplikaci.
AppRoleAssignment Nová entita, která se používá k záznamu, zda uživatel nebo skupina je přiřazena k aplikaci. V takovém případě je výsledkem bude dlaždici aplikace zobrazen až na panel přístupu aplikace uživatele. Tuto entitu lze také udělit jinou aplikaci (modelován jako objekt služby) přístup k aplikaci prostředků v konkrétní roli.
Obraťte se na Přidat sipProxyAddress vlastnosti, která určuje hlasu přes IP (VOIP) relace spuštění protocol (SIP) adresa kontaktu.
DirectoryObject Přidat deletionTimestamp vlastnosti, která označuje čas, kdy byl odstraněn objekt adresáře. Platí jenom pro tyto objekty adresáře, které může být obnovena. Aktuálně je podporováno pouze pro aplikace.
DirectoryRole Přejmenovat z Role.

Přidat roleTemplateId vlastnost
DirectoryRoleTemplate Přejmenovat z šablony role.
ExtensionProperty Nová entita, která umožňuje aplikaci definice a používání sadu další vlastnosti, které mohou být přidány do objektů adresáře (uživatelé, skupiny, podrobnosti o klientovi, zařízení, aplikací a objekty služby) bez nutnosti externím úložišti aplikace.
skupiny Přidat onPremisesSecurityIdentifier vlastnosti, která obsahuje místní identifikátor zabezpečení (SID) pro skupinu, které se synchronizovaly z místní do cloudu.

Přidat appRoleAssignments navigační vlastnost, která odkazuje na sadu aplikací (objekty služby), které tato skupina je přiřazena k.
OAuth2PermissionGrant Nové entity, který určuje OAuth2.0 delegovaná oprávnění oboru. Zadaný OAuth oboru delegovaná oprávnění mohou být vyžádány klientskými aplikacemi (prostřednictvím requiredResourceAccess kolekce) volání této prostředků aplikace. Nahradí oprávnění entity, který je odebraný z této verze.
Oprávnění Přejmenované na OAuth2PermissionGrant.
Role Přejmenované na DirectoryRole.
RoleTemplate Přejmenované na DirectoryRoleTemplate.
ServicePrincipal Přidat appDisplayName vlastnosti, která určuje zobrazovaný název vystavené v přidružené aplikaci.

Přidat appRoleAssignmentRequired vlastnosti, která určuje, jestli AppRoleAssignment pro uživatele nebo skupiny se vyžaduje, aby Azure AD vydá uživatele nebo přístupový token aplikace.

Přidat appRoles vlastnosti, která obsahuje aplikaci role vystavené v přidružené aplikaci. Další informace najdete v článku appRoles definici vlastnosti na aplikace entity.

Přidat oauth2Permissions vlastnosti, která obsahuje oprávnění OAuth 2.0 vystavené v přidružené aplikaci. Další informace najdete v článku oauth2Permisions definici vlastnosti na aplikace entity.

Přidat preferredTokenSigningKeyThumbprint vlastnost. Vyhrazené jenom pro interní použití. Zápis nebo jinak spoléhají na tuto vlastnost. Může v budoucích verzích odebrána.

Přidat appRoleAssignedTo navigační vlastnost, která odkazuje na sadu aplikací, které je přiřazen objektu služby.

Přidat appRoleAssignments navigační vlastnost, která odkazuje na sadu objekty (uživatelé, skupiny a objekty služby), které jsou přiřazeny k této instanční objekt.

Přidat oauth2PermissionGrants navigační vlastnost, která odkazuje na sadu uděluje zosobnění uživatele přidružené k této instanční objekt.

Odebrat oprávnění navigační vlastnost
TenantDetail Odebrat vlastnost tenantType.
uživatele Přidat onPremisesSecurityIdentifier vlastnosti, která obsahuje místní identifikátor zabezpečení (SID) pro uživatele, který se synchronizovaly z místní do cloudu.

Přidat sipProxyAddress vlastnosti, která určuje hlasu přes IP (VOIP) relace spuštění protocol (SIP) adresy uživatele.

Přidat appRoleAssignments navigační vlastnost, která odkazuje na sadu aplikací (objekty služby), které je přiřazen tento uživatel.

Přidat oauth2PermissionGrants navigační vlastnost, která odkazuje na sadu uděluje zosobnění uživatele OAuth 2.0 přidružené k tomuto uživateli.

Odebrat oprávnění navigační vlastnost.

Komplexní typ změny

Typ Změnit popis
aplikační role Nový typ, který určuje aplikační role, které mohou být vyžádány klientskými aplikacemi volání této aplikace nebo která může být použita k přiřazení aplikace k uživatelům nebo skupinám v jedné z rolí zadané aplikace.
OAuth2Permission Nový typ, který představuje rozsah oprávnění OAuth 2.0. Zadaný obor oprávnění OAuth 2.0 mohou být vyžádány klientskými aplikacemi (prostřednictvím requiredResourceAccess kolekce) volání této prostředků aplikace.
RequiredResourceAccess Nový typ, který určuje sadu obory oprávnění OAuth 2.0 a aplikace rolí v zadaný prostředek, který vyžaduje přístup k této aplikaci.
resourceAccess Nový typ, který představuje oprávnění, které se tato aplikace vyžaduje.

Akce a funkce změny

Funkce Změnit popis
getAvailableExtensionProperties Nové funkce, která vrátí úplný seznam vlastností rozšíření, které byly zaregistrovány v adresáři. Vlastnosti rozšíření se dají registrovat pro následující entity: uživatele, skupiny, zařízení, TenantDetail, aplikace, a ServicePrincipal.
getMemberObjects Nové funkce, která vrátí všechny skupiny a DirectoryRole objekty, uživatele, kontaktů, skupinu nebo objekt služby je přechodně členem.
getObjectsByObjectIds Nové funkce, která vrátí objekty adresáře uvedené v seznamu identifikátorů objektu. Můžete také určit, které kolekce prostředků (uživatelů, skupin atd.) mají vyhledávány zadáním volitelného typy parametr.
Obnovení Nové služby akce, která umožňuje odstraněné aplikace k obnovení.

Verze 2013. 11 08

Tato část obsahuje seznam změn pro rozhraní Graph API verze 2013. 11 08.

V následujících tabulkách jsou uvedeny entity, komplexní typy a funkce, které byly přidány, změnit nebo odebrat pro tuto verzi.

Změny entity

Entity Změnit popis
aplikace Přidat vlastníky navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastníci aplikace. Vlastníci představují sadu uživatelů bez oprávnění správce, kteří mohou k úpravě tohoto objektu. Zděděno z DirectoryObject.
DeviceConfiguration Nová entita, která reprezentuje konfiguraci pro zařízení.
DirectoryObject Přidat createdOnBehalfOf navigační vlastnost, která odkazuje na adresář objektu, který tento objekt byl vytvořen jménem.

Přidat createdObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které byly vytvořeny pomocí aktuálního objektu.

Přidat vlastníky navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastníky aktuálního objektu. Vlastníci představují sadu uživatelů bez oprávnění správce, kteří mohou k úpravě tohoto objektu.

Přidat ownedObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastněny aktuálního objektu.

Důležité: entity, které jsou odvozeny od DirectoryObject dědit jeho vlastnosti a jeho navigační vlastnosti mohou dědit.
skupiny Přidat vlastníky navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastníky skupiny. Vlastníci představují sadu uživatelů bez oprávnění správce, kteří mohou k úpravě tohoto objektu. Zděděno z DirectoryObject.
Role Přidat ownedObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastněny roli. Zděděno z DirectoryObject. Role entity byla přejmenována na DirectoryRole od verze 1.5. Informace o Role, najdete v části DirectoryRole.
ServicePrincipal Přidat appOwnerTenantID vlastnost.

Přidat autheniticationPolicy vlastnost. Vyhrazené jenom pro interní použití. Nepoužívejte. Odebrat verze 1.5.

Přidat createdObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které byly vytvořeny instanční objekt. Zděděno z DirectoryObject.

Přidat vlastníky navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastníky instanční objekt. Vlastníci představují sadu uživatelů bez oprávnění správce, kteří mohou k úpravě tohoto objektu. Zděděno z DirectoryObject.

Přidat ownedObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastněny instanční objekt. Zděděno z DirectoryObject.
uživatele Přidat immutableId vlastnosti, která přidruží uživatelský účet místní služby Active Directory k jeho objektu uživatele Azure AD. Tato vlastnost je nutné zadat při vytváření nového uživatelského účtu v grafu, pokud používáte federovanou doménu pro uživatele userPrincipalName vlastnost (UPN).

Přidat userType vlastnost, která je řetězcová hodnota, kterou můžete použít ke klasifikaci typy uživatelů ve vašem adresáři, jako je například "Člen" a "Guest".

Přidat createdObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které byly vytvořeny uživatelem. Zděděno z DirectoryObject.

Přidat ownedObjects navigační vlastnost, která odkazuje na sadu objektů adresáře, které jsou vlastněny uživatele. Zděděno z DirectoryObject.

Komplexní typ změny

Typ Změnit popis
ServicePrincipalAuthenticationPolicy Vyhrazené jenom pro interní použití. Nepoužívejte. Odebrat verze 1.5.

Akce a funkce změny

Funkce Změnit popis
assignLicense Nové služby akce, která aktualizuje seznam licencí, které chcete přidat nebo odebrat uživatele.

Verze 2013-04-05

Toto je základní verzi rozhraní Graph API.

Další zdroje informací