@azure/ms-rest-nodeauth package

الفصول

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	يصف بيانات الاعتماد عن طريق استرداد الرمز المميز عبر Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	يوفر معلومات حول بيانات اعتماد الرمز المميز لهوية الخدمة المدارة في بيئة App Service.
MSITokenCredentials	يوفر معلومات حول بيانات اعتماد الرمز المميز لهوية الخدمة المدارة. يمكن استخدام هذا الكائن فقط للحصول على رمز مميز على جهاز ظاهري تم توفيره في Azure مع هوية الخدمة المدارة.
MSIVmTokenCredentials	يوفر معلومات حول بيانات اعتماد الرمز المميز لهوية الخدمة المدارة على جهاز ظاهري تم توفيره في Azure.
TokenCredentialsBase
UserTokenCredentials

الواجهات

AuthResponse	يصف استجابة المصادقة.
AzureTokenCredentialsOptions	توضح هذه المقالة المعلمات الاختيارية للمصادقة السرية/servicePrincipal.
CliAccessToken	يصف رمز الوصول الذي تم استرداده من Azure CLI.
InteractiveLoginOptions	يصف المعلمات الاختيارية للمصادقة التفاعلية.
LinkedSubscription	يوفر معلومات حول الاشتراك الذي تم العثور عليه أثناء عملية المصادقة. تختلف بنية هذا النوع عن كائن الاشتراك الذي يحصل عليه المرء عن طريق تقديم طلب إلى ResourceManager API.
LinkedUser	يوفر معلومات حول مستخدم من منظور المصادقة.
ListAllSubscriptionOptions	توضح هذه المقالة الخيارات التي يمكن توفيرها أثناء سرد جميع الاشتراكات/الحسابات عبر Azure CLI.
LoginWithAuthFileOptions	يصف المعلمات الاختيارية لتسجيل الدخول باستخدامAuthFile.
LoginWithUsernamePasswordOptions	يصف المعلمات الاختيارية لمصادقة اسم المستخدم/كلمة المرور.
MSIAppServiceOptions	يحدد المعلمات الاختيارية للمصادقة باستخدام MSI ل AppService.
MSIOptions	تعريف المعلمات الاختيارية للمصادقة باستخدام MSI.
MSITokenResponse	يصف MSITokenResponse.
MSIVmOptions	يحدد المعلمات الاختيارية للمصادقة باستخدام MSI للجهاز الظاهري.

النوع أسماء مستعارة

TokenAudience
UserType	يوفر معلومات حول نوع المستخدم. يمكن أن يكون حاليا "مستخدم" أو "servicePrincipal".

الوظائف

