identity Csomag

Az Azure SDK-ügyfelek hitelesítő adatai.

Csomagok

aio

Hitelesítő adatok aszinkron Azure SDK-ügyfelekhez.

Osztályok

AuthenticationRecord

Nem titkos fiókadatok hitelesített felhasználó számára

Ez az osztály engedélyezi DeviceCodeCredential és InteractiveBrowserCredential hozzáférhet a korábban gyorsítótárazott hitelesítési adatokhoz. Az alkalmazások nem hozhatnak létre példányokat ennek az osztálynak. Ehelyett be kell szerezniük egyet a hitelesítő adatok hitelesítési módszeréből, például authenticate. További részletekért tekintse meg a user_authentication mintát.

AuthenticationRequiredError

A jogkivonat beszerzéséhez interaktív hitelesítés szükséges.

Ezt a hibát csak az interaktív felhasználói hitelesítő adatok okozták, amely úgy van konfigurálva, hogy szükség esetén automatikusan felhasználói beavatkozást kérjenek. A tulajdonságai további információkat tartalmaznak, amelyek szükségesek lehetnek a hitelesítéshez. A control_interactive_prompts minta egy hitelesítő adat "hitelesítés" metódusának meghívásával mutatja be a hiba kezelését.

AuthorizationCodeCredential

Hitelesítés az Azure Active Directoryból korábban beszerzett engedélyezési kód beváltásával.

A hitelesítési folyamatról további információt az Azure Active Directory dokumentációjában talál.

AzureAuthorityHosts

Az Azure SDK-ügyfelek hitelesítő adatai.

AzureCliCredential

A hitelesítéshez jogkivonatot kell kérnie az Azure CLI-ből.

Ehhez korábban be kell jelentkeznie az Azure-ba az "az login" használatával, és a parancssori felület jelenleg bejelentkezett identitását fogja használni.

AzureDeveloperCliCredential

A hitelesítéshez jogkivonatot kér a Azure Developer CLI.

Azure Developer CLI egy parancssori felületi eszköz, amellyel a fejlesztők erőforrásokat hozhatnak létre, kezelhetnek és helyezhetnek üzembe az Azure-ban. Az Azure CLI-n alapul, és további, az Azure-fejlesztőkre jellemző funkciókat biztosít. Lehetővé teszi a felhasználók számára a hitelesítést felhasználóként és/vagy szolgáltatásnévként az Azure Active Directoryn (Azure AD) keresztül. Az AzureDeveloperCliCredential egy fejlesztési környezetben hitelesít, és jogkivonatot szerez be a bejelentkezett felhasználó vagy szolgáltatásnév nevében a Azure Developer CLI. Ez a Azure Developer CLI bejelentkezett felhasználóként vagy szolgáltatásnévként működik, és egy Azure CLI-parancsot hajt végre alatta az alkalmazás Azure Active Directoryval való hitelesítéséhez.

A hitelesítő adatok használatához a fejlesztőnek helyileg kell hitelesítenie Azure Developer CLI az alábbi parancsok egyikével:

  • Futtassa az "azd auth login" (azd auth login) parancsot a Azure Developer CLI a felhasználóként történő interaktív hitelesítéshez.

  • A szolgáltatásnévként való hitelesítéshez futtassa az "azd auth login –client-id "client_id" –client-secret "client_secret" –tenant-id "tenant_id" parancsot.

Előfordulhat, hogy meg kell ismételnie ezt a folyamatot egy bizonyos idő elteltével, a frissítési jogkivonat érvényességétől függően a szervezetben. A frissítési jogkivonat érvényességi ideje általában néhány hét és néhány hónap között van. Az AzureDeveloperCliCredential kérni fogja, hogy jelentkezzen be újra.

AzurePowerShellCredential

A hitelesítéshez jogkivonatot kér a Azure PowerShell.

Ehhez korábban be kell jelentkeznie az Azure-ba a "Connect-AzAccount" használatával, és az aktuálisan bejelentkezett identitást fogja használni.

CertificateCredential

Szolgáltatásnévként hitelesítés tanúsítvány használatával.

A tanúsítványnak RSA titkos kulccsal kell rendelkeznie, mert ez a hitelesítő adat rs256-tal jelez helyességi adatokat. A tanúsítványhitelesítés konfigurálásáról további információt az Azure Active Directory dokumentációjában talál.

ChainedTokenCredential

Hitelesítő adatok sorozata, amely maga is hitelesítő adat.

Metódusa get_tokenget_token a sorrendben meghívja az egyes hitelesítő adatokat, és visszaadja az első érvényes jogkivonatot.

ClientAssertionCredential

A szolgáltatásnév hitelesítése JWT-állítással.

Ez a hitelesítő adat speciális forgatókönyvekhez készült. CertificateCredential egy kényelmesebb API-val rendelkezik a leggyakoribb helyességi forgatókönyvhöz, amely egy szolgáltatásnevet hitelesít egy tanúsítvánnyal.

ClientSecretCredential

A hitelesítés szolgáltatásnévként ügyfélkód használatával történik.

CredentialUnavailableError

A hitelesítő adat nem kísérelte meg a hitelesítést, mert a szükséges adatok vagy állapot nem érhető el.

DefaultAzureCredential

Egy alapértelmezett hitelesítő adat, amely képes kezelni a legtöbb Azure SDK-hitelesítési forgatókönyvet.

Az általa használt identitás a környezettől függ. Ha hozzáférési jogkivonatra van szükség, a rendszer ezeket az identitásokat használva kéri le őket, és leállítja, amikor egy jogkivonatot ad meg:

  1. Környezeti változók által konfigurált szolgáltatásnév. További részletekért lásd EnvironmentCredential .

  2. WorkloadIdentityCredential, ha a környezeti változók konfigurációját az Azure számításifeladat-identitás webhookja állítja be.

  3. Azure-beli felügyelt identitás. További részletekért lásd ManagedIdentityCredential .

  4. Csak Windows rendszeren: olyan felhasználó, aki microsoftos alkalmazással, például Visual Studióval jelentkezett be. Ha több identitás van a gyorsítótárban, akkor a környezeti változó AZURE_USERNAME értéke alapján választja ki a használni kívánt identitást. További részletekért lásd SharedTokenCacheCredential .

  5. Az Azure CLI-be jelenleg bejelentkezett identitás.

  6. A Azure PowerShell jelenleg bejelentkezett identitás.

  7. A Azure Developer CLI jelenleg bejelentkezett identitás.

Ez az alapértelmezett viselkedés kulcsszóargumentumokkal konfigurálható.

DeviceCodeCredential

A felhasználók hitelesítése az eszköz kódfolyamatán keresztül.

Amikor get_token a rendszer meghívja, ez a hitelesítő adat egy ellenőrző URL-címet és kódot szerez be az Azure Active Directoryból. A felhasználónak meg kell keresnie az URL-címet, meg kell adnia a kódot, és hitelesítenie kell az Azure Active Directoryval. Ha a felhasználó sikeresen hitelesíti magát, a hitelesítő adat hozzáférési jogkivonatot kap.

Ez a hitelesítő adat elsősorban böngésző nélküli környezetben, például egy SSH-munkamenetben használható. Ha elérhető webböngésző, akkor kényelmesebb, InteractiveBrowserCredential mert automatikusan megnyitja a böngészőt a bejelentkezési lapra.

EnvironmentCredential

Környezeti változók által konfigurált hitelesítő adat.

Ez a hitelesítő adat képes hitelesítést szolgáltatásnévként ügyfélkód vagy tanúsítvány használatával, illetve felhasználónévvel és jelszóval rendelkező felhasználóként. A konfigurációt ebben a sorrendben kísérli meg a rendszer az alábbi környezeti változók használatával:

Titkos szolgáltatásnév:

  • AZURE_TENANT_ID: A szolgáltatásnév bérlőjének azonosítója. Más néven a "könyvtár" azonosítója.

  • AZURE_CLIENT_ID: a szolgáltatásnév ügyfél-azonosítója

  • AZURE_CLIENT_SECRET: a szolgáltatásnév egyik titkos ügyfélkódja

  • AZURE_AUTHORITY_HOST: egy Azure Active Directory-végpont hatósága, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója, amely az alapértelmezett érték, ha nincs megadva érték.

Szolgáltatásnév tanúsítvánnyal:

  • AZURE_TENANT_ID: A szolgáltatásnév bérlőjének azonosítója. Más néven a "könyvtár" azonosítója.

  • AZURE_CLIENT_ID: a szolgáltatásnév ügyfél-azonosítója

  • AZURE_CLIENT_CERTIFICATE_PATH: PEM- vagy PKCS12-tanúsítványfájl elérési útja, beleértve a titkos kulcsot is.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (nem kötelező) a tanúsítványfájl jelszava, ha van ilyen.

  • AZURE_AUTHORITY_HOST: egy Azure Active Directory-végpont hatósága, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója, amely az alapértelmezett érték, ha nincs megadva érték.

Felhasználónévvel és jelszóval rendelkező felhasználó:

  • AZURE_CLIENT_ID: az alkalmazás ügyfél-azonosítója

  • AZURE_USERNAME: felhasználónév (általában e-mail-cím)

  • AZURE_PASSWORD: a felhasználó jelszava

  • AZURE_TENANT_ID: a szolgáltatásnév bérlőjének (nem kötelező) azonosítója. Más néven a "könyvtár" azonosítója. Ha nincs megadva, alapértelmezés szerint a "szervezetek" bérlője, amely csak az Azure Active Directory munkahelyi vagy iskolai fiókjait támogatja.

  • AZURE_AUTHORITY_HOST: egy Azure Active Directory-végpont hatósága, például "login.microsoftonline.com", az Azure Public Cloud szolgáltatója, amely az alapértelmezett érték, ha nincs megadva érték.

InteractiveBrowserCredential

Megnyit egy böngészőt egy felhasználó interaktív hitelesítéséhez.

get_token megnyit egy böngészőt az Azure Active Directory által biztosított bejelentkezési URL-címre, és hitelesíti az ott lévő felhasználót az engedélyezési kód folyamatával a PKCE (Proof Key for Code Exchange) belső használatával a kód védelméhez.

KnownAuthorities

Aliasa AzureAuthorityHosts

ManagedIdentityCredential

Hitelesítés azure-beli felügyelt identitással bármely olyan üzemeltetési környezetben, amely támogatja a felügyelt identitásokat.

Ez a hitelesítő adat alapértelmezés szerint rendszer által hozzárendelt identitást használ. Felhasználó által hozzárendelt identitás konfigurálásához használja az egyik kulcsszóargumentumot. A felügyelt identitás alkalmazásokhoz való konfigurálásával kapcsolatos további információkért tekintse meg az Azure Active Directory dokumentációját .

OnBehalfOfCredential

A szolgáltatásnév hitelesítése a folyamat nevében.

Ezt a folyamatot általában olyan középső szintű szolgáltatások használják, amelyek delegált felhasználói identitással rendelkező más szolgáltatásoknak engedélyezik a kéréseket. Mivel ez nem interaktív hitelesítési folyamat, az azt használó alkalmazásoknak rendszergazdai hozzájárulással kell rendelkezniük a delegált engedélyekhez, mielőtt jogkivonatokat kérnek tőlük. A helyszíni folyamat részletesebb leírását az Azure Active Directory dokumentációjában találja.

SharedTokenCacheCredential

Hitelesítés a Microsoft-alkalmazások között megosztott helyi gyorsítótárban lévő tokenekkel.

TokenCachePersistenceOptions

Az állandó jogkivonat-gyorsítótárazás beállításai.

