@azure/ms-rest-nodeauth package

Sınıflar

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials

Azure CLI aracılığıyla belirteç alarak kimlik bilgilerini açıklar.

DeviceTokenCredentials
MSIAppServiceTokenCredentials

App Service ortamında yönetilen hizmet kimliği belirteci kimlik bilgileri hakkında bilgi sağlar.

MSITokenCredentials

Yönetilen hizmet kimliği belirteci kimlik bilgileri hakkında bilgi sağlar. Bu nesne yalnızca yönetilen hizmet kimliğiyle Azure'da sağlanan bir sanal makinede belirteç almak için kullanılabilir.

MSIVmTokenCredentials

Azure'da sağlanan bir sanal makinede yönetilen hizmet kimliği belirteci kimlik bilgileri hakkında bilgi sağlar.

TokenCredentialsBase
UserTokenCredentials

Arabirimler

AuthResponse

Kimlik doğrulama yanıtını açıklar.

AzureTokenCredentialsOptions

servicePrincipal/gizli kimlik doğrulaması için isteğe bağlı parametreleri açıklar.

CliAccessToken

Azure CLI'dan alınan erişim belirtecini açıklar.

InteractiveLoginOptions

Etkileşimli kimlik doğrulaması için isteğe bağlı parametreleri açıklar.

LinkedSubscription

Kimlik doğrulama işlemi sırasında bulunan abonelik hakkında bilgi sağlar. Bu türün yapısı, ResourceManager API'sine istekte bulunarak alınan abonelik nesnesinden farklıdır.

LinkedUser

Kimlik doğrulaması açısından bir kullanıcı hakkında bilgi sağlar.

ListAllSubscriptionOptions

Azure CLI aracılığıyla tüm abonelikleri/hesapları listelerken sağlanacak seçenekleri açıklar.

LoginWithAuthFileOptions

AuthFile ile oturum açmak için isteğe bağlı parametreleri açıklar.

LoginWithUsernamePasswordOptions

Kullanıcı adı/parola kimlik doğrulaması için isteğe bağlı parametreleri açıklar.

MSIAppServiceOptions

AppService için MSI ile kimlik doğrulaması için isteğe bağlı parametreleri tanımlar.

MSIOptions

MSI ile kimlik doğrulaması için isteğe bağlı parametreleri tanımlar.

MSITokenResponse

MSITokenResponse'yi açıklar.

MSIVmOptions

Sanal Makine için MSI ile kimlik doğrulaması için isteğe bağlı parametreleri tanımlar.

Tür Diğer Adları

TokenAudience
UserType

Kullanıcı türü hakkında bilgi sağlar. Şu anda "user" veya "servicePrincipal" olabilir.

İşlevler

buildTenantList(TokenCredentialsBase, string)

Bir tenantId dizisi oluşturur.

createAuthenticator(MSITokenCredentials)
interactiveLogin()

Bir tarayıcıya kopyalanıp yapıştırılması ve kimlik doğrulamasının orada yapılması gereken bir URL ve kod sağlar. Başarılı olursa, kullanıcı bir DeviceTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini alır.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Bir tarayıcıya kopyalanıp yapıştırılması ve kimlik doğrulamasının orada yapılması gereken bir URL ve kod sağlar. Başarılı olursa, kullanıcı bir DeviceTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini alır.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithAppServiceMSI()

App Service MSI kullanarak kimlik doğrulaması.

loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. Ardından az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}yürütür. Sp'yi farklı bir bulut/ortam için oluşturmak istiyorsanız lütfen şu komutu yürütebilirsiniz:

  1. Az Bulut Listesi
  2. az cloud set –n <ortamın adı>
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Hizmet sorumlusu zaten oluşturulduysa hizmet sorumlusu bilgileriyle oturum açın:
  5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
  6. Az account show --SDK-auth > auth.json