buildTenantList(TokenCredentialsBase, string)	ينشئ صفيفا من tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	يوفر عنوان URL ورمز يحتاج إلى نسخ ولصق في مستعرض ومصادقة هناك. إذا نجحت، فسيحصل المستخدم على كائن DeviceTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	يوفر عنوان URL ورمز يحتاج إلى نسخ ولصق في مستعرض ومصادقة هناك. إذا نجحت، فسيحصل المستخدم على كائن DeviceTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
loginWithAppServiceMSI()	المصادقة باستخدام App Service MSI.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. ثم قم بتنفيذ az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. إذا كنت ترغب في إنشاء sp لمجموعة/بيئة مختلفة، فيرجى تنفيذ: قائمة سحابة az az cloud set –n <اسم البيئة> az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate إذا تم إنشاء كيان الخدمة بالفعل ، فقم بتسجيل الدخول باستخدام معلومات كيان الخدمة: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> عرض حساب أريزونا --SDK-auth > auth.json المصادقة باستخدام المعلومات الأساسية للخدمة المتوفرة في ملف المصادقة. سيقوم هذا الأسلوب بتعيين معرف الاشتراك من ملف المصادقة إلى متغير البيئة المقدم من المستخدم في معلمة الخيارات أو "AZURE_SUBSCRIPTION_ID" الافتراضي.
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. ثم قم بتنفيذ az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. إذا كنت ترغب في إنشاء sp لمجموعة/بيئة مختلفة، فيرجى تنفيذ: قائمة سحابة az az cloud set –n <اسم البيئة> az ad sp create-for-rbac --sdk-auth > auth.json // create SP with secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate إذا تم إنشاء كيان الخدمة بالفعل ، فقم بتسجيل الدخول باستخدام معلومات كيان الخدمة: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> عرض حساب أريزونا --SDK-auth > auth.json المصادقة باستخدام المعلومات الأساسية للخدمة المتوفرة في ملف المصادقة. سيقوم هذا الأسلوب بتعيين معرف الاشتراك من ملف المصادقة إلى متغير البيئة المقدم من المستخدم في معلمة الخيارات أو "AZURE_SUBSCRIPTION_ID" الافتراضي.
loginWithServicePrincipalCertificate(string, string, string)	يوفر كائن ApplicationTokenCertificateCredentials وقائمة الاشتراكات المقترنة بهذا servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
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)	يوفر كائن ApplicationTokenCertificateCredentials وقائمة الاشتراكات المقترنة بهذا servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
loginWithServicePrincipalSecret(string, string, string)	يوفر كائن ApplicationTokenCredentials وقائمة الاشتراكات المقترنة ب servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
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)	يوفر كائن ApplicationTokenCredentials وقائمة الاشتراكات المقترنة ب servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق. عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
loginWithUsernamePassword(string, string)	يوفر كائن UserTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق. هذا الأسلوب قابل للتطبيق فقط على المعرف التنظيمي الذي لم يتم تمكين 2FA وإلا يرجى استخدام تسجيل الدخول التفاعلي. عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	يوفر كائن UserTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق. هذا الأسلوب قابل للتطبيق فقط على المعرف التنظيمي الذي لم يتم تمكين 2FA وإلا يرجى استخدام تسجيل الدخول التفاعلي. عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.
loginWithVmMSI()	قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. إذا كان لديك جهاز ظاهري Azure مزود ب az cli وتم تمكين MSI له، يمكنك بعد ذلك استخدام هذا الأسلوب للحصول على رموز المصادقة المميزة من الجهاز الظاهري. لإنشاء جهاز ظاهري جديد، قم بتمكين MSI، يرجى تنفيذ هذا الأمر: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> ملاحظة: يتيح الأمر أعلاه نقطة نهاية خدمة على المضيف، مع منفذ افتراضي 50342 لتمكين MSI على جهاز ظاهري تم توفيره بالفعل، نفذ الأمر التالي: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> لمعرفة المزيد حول هذا الأمر، يرجى التنفيذ: az vm --assign-identity -h المصادقة باستخدام خدمة الهوية التي تعمل على جهاز Azure الظاهري. يقدم هذا الأسلوب طلبا إلى خدمة المصادقة المستضافة على الجهاز الظاهري ويعيد رمز الوصول.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

المتغيرات

AuthConstants

تفاصيل الوظيفة

buildTenantList(TokenCredentialsBase, string)

ينشئ صفيفا من tenantIds.

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

المعلمات

credentials

TokenCredentialsBase

بيانات الاعتماد.

apiVersion

string

القيمة الافتراضية 2016-06-01

المرتجعات

Promise<string[]>

وعد يحل إلى صفيف tenantIds ويرفض مع خطأ.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

المعلمات

credentials

MSITokenCredentials

المرتجعات

Authenticator

interactiveLogin()

يوفر عنوان URL ورمز يحتاج إلى نسخ ولصق في مستعرض ومصادقة هناك. إذا نجحت، فسيحصل المستخدم على كائن DeviceTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

function interactiveLogin(): Promise<DeviceTokenCredentials>

المرتجعات

Promise<DeviceTokenCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن DeviceTokenCredentials الناتج وقائمة الاشتراكات المقترنة عبر جميع المستأجرين القابلين للتطبيق.

