identity Paket

Azure SDK istemcileri için kimlik bilgileri.

Paketler

aio

Zaman uyumsuz Azure SDK istemcileri için kimlik bilgileri.

Sınıflar

AuthenticationRecord

Kimliği doğrulanmış bir kullanıcı için gizli olmayan hesap bilgileri

Bu sınıf, önceden önbelleğe alınmış kimlik doğrulama verilerine ve InteractiveBrowserCredential erişimi sağlarDeviceCodeCredential. Uygulamalar bu sınıfın örneklerini oluşturmamalıdır. Bunun yerine kimlik bilgilerinin kimlik doğrulama yönteminden (gibi authenticate) almaları gerekir. Diğer ayrıntılar için user_authentication örneğine bakın.

AuthenticationRequiredError

Belirteç almak için etkileşimli kimlik doğrulaması gereklidir.

Bu hata yalnızca kullanıcı etkileşimini gerektiği gibi otomatik olarak istememek üzere yapılandırılmış etkileşimli kullanıcı kimlik bilgileri tarafından oluşturulur. Özellikleri, kimlik doğrulaması için gerekli olabilecek ek bilgiler sağlar. control_interactive_prompts örneği, kimlik bilgilerinin "authenticate" yöntemini çağırarak bu hatayı işlemeyi gösterir.

AuthorizationCodeCredential

Daha önce Azure Active Directory'den alınan bir yetkilendirme kodunu kullanarak kimlik doğrulaması yapar.

Kimlik doğrulama akışı hakkında daha fazla bilgi için bkz. Azure Active Directory belgeleri .

AzureAuthorityHosts

Azure SDK istemcileri için kimlik bilgileri.

AzureCliCredential

Azure CLI'dan belirteç isteyerek kimlik doğrulaması yapar.

Bu, daha önce "az login" aracılığıyla Azure'da oturum açmayı gerektirir ve CLI'nın şu anda oturum açmış olan kimliğini kullanır.

AzureDeveloperCliCredential

Azure Developer CLI bir belirteç isteyerek kimlik doğrulaması yapar.

Azure Developer CLI, geliştiricilerin Azure'da kaynak oluşturmasına, yönetmesine ve dağıtmasına olanak tanıyan bir komut satırı arabirimi aracıdır. Azure CLI'nın üzerine kurulmuştur ve Azure geliştiricilerine özgü ek işlevler sağlar. Kullanıcıların Azure Active Directory 'de (Azure AD) kullanıcı ve/veya hizmet sorumlusu olarak kimlik doğrulaması yapmasına olanak tanır. AzureDeveloperCliCredential bir geliştirme ortamında kimlik doğrulaması yapar ve Azure Developer CLI'da oturum açmış olan kullanıcı veya hizmet sorumlusu adına bir belirteç alır. Oturum açmış Azure Developer CLI kullanıcı veya hizmet sorumlusu işlevi görür ve Azure Active Directory'de uygulamanın kimliğini doğrulamak için altında bir Azure CLI komutu yürütür.

Bu kimlik bilgilerini kullanmak için geliştiricinin aşağıdaki komutlardan birini kullanarak Azure Developer CLI yerel olarak kimlik doğrulaması yapması gerekir:

  • Kullanıcı olarak etkileşimli olarak kimlik doğrulaması yapmak için Azure Developer CLI'de "azd auth login" komutunu çalıştırın.

  • Hizmet sorumlusu olarak kimlik doğrulaması yapmak için "azd auth login –client-id 'client_id' –client-secret 'client_secret' –tenant-id 'tenant_id'" komutunu çalıştırın.

Kuruluşunuzdaki yenileme belirteci geçerliliğine bağlı olarak bu işlemi belirli bir süre sonra tekrarlamanız gerekebilir. Genellikle yenileme belirteci geçerlilik süresi birkaç haftadan birkaç aya kadardır. AzureDeveloperCliCredential yeniden oturum açmanızı ister.

AzurePowerShellCredential

Azure PowerShell'dan belirteç isteyerek kimlik doğrulaması yapar.

Bunun için daha önce "Connect-AzAccount" aracılığıyla Azure'da oturum açmanız gerekir ve şu anda oturum açmış olan kimliği kullanır.

CertificateCredential

Sertifika kullanarak hizmet sorumlusu olarak kimlik doğrulaması yapar.

Bu kimlik bilgisi RS256 kullanarak onaylamaları imzaladığı için sertifikanın bir RSA özel anahtarı olmalıdır. Sertifika kimlik doğrulamasını yapılandırma hakkında daha fazla bilgi için bkz. Azure Active Directory belgeleri .

ChainedTokenCredential

Kendisi bir kimlik bilgisi olan kimlik bilgileri dizisi.

Yöntemi get_token , alınan ilk geçerli belirteci döndürerek sırayla sırayla her kimlik bilgilerini çağırır get_token .

ClientAssertionCredential

JWT onayıyla hizmet sorumlusu kimliğini doğrular.

Bu kimlik bilgisi gelişmiş senaryolara yöneliktir. CertificateCredential , bir sertifikayla hizmet sorumlusunun kimliğini doğrulayarak en yaygın onaylama senaryosu için daha kullanışlı bir API'ye sahiptir.

ClientSecretCredential

İstemci gizli dizisi kullanarak hizmet sorumlusu olarak kimlik doğrulaması yapar.

CredentialUnavailableError

Gerekli veriler veya durum kullanılamadığından kimlik bilgisi kimlik doğrulamayı denemedi.

DefaultAzureCredential

Azure SDK kimlik doğrulama senaryolarının çoğunu işleyebilen varsayılan kimlik bilgileri.

Kullandığı kimlik ortama bağlıdır. Erişim belirteci gerektiğinde, belirteç sağlandığında durdurularak bu kimlikleri kullanarak bir belirteç talep eder:

  1. Ortam değişkenleri tarafından yapılandırılan bir hizmet sorumlusu. Diğer ayrıntılar için bkz EnvironmentCredential .

  2. Ortam değişkeni yapılandırması Azure iş yükü kimliği web kancası tarafından ayarlandıysa WorkloadIdentityCredential.

  3. Azure yönetilen kimliği. Diğer ayrıntılar için bkz ManagedIdentityCredential .

  4. Yalnızca Windows'ta: Visual Studio gibi bir Microsoft uygulamasıyla oturum açmış bir kullanıcı. Önbellekte birden çok kimlik varsa, hangi kimliğin kullanılacağını seçmek için ortam değişkeninin AZURE_USERNAME değeri kullanılır. Diğer ayrıntılar için bkz SharedTokenCacheCredential .

  5. Şu anda Azure CLI'da oturum açmış olan kimlik.

  6. Şu anda Azure PowerShell oturum açmış olan kimlik.

  7. şu anda Azure Developer CLI oturum açmış olan kimlik.

Bu varsayılan davranış anahtar sözcük bağımsız değişkenleriyle yapılandırılabilir.

DeviceCodeCredential

Cihaz kodu akışı aracılığıyla kullanıcıların kimliğini doğrular.

Çağrıldığında get_token , bu kimlik bilgisi Azure Active Directory'den bir doğrulama URL'si ve kodu alır. Kullanıcının URL'ye göz atması, kodu girmesi ve Azure Active Directory ile kimlik doğrulaması yapması gerekir. Kullanıcı başarıyla kimlik doğrulaması yaparsa, kimlik bilgisi bir erişim belirteci alır.

Bu kimlik bilgisi, SSH oturumu gibi web tarayıcısı olmayan bir ortamda kullanıcının kimliğini doğrulamak için öncelikli olarak yararlıdır. Bir web tarayıcısı varsa, InteractiveBrowserCredential otomatik olarak bir tarayıcıyı oturum açma sayfasına açtığından daha kullanışlıdır.

EnvironmentCredential

Ortam değişkenleri tarafından yapılandırılan bir kimlik bilgisi.

Bu kimlik bilgisi, bir istemci gizli anahtarı veya sertifika kullanarak hizmet sorumlusu olarak ya da kullanıcı adı ve parolası olan bir kullanıcı olarak kimlik doğrulaması yapabilir. Yapılandırma şu ortam değişkenleri kullanılarak şu sırayla denendi:

Gizli dizi ile hizmet sorumlusu:

  • AZURE_TENANT_ID: Hizmet sorumlusunun kiracısının kimliği. 'dizin' kimliği olarak da adlandırılır.

  • AZURE_CLIENT_ID: Hizmet sorumlusunun istemci kimliği

  • AZURE_CLIENT_SECRET: hizmet sorumlusunun istemci gizli dizilerinden biri

  • AZURE_AUTHORITY_HOST: Azure Active Directory uç noktasının yetkilisi, örneğin "login.microsoftonline.com", azure genel bulutunun yetkilisidir ve değer verilmediğinde varsayılandır.

Sertifikalı hizmet sorumlusu:

  • AZURE_TENANT_ID: Hizmet sorumlusunun kiracısının kimliği. 'dizin' kimliği olarak da adlandırılır.

  • AZURE_CLIENT_ID: Hizmet sorumlusunun istemci kimliği

  • AZURE_CLIENT_CERTIFICATE_PATH: Özel anahtarı içeren bir PEM veya PKCS12 sertifika dosyasının yolu.

  • AZURE_CLIENT_CERTIFICATE_PASSWORD: (isteğe bağlı) varsa sertifika dosyasının parolası.

  • AZURE_AUTHORITY_HOST: Azure Active Directory uç noktasının yetkilisi, örneğin "login.microsoftonline.com", azure genel bulutunun yetkilisidir ve değer verilmediğinde varsayılandır.

Kullanıcı adı ve parola ile kullanıcı:

  • AZURE_CLIENT_ID: Uygulamanın istemci kimliği

  • AZURE_USERNAME: kullanıcı adı (genellikle e-posta adresi)

  • AZURE_PASSWORD: bu kullanıcının parolası

  • AZURE_TENANT_ID: (isteğe bağlı) hizmet sorumlusunun kiracısının kimliği. 'dizin' kimliği olarak da adlandırılır. Sağlanmadıysa, varsayılan olarak yalnızca Azure Active Directory iş veya okul hesaplarını destekleyen 'kuruluşlar' kiracısını kullanır.

  • AZURE_AUTHORITY_HOST: Azure Active Directory uç noktasının yetkilisi, örneğin "login.microsoftonline.com", azure genel bulutunun yetkilisidir ve değer verilmediğinde varsayılandır.

InteractiveBrowserCredential

Kullanıcının kimliğini etkileşimli olarak doğrulamak için bir tarayıcı açar.

get_token , Azure Active Directory tarafından sağlanan oturum açma URL'sine bir tarayıcı açar ve kodu korumak için pkce (Kod Değişimi için Proof Key) kullanarak yetkilendirme kodu akışıyla orada bir kullanıcının kimliğini doğrular.

KnownAuthorities

Diğer adı AzureAuthorityHosts

ManagedIdentityCredential

Yönetilen kimlikleri destekleyen herhangi bir barındırma ortamında Azure yönetilen kimliğiyle kimlik doğrulaması yapar.

Bu kimlik bilgisi varsayılan olarak sistem tarafından atanan bir kimlik kullanılır. Kullanıcı tarafından atanan bir kimliği yapılandırmak için anahtar sözcük bağımsız değişkenlerinden birini kullanın. Uygulamalar için yönetilen kimliği yapılandırma hakkında daha fazla bilgi için bkz. Azure Active Directory belgeleri .

OnBehalfOfCredential

Hizmet sorumlusunun kimliğini adına akış aracılığıyla doğrular.

Bu akış genellikle temsilci kullanıcı kimliğiyle diğer hizmetlere yönelik istekleri yetkilendirilen orta katman hizmetleri tarafından kullanılır. Bu etkileşimli bir kimlik doğrulama akışı olmadığından, kullanan bir uygulamanın belirteç istemeden önce temsilci izinleri için yönetici onayına sahip olması gerekir. Adına akışın daha ayrıntılı bir açıklaması için bkz. Azure Active Directory belgeleri .

SharedTokenCacheCredential

Microsoft uygulamaları arasında paylaşılan yerel önbellekteki belirteçleri kullanarak kimlik doğrulaması yapar.

TokenCachePersistenceOptions