Kimlik doğrulama dosyasında sağlanan hizmet sorumlusu bilgilerini kullanarak kimlik doğrulaması yapar. Bu yöntem, auth dosyasından subscriptionId değerini options parametresinde veya varsayılan "AZURE_SUBSCRIPTION_ID" kullanıcı tarafından sağlanan ortam değişkenine ayarlar.

loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. Ardından az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}yürütür. Sp'yi farklı bir bulut/ortam için oluşturmak istiyorsanız lütfen şu komutu yürütebilirsiniz:

  1. Az Bulut Listesi
  2. az cloud set –n <ortamın adı>
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Hizmet sorumlusu zaten oluşturulduysa hizmet sorumlusu bilgileriyle oturum açın:
  5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
  6. Az account show --SDK-auth > auth.json

Kimlik doğrulama dosyasında sağlanan hizmet sorumlusu bilgilerini kullanarak kimlik doğrulaması yapar. Bu yöntem, auth dosyasından subscriptionId değerini options parametresinde veya varsayılan "AZURE_SUBSCRIPTION_ID" kullanıcı tarafından sağlanan ortam değişkenine ayarlar.

loginWithServicePrincipalCertificate(string, string, string)

Bir ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalCertificate(string, string, string, any)
loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Bir ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithServicePrincipalSecret(string, string, string)

Bir ApplicationTokenCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalSecret(string, string, string, any)
loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Bir ApplicationTokenCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithUsernamePassword(string, string)

Bir UserTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini sağlar.

Bu yöntem yalnızca 2FA etkinleştirilmemiş kuruluş kimlikleri için geçerlidir, aksi takdirde lütfen etkileşimli oturum açma bilgilerini kullanın.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Bir UserTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini sağlar. Bu yöntem yalnızca 2FA etkinleştirilmemiş kuruluş kimlikleri için geçerlidir, aksi takdirde lütfen etkileşimli oturum açma bilgilerini kullanın.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

loginWithVmMSI()

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. az cli ile sağlanan ve MSI etkin bir Azure sanal makineniz varsa, vm'den kimlik doğrulama belirteçleri almak için bu yöntemi kullanabilirsiniz.

Yeni bir VM oluşturmak için MSI'yi etkinleştirin, lütfen şu komutu yürütebilirsiniz: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Not: Yukarıdaki komut konakta varsayılan bağlantı noktası 50342 olan bir hizmet uç noktasını etkinleştirir

Önceden sağlanmış bir VM'de MSI'yi etkinleştirmek için şu komutu yürütebilirsiniz: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Bu komut hakkında daha fazla bilgi edinmek için lütfen şu komutu yürütür: az vm --assign-identity -h

Azure sanal makinesinde çalışan kimlik hizmetini kullanarak kimlik doğrulaması yapar. Bu yöntem, VM'de barındırılan kimlik doğrulama hizmetine bir istekte bulunur ve bir erişim belirteci alır.

loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Değişkenler

AuthConstants

İşlev Ayrıntıları

buildTenantList(TokenCredentialsBase, string)

Bir tenantId dizisi oluşturur.

function buildTenantList(credentials: TokenCredentialsBase, apiVersion?: string): Promise<string[]>

Parametreler

credentials
TokenCredentialsBase

Kimlik bilgileri.

apiVersion

string

varsayılan değer 2016-06-01

Döndürülenler

Promise<string[]>

Bir tenantId dizisine çözümlenip hatayla reddeden bir söz.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parametreler

credentials
MSITokenCredentials

Döndürülenler

interactiveLogin()

Bir tarayıcıya kopyalanıp yapıştırılması ve kimlik doğrulamasının orada yapılması gereken bir URL ve kod sağlar. Başarılı olursa, kullanıcı bir DeviceTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini alır.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen DeviceTokenCredentials nesnesi ve ilgili tüm kiracılar genelinde ilişkili aboneliklerin listesiyle çağrılır.

interactiveLogin(InteractiveLoginOptions)