interactiveLogin(InteractiveLoginOptions)

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

المعلمات

options

InteractiveLoginOptions

المرتجعات

Promise<DeviceTokenCredentials>

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

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

المعلمات

options

InteractiveLoginOptions

callback

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

interactiveLogin(any)

function interactiveLogin(callback: any)

المعلمات

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

يوفر عنوان URL ورمز يحتاج إلى نسخ ولصق في مستعرض ومصادقة هناك. إذا نجحت، فسيحصل المستخدم على كائن DeviceTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

options

InteractiveLoginOptions

كائن يمثل معلمات اختيارية.

المرتجعات

Promise<AuthResponse<DeviceTokenCredentials>>

وعد يتم حله إلى AuthResponse، والذي يحتوي على صفيف "بيانات الاعتماد" و"الاشتراكات" الاختياري ويرفض بخطأ.

loginWithAppServiceMSI()

المصادقة باستخدام App Service MSI.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

المرتجعات

Promise<MSIAppServiceTokenCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن MSIAppServiceTokenCredentials الناتج.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

المعلمات

options

MSIAppServiceOptions

المرتجعات

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

المعلمات

options

MSIAppServiceOptions

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

المعلمات

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. ثم قم بتنفيذ az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. إذا كنت ترغب في إنشاء sp لمجموعة/بيئة مختلفة، فيرجى تنفيذ:

1. قائمة سحابة az
2. az cloud set –n <اسم البيئة>
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 إذا تم إنشاء كيان الخدمة بالفعل ، فقم بتسجيل الدخول باستخدام معلومات كيان الخدمة:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. عرض حساب أريزونا --SDK-auth > auth.json

المصادقة باستخدام المعلومات الأساسية للخدمة المتوفرة في ملف المصادقة. سيقوم هذا الأسلوب بتعيين معرف الاشتراك من ملف المصادقة إلى متغير البيئة المقدم من المستخدم في معلمة الخيارات أو "AZURE_SUBSCRIPTION_ID" الافتراضي.

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

المرتجعات

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن ApplicationTokenCredentials أو ApplicationTokenCertificateCredentials الناتج وقائمة الاشتراكات المقترنة عبر جميع المستأجرين القابلين للتطبيق.

loginWithAuthFile(LoginWithAuthFileOptions)

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

المعلمات

options

LoginWithAuthFileOptions

المرتجعات

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

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

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

المعلمات

options

LoginWithAuthFileOptions

callback

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

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

المعلمات

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. ثم قم بتنفيذ az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. إذا كنت ترغب في إنشاء sp لمجموعة/بيئة مختلفة، فيرجى تنفيذ:

1. قائمة سحابة az
2. az cloud set –n <اسم البيئة>
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 إذا تم إنشاء كيان الخدمة بالفعل ، فقم بتسجيل الدخول باستخدام معلومات كيان الخدمة:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. عرض حساب أريزونا --SDK-auth > auth.json

المصادقة باستخدام المعلومات الأساسية للخدمة المتوفرة في ملف المصادقة. سيقوم هذا الأسلوب بتعيين معرف الاشتراك من ملف المصادقة إلى متغير البيئة المقدم من المستخدم في معلمة الخيارات أو "AZURE_SUBSCRIPTION_ID" الافتراضي.

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

المعلمات

options

LoginWithAuthFileOptions

المعلمات الاختيارية

المرتجعات

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

وعد يتم حله إلى AuthResponse، والذي يحتوي على صفيف "بيانات الاعتماد" و"الاشتراكات" الاختياري ويرفض بخطأ.

loginWithServicePrincipalCertificate(string, string, string)

يوفر كائن ApplicationTokenCertificateCredentials وقائمة الاشتراكات المقترنة بهذا servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

clientId

string

معرف عميل تطبيق active Directory المعروف أيضا باسم SPN (اسم ServicePrincipal). راجع التشغيل السريع ل Active Directory ل .Net للحصول على مثال.

certificateStringOrFilePath

string

شهادة مشفرة من PEM ومفتاح خاص أو مسار ملف مطلق إلى ملف .pem الذي يحتوي على تلك المعلومات. على سبيل المثال:

• CertificateString: "-----ابدأ المفتاح <الخاص-----\nxxxxx>\n-----المفتاح الخاص النهائي-----\n-----ابدأ الشهادة <-----\nyyyyy>\n-----شهادة النهاية-----\n"
• CertificateFilePath: مسار ملف المطلق لملف .pem.

domain

string

معرف المجال أو المستأجر الذي يحتوي على هذا التطبيق.

المرتجعات

Promise<ApplicationTokenCertificateCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن ApplicationTokenCertificateCredentials الناتج وقائمة الاشتراكات المقترنة عبر جميع المستأجرين القابلين للتطبيق.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

المعلمات

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

المرتجعات

Promise<ApplicationTokenCertificateCredentials>

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)

المعلمات

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

callback

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

loginWithServicePrincipalCertificate(string, string, string, any)

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

المعلمات

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

يوفر كائن ApplicationTokenCertificateCredentials وقائمة الاشتراكات المقترنة بهذا servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

clientId

string

معرف عميل تطبيق active Directory المعروف أيضا باسم SPN (اسم ServicePrincipal). راجع التشغيل السريع ل Active Directory ل .Net للحصول على مثال.

certificateStringOrFilePath

string

شهادة مشفرة من PEM ومفتاح خاص أو مسار ملف مطلق إلى ملف .pem الذي يحتوي على تلك المعلومات. على سبيل المثال:

• CertificateString: "-----ابدأ المفتاح <الخاص-----\nxxxxx>\n-----المفتاح الخاص النهائي-----\n-----ابدأ الشهادة <-----\nyyyyy>\n-----شهادة النهاية-----\n"
• CertificateFilePath: مسار ملف المطلق لملف .pem.

domain

string

معرف المجال أو المستأجر الذي يحتوي على هذا التطبيق.

options

AzureTokenCredentialsOptions

كائن يمثل معلمات اختيارية.

المرتجعات

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

وعد يتم حله إلى AuthResponse، والذي يحتوي على صفيف "بيانات الاعتماد" و"الاشتراكات" الاختياري ويرفض بخطأ.

loginWithServicePrincipalSecret(string, string, string)

يوفر كائن ApplicationTokenCredentials وقائمة الاشتراكات المقترنة ب servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

clientId

string

معرف عميل تطبيق active Directory المعروف أيضا باسم SPN (اسم ServicePrincipal). راجع التشغيل السريع ل Active Directory ل .Net للحصول على مثال.

secret

string

سر التطبيق لمدير الخدمة.

domain

string

معرف المجال أو المستأجر الذي يحتوي على هذا التطبيق.

المرتجعات

Promise<ApplicationTokenCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن ApplicationTokenCredentials الناتج وقائمة الاشتراكات المقترنة عبر جميع المستأجرين القابلين للتطبيق.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

المعلمات

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

المرتجعات

Promise<ApplicationTokenCredentials>

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)

المعلمات

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

callback

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

loginWithServicePrincipalSecret(string, string, string, any)

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

المعلمات

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

يوفر كائن ApplicationTokenCredentials وقائمة الاشتراكات المقترنة ب servicePrincipalId/clientId عبر جميع المستأجرين القابلين للتطبيق.

عند استخدام الحسابات الشخصية، يلزم تعيين المعلمة domain إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

clientId

string

معرف عميل تطبيق active Directory المعروف أيضا باسم SPN (اسم ServicePrincipal). راجع التشغيل السريع ل Active Directory ل .Net للحصول على مثال.

secret

string

سر التطبيق لمدير الخدمة.

domain

string

معرف المجال أو المستأجر الذي يحتوي على هذا التطبيق.