A legtöbb hitelesítő adat elfogadja az osztály egy példányát az állandó tokenek gyorsítótárazásának konfigurálásához. Az alapértelmezett értékek konfigurálják a hitelesítő adatokat a Microsoft fejlesztői eszközeivel és SharedTokenCacheCredentiala szolgáltatással megosztott gyorsítótár használatára. A hitelesítő adatok más alkalmazásoktól való elkülönítéséhez adja meg a gyorsítótár nevét .

Alapértelmezés szerint a gyorsítótár titkosítva van a jelenlegi platform felhasználói adatvédelmi API-jával, és hibát jelez, ha ez nem érhető el. Ha úgy szeretné konfigurálni a gyorsítótárat, hogy hibafeloldás helyett visszaessen egy titkosítatlan fájlba, adja meg a allow_unencrypted_storage=Igaz értéket.

Figyelmeztetés

A gyorsítótár hitelesítési titkos kódokat tartalmaz. Ha a gyorsítótár nincs titkosítva, a védelem a

az alkalmazás felelőssége. A tartalma megsértése teljes mértékben veszélyezteti a fiókokat.

UsernamePasswordCredential

A felhasználó hitelesítése felhasználónévvel és jelszóval.

A Microsoft általában nem javasolja az ilyen típusú hitelesítést, mert kevésbé biztonságos, mint a többi hitelesítési folyamat.

Az ezzel a hitelesítő adatokkal történő hitelesítés nem interaktív, ezért nem kompatibilis a többtényezős hitelesítés vagy a hozzájárulás kérésének semmilyen formájával. Az alkalmazásnak már rendelkeznie kell a felhasználó vagy a címtáradminisztrátor hozzájárulásával.

Ez a hitelesítő adat csak a munkahelyi és iskolai fiókokat hitelesítheti; A Microsoft-fiókok nem támogatottak. A fióktípusokról további információt az Azure Active Directory dokumentációjában talál.

VisualStudioCodeCredential

Az Azure-felhasználó az "Azure-fiók" bővítményen keresztül jelentkezik be a Visual Studio Code-ba.

Ismert probléma, hogy ez a hitelesítő adat nem működik a 0.9.11-nél újabb Azure-fiókbővítmény-verziókkal. A probléma hosszú távú megoldása folyamatban van. Addig is fontolja meg a hitelesítést a következővel AzureCliCredential: .

WorkloadIdentityCredential

Hitelesítés Azure Active Directory számítási feladat identitásával.

A számítási feladatok identitásának hitelesítése az Azure egyik funkciója, amely lehetővé teszi, hogy a virtuális gépeken futó alkalmazások szolgáltatásnév vagy felügyelt identitás nélkül férhessenek hozzá más Azure-erőforrásokhoz. A számítási feladat identitásának hitelesítésével az alkalmazások saját identitásukkal hitelesítik magukat, nem pedig megosztott szolgáltatásnévvel vagy felügyelt identitással. A motorháztető alatt a számítási feladat identitásának hitelesítése a szolgáltatásfiók hitelesítő adatainak (SAC-k) fogalmát használja, amelyeket az Azure automatikusan hoz létre, és biztonságosan tárol a virtuális gépen. A számítási feladat identitásának hitelesítésével elkerülheti a szolgáltatásnevek vagy felügyelt identitások kezelését és elforgatását az egyes virtuális gépeken lévő alkalmazásokhoz. Emellett mivel az Azure automatikusan hozza létre és felügyeli a sacsokat, nem kell aggódnia a bizalmas hitelesítő adatok tárolása és védelme miatt.

A WorkloadIdentityCredential támogatja az Azure-beli számítási feladatok identitásának hitelesítését az Azure Kubernetesben, és jogkivonatot szerez be az Azure Kubernetes-környezetben elérhető szolgáltatásfiók hitelesítő adataival. További információért tekintse meg ezt a számítási feladat-identitás áttekintését .