Kalıcı belirteç önbelleğe alma seçenekleri.

Çoğu kimlik bilgisi, kalıcı belirteç önbelleğini yapılandırmak için bu sınıfın bir örneğini kabul eder. Varsayılan değerler, kimlik bilgilerini Microsoft geliştirici araçları ve SharedTokenCacheCredentialile paylaşılan bir önbelleği kullanacak şekilde yapılandırır. Kimlik bilgilerinin verilerini diğer uygulamalardan yalıtmak için önbellek için bir ad belirtin.

Varsayılan olarak, önbellek geçerli platformun kullanıcı veri koruma API'siyle şifrelenir ve bu kullanılabilir olmadığında bir hata oluşturur. Önbelleği hata oluşturmak yerine şifrelenmemiş bir dosyaya geri dönecek şekilde yapılandırmak için allow_unencrypted_storage=True değerini belirtin.

Uyarı

Önbellek, kimlik doğrulama gizli dizilerini içerir. Önbellek şifrelenmemişse, önbelleğin korunması

uygulamasının sorumluluğundadır. İçeriğinin ihlali hesapların güvenliğini tamamen tehlikeye atacaktır.

UsernamePasswordCredential

Kullanıcı adı ve parola ile kullanıcının kimliğini doğrular.

Genel olarak Microsoft, diğer kimlik doğrulama akışlarından daha az güvenli olduğundan bu tür bir kimlik doğrulaması önermez.

Bu kimlik bilgileriyle kimlik doğrulaması etkileşimli olmadığından, çok faktörlü kimlik doğrulaması veya onay isteminin herhangi bir biçimiyle uyumlu değildir. Uygulamanın zaten kullanıcıdan veya dizin yöneticisinden izin almış olması gerekir.

Bu kimlik bilgisi yalnızca iş ve okul hesaplarının kimliğini doğrulayabilir; Microsoft hesapları desteklenmez. Hesap türleri hakkında daha fazla bilgi için bkz. Azure Active Directory belgeleri .

VisualStudioCodeCredential

Azure kullanıcısı 'Azure Hesabı' uzantısı aracılığıyla Visual Studio Code oturum açtığında kimlik doğrulaması yapar.

Bu kimlik bilgilerinin 0.9.11'den yeni Azure Hesabı uzantısı sürümleriyle çalışmaması bilinen bir sorundur. Bu soruna uzun vadeli bir düzeltme devam ediyor. Bu arada ile AzureCliCredentialkimlik doğrulamayı göz önünde bulundurun.

WorkloadIdentityCredential

Azure Active Directory iş yükü kimliği kullanarak kimlik doğrulaması yapar.

İş yükü kimlik doğrulaması, Azure'da sanal makinelerde (VM) çalışan uygulamaların hizmet sorumlusuna veya yönetilen kimliğe gerek kalmadan diğer Azure kaynaklarına erişmesine olanak tanıyan bir özelliktir. İş yükü kimliği kimlik doğrulamasıyla, uygulamalar paylaşılan hizmet sorumlusu veya yönetilen kimlik kullanmak yerine kendi kimliklerini kullanarak kimliklerini doğrular. İş yükü kimliği kimlik doğrulaması, Azure tarafından otomatik olarak oluşturulan ve VM'de güvenli bir şekilde depolanan Hizmet Hesabı Kimlik Bilgileri (SAC) kavramını kullanır. İş yükü kimliği kimlik doğrulamasını kullanarak, her vm'de her uygulama için hizmet sorumlularını veya yönetilen kimlikleri yönetme ve döndürme gereksinimini ortadan kaldırın. Ayrıca, SAC'ler otomatik olarak oluşturulduğundan ve Azure tarafından yönetildiğinden, hassas kimlik bilgilerini depolama ve güvenliğini sağlama konusunda endişelenmeniz gerekmez.

WorkloadIdentityCredential, Azure Kubernetes üzerinde Azure iş yükü kimlik doğrulamasını destekler ve Azure Kubernetes ortamında bulunan hizmet hesabı kimlik bilgilerini kullanarak bir belirteç alır. Daha fazla bilgi için bu iş yükü kimliğine genel bakış konusuna bakın.