options

AzureTokenCredentialsOptions

كائن يمثل معلمات اختيارية.

المرتجعات

Promise<AuthResponse<ApplicationTokenCredentials>>

وعد يتم حله إلى AuthResponse، والذي يحتوي على صفيف "بيانات الاعتماد" و"الاشتراكات" الاختياري ويرفض بخطأ.

loginWithUsernamePassword(string, string)

يوفر كائن UserTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق.

هذا الأسلوب قابل للتطبيق فقط على المعرف التنظيمي الذي لم يتم تمكين 2FA وإلا يرجى استخدام تسجيل الدخول التفاعلي.

عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

username

string

اسم المستخدم لحساب معرف المؤسسة.

password

string

كلمة المرور لحساب معرف المؤسسة.

المرتجعات

Promise<UserTokenCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن UserTokenCredentials الناتج وقائمة الاشتراكات المقترنة عبر جميع المستأجرين القابلين للتطبيق.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

المعلمات

username

string

password

string

options

LoginWithUsernamePasswordOptions

المرتجعات

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

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

المعلمات

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)

المعلمات

username

string

password

string

options

LoginWithUsernamePasswordOptions

callback

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

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

يوفر كائن UserTokenCredentials وقائمة الاشتراكات المقترنة بمعرف المستخدم هذا عبر جميع المستأجرين القابلين للتطبيق. هذا الأسلوب قابل للتطبيق فقط على المعرف التنظيمي الذي لم يتم تمكين 2FA وإلا يرجى استخدام تسجيل الدخول التفاعلي.

عند استخدام الحسابات الشخصية، يلزم تعيين الخاصية domain في المعلمة options إلى معرف مستأجر لهذا الحساب. وإلا، لن تتمكن بيانات الاعتماد الناتجة من الوصول إلى موارد الحساب.

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

المعلمات

username

string

اسم المستخدم لحساب معرف المؤسسة.

password

string

كلمة المرور لحساب معرف المؤسسة.

options

LoginWithUsernamePasswordOptions

كائن يمثل معلمات اختيارية.

المرتجعات

Promise<AuthResponse<UserTokenCredentials>>

وعد يتم حله إلى AuthResponse، والذي يحتوي على credentials وصفيف subscriptions اختياري، ويرفض بخطأ.

loginWithVmMSI()

قبل استخدام هذا الأسلوب، يرجى تثبيت az cli من https://github.com/Azure/azure-cli/releases. إذا كان لديك جهاز ظاهري Azure مزود ب az cli وتم تمكين MSI له، يمكنك بعد ذلك استخدام هذا الأسلوب للحصول على رموز المصادقة المميزة من الجهاز الظاهري.

لإنشاء جهاز ظاهري جديد، قم بتمكين MSI، يرجى تنفيذ هذا الأمر: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> ملاحظة: يتيح الأمر أعلاه نقطة نهاية خدمة على المضيف، مع منفذ افتراضي 50342

لتمكين MSI على جهاز ظاهري تم توفيره بالفعل، نفذ الأمر التالي: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

لمعرفة المزيد حول هذا الأمر، يرجى التنفيذ: az vm --assign-identity -h

المصادقة باستخدام خدمة الهوية التي تعمل على جهاز Azure الظاهري. يقدم هذا الأسلوب طلبا إلى خدمة المصادقة المستضافة على الجهاز الظاهري ويعيد رمز الوصول.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

المرتجعات

Promise<MSIVmTokenCredentials>

إذا تم تمرير رد الاتصال كمعلمة أخيرة، فإنه يرجع فراغا آخر يرجع وعدا. يتم استدعاء رد الاتصال مع كائن MSIVmTokenCredentials الناتج.

loginWithVmMSI(MSIVmOptions)

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

المعلمات

options

MSIVmOptions

المرتجعات

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

المعلمات

options

MSIVmOptions

callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

المعلمات

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 }

النوع

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