function interactiveLogin(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>

Parametreler

Döndürülenler

interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function interactiveLogin(options: InteractiveLoginOptions, callback: (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parametreler

callback

(err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void

interactiveLogin(any)

function interactiveLogin(callback: any)

Parametreler

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Bir tarayıcıya kopyalanıp yapıştırılması ve kimlik doğrulamasının orada yapılması gereken bir URL ve kod sağlar. Başarılı olursa, kullanıcı bir DeviceTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini alır.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function interactiveLoginWithAuthResponse(options?: InteractiveLoginOptions): Promise<AuthResponse<DeviceTokenCredentials>>

Parametreler

options
InteractiveLoginOptions

İsteğe bağlı parametreleri temsil eden nesne.

Döndürülenler

"Kimlik bilgileri" ve isteğe bağlı "abonelikler" dizisi içeren ve Bir Hata ile reddeden AuthResponse'a çözümlenen bir Promise.

loginWithAppServiceMSI()

App Service MSI kullanarak kimlik doğrulaması.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen MSIAppServiceTokenCredentials nesnesiyle çağrılır.

loginWithAppServiceMSI(MSIAppServiceOptions)

function loginWithAppServiceMSI(options: MSIAppServiceOptions): Promise<MSIAppServiceTokenCredentials>

Parametreler

Döndürülenler

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(options: MSIAppServiceOptions, callback: Callback<MSIAppServiceTokenCredentials>)

Parametreler

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parametreler

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. Ardından az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}yürütür. Sp'yi farklı bir bulut/ortam için oluşturmak istiyorsanız lütfen şu komutu yürütebilirsiniz:

  1. Az Bulut Listesi
  2. az cloud set –n <ortamın adı>
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Hizmet sorumlusu zaten oluşturulduysa hizmet sorumlusu bilgileriyle oturum açın:
  5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
  6. Az account show --SDK-auth > auth.json

Kimlik doğrulama dosyasında sağlanan hizmet sorumlusu bilgilerini kullanarak kimlik doğrulaması yapar. Bu yöntem, auth dosyasından subscriptionId değerini options parametresinde veya varsayılan "AZURE_SUBSCRIPTION_ID" kullanıcı tarafından sağlanan ortam değişkenine ayarlar.

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen ApplicationTokenCredentials veya ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılar genelinde ilişkili aboneliklerin listesiyle çağrılır.

loginWithAuthFile(LoginWithAuthFileOptions)

function loginWithAuthFile(options: LoginWithAuthFileOptions): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Parametreler

Döndürülenler

loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithAuthFile(options: LoginWithAuthFileOptions, callback: (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Parametreler

callback

(err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parametreler

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. Ardından az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}yürütür. Sp'yi farklı bir bulut/ortam için oluşturmak istiyorsanız lütfen şu komutu yürütebilirsiniz:

  1. Az Bulut Listesi
  2. az cloud set –n <ortamın adı>
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Hizmet sorumlusu zaten oluşturulduysa hizmet sorumlusu bilgileriyle oturum açın:
  5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
  6. Az account show --SDK-auth > auth.json

Kimlik doğrulama dosyasında sağlanan hizmet sorumlusu bilgilerini kullanarak kimlik doğrulaması yapar. Bu yöntem, auth dosyasından subscriptionId değerini options parametresinde veya varsayılan "AZURE_SUBSCRIPTION_ID" kullanıcı tarafından sağlanan ortam değişkenine ayarlar.

function loginWithAuthFileWithAuthResponse(options?: LoginWithAuthFileOptions): Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Parametreler

options
LoginWithAuthFileOptions

İsteğe bağlı parametreler

Döndürülenler

"Kimlik bilgileri" ve isteğe bağlı "abonelikler" dizisi içeren ve Bir Hata ile reddeden AuthResponse'a çözümlenen bir Promise.

loginWithServicePrincipalCertificate(string, string, string)

Bir ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string): Promise<ApplicationTokenCertificateCredentials>

Parametreler

clientId

string

SPN (ServicePrincipal Adı) olarak da bilinen Active Directory uygulama istemci kimliği. Örnek için bkz. .Net için active directory hızlı başlangıcı.

certificateStringOrFilePath

string

PEM ile kodlanmış sertifika ve özel anahtar VEYA bu bilgileri içeren .pem dosyasına mutlak bir dosya yolu. Mesela:

  • CertificateString: "-----BEGIN PRIVATE KEY <-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE <-----\nyyyyy>\n-----END CERTIFICATE-----\n"
  • CertificateFilePath: .pem dosyasının Mutlak dosya yolunu.
domain

string

Bu uygulamayı içeren etki alanı veya kiracı kimliği.

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılardaki ilişkili aboneliklerin listesiyle çağrılır.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCertificateCredentials>

Parametreler

clientId

string

certificateStringOrFilePath

string

domain

string

Döndürülenler

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Parametreler

clientId

string

certificateStringOrFilePath

string

domain

string

callback

(err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalCertificate(string, string, string, any)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, callback: any)

Parametreler

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Bir ApplicationTokenCertificateCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithServicePrincipalCertificateWithAuthResponse(clientId: string, certificateStringOrFilePath: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Parametreler

clientId

string

SPN (ServicePrincipal Adı) olarak da bilinen Active Directory uygulama istemci kimliği. Örnek için bkz. .Net için active directory hızlı başlangıcı.

certificateStringOrFilePath

string

PEM ile kodlanmış sertifika ve özel anahtar VEYA bu bilgileri içeren .pem dosyasına mutlak bir dosya yolu. Mesela:

  • CertificateString: "-----BEGIN PRIVATE KEY <-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE <-----\nyyyyy>\n-----END CERTIFICATE-----\n"
  • CertificateFilePath: .pem dosyasının Mutlak dosya yolunu.
domain

string

Bu uygulamayı içeren etki alanı veya kiracı kimliği.

options
AzureTokenCredentialsOptions

İsteğe bağlı parametreleri temsil eden nesne.

Döndürülenler

"Kimlik bilgileri" ve isteğe bağlı "abonelikler" dizisi içeren ve Bir Hata ile reddeden AuthResponse'a çözümlenen bir Promise.

loginWithServicePrincipalSecret(string, string, string)

Bir ApplicationTokenCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string): Promise<ApplicationTokenCredentials>

Parametreler

clientId

string

SPN (ServicePrincipal Adı) olarak da bilinen Active Directory uygulama istemci kimliği. Örnek için bkz. .Net için active directory hızlı başlangıcı.

secret

string

Hizmet sorumlusu için uygulama gizli dizisi.

domain

string

Bu uygulamayı içeren etki alanı veya kiracı kimliği.

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen ApplicationTokenCredentials nesnesi ve ilgili tüm kiracılar genelinde ilişkili aboneliklerin listesiyle çağrılır.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>

Parametreler

clientId

string

secret

string

domain

string

Döndürülenler

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parametreler

clientId

string

secret

string

domain

string

callback

(err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalSecret(string, string, string, any)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, callback: any)

Parametreler

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Bir ApplicationTokenCredentials nesnesi ve ilgili tüm kiracılarda bu servicePrincipalId/clientId ile ilişkili aboneliklerin listesini sağlar.

Kişisel hesapları kullanırken, domain parametresinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithServicePrincipalSecretWithAuthResponse(clientId: string, secret: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCredentials>>

Parametreler

clientId

string

SPN (ServicePrincipal Adı) olarak da bilinen Active Directory uygulama istemci kimliği. Örnek için bkz. .Net için active directory hızlı başlangıcı.

secret

string

Hizmet sorumlusu için uygulama gizli dizisi.

domain

string

Bu uygulamayı içeren etki alanı veya kiracı kimliği.

options
AzureTokenCredentialsOptions

İsteğe bağlı parametreleri temsil eden nesne.

Döndürülenler

"Kimlik bilgileri" ve isteğe bağlı "abonelikler" dizisi içeren ve Bir Hata ile reddeden AuthResponse'a çözümlenen bir Promise.

loginWithUsernamePassword(string, string)

Bir UserTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini sağlar.

Bu yöntem yalnızca 2FA etkinleştirilmemiş kuruluş kimlikleri için geçerlidir, aksi takdirde lütfen etkileşimli oturum açma bilgilerini kullanın.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithUsernamePassword(username: string, password: string): Promise<UserTokenCredentials>

Parametreler

username

string

Kuruluş Kimliği hesabının kullanıcı adı.

password

string

Kuruluş Kimliği hesabının parolası.

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen UserTokenCredentials nesnesi ve ilgili tüm kiracılardaki ilişkili aboneliklerin listesiyle çağrılır.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions): Promise<UserTokenCredentials>

Parametreler

username

string

password

string

Döndürülenler

loginWithUsernamePassword(string, string, any)

function loginWithUsernamePassword(username: string, password: string, callback: any)

Parametreler

username

string

password

string

callback

any

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions, callback: (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Parametreler

username

string

password

string

callback

(err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Bir UserTokenCredentials nesnesi ve ilgili tüm kiracılarda bu userId ile ilişkili aboneliklerin listesini sağlar. Bu yöntem yalnızca 2FA etkinleştirilmemiş kuruluş kimlikleri için geçerlidir, aksi takdirde lütfen etkileşimli oturum açma bilgilerini kullanın.

Kişisel hesapları kullanırken, domain parametresindeki options özelliğinin söz konusu hesabın kiracı kimliğine ayarlanması gerekir. Aksi takdirde, sonuçta elde edilen kimlik bilgileri hesabın kaynaklarına erişemez.

function loginWithUsernamePasswordWithAuthResponse(username: string, password: string, options?: LoginWithUsernamePasswordOptions): Promise<AuthResponse<UserTokenCredentials>>

Parametreler

username

string

Kuruluş Kimliği hesabının kullanıcı adı.

password

string

Kuruluş Kimliği hesabının parolası.

options
LoginWithUsernamePasswordOptions

İsteğe bağlı parametreleri temsil eden nesne.

Döndürülenler

credentials ve isteğe bağlı bir subscriptions dizisi içeren ve hatayla reddeden AuthResponse'a çözümlenen bir Promise.

loginWithVmMSI()

Bu yöntemi kullanmadan önce lütfen https://github.com/Azure/azure-cli/releases'den az cli yükleyin. az cli ile sağlanan ve MSI etkin bir Azure sanal makineniz varsa, vm'den kimlik doğrulama belirteçleri almak için bu yöntemi kullanabilirsiniz.

Yeni bir VM oluşturmak için MSI'yi etkinleştirin, lütfen şu komutu yürütebilirsiniz: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Not: Yukarıdaki komut konakta varsayılan bağlantı noktası 50342 olan bir hizmet uç noktasını etkinleştirir

Önceden sağlanmış bir VM'de MSI'yi etkinleştirmek için şu komutu yürütebilirsiniz: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Bu komut hakkında daha fazla bilgi edinmek için lütfen şu komutu yürütür: az vm --assign-identity -h

Azure sanal makinesinde çalışan kimlik hizmetini kullanarak kimlik doğrulaması yapar. Bu yöntem, VM'de barındırılan kimlik doğrulama hizmetine bir istekte bulunur ve bir erişim belirteci alır.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Döndürülenler

Bir geri çağırma son parametre olarak geçirildiyse void döndürür, else işlevi bir Promise döndürür. Geri çağırma, sonuçta elde edilen MSIVmTokenCredentials nesnesiyle çağrılır.

loginWithVmMSI(MSIVmOptions)

function loginWithVmMSI(options: MSIVmOptions): Promise<MSIVmTokenCredentials>

Parametreler

options
MSIVmOptions

Döndürülenler

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(options: MSIVmOptions, callback: Callback<MSIVmTokenCredentials>)

Parametreler

options
MSIVmOptions
callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parametreler

callback

Callback<MSIVmTokenCredentials>

Variable Details

AuthConstants

AuthConstants: { AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }

Tür

{ AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }