MSIAppServiceTokenCredentials class

يوفر معلومات حول بيانات اعتماد الرمز المميز لهوية الخدمة المدارة في بيئة App Service.

يمتد

المنشئون

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

إنشاء مثيل MSIAppServiceTokenCredentials.

الخصائص

clientId

معرف العميل للهوية المدارة التي ترغب في الرمز المميز لها. مطلوب، إذا كانت خدمة التطبيق الخاصة بك تحتوي على هويات مدارة يعينها المستخدم.

msiApiVersion

إصدار واجهة برمجة التطبيقات لعامل MSI المحلي. القيمة الافتراضية هي "2017-09-01".

msiEndpoint

عنوان URL المحلي الذي يمكن لتطبيقك طلب الرموز المميزة منه. ما لم يتم تحديد هذه الخاصية، سيتم استخدام أي من متغيري البيئة IDENTITY_ENDPOINT أو MSI_ENDPOINT كقيمة افتراضية.

msiSecret

السر المستخدم في الاتصال بين التعليمات البرمجية الخاصة بك وعامل MSI المحلي. ما لم يتم تحديد هذه الخاصية، سيتم استخدام أي من متغيري البيئة IDENTITY_SECRET أو MSI_SECRET كقيمة افتراضية.

الخصائص الموروثة

resource

نقاط نهاية مورد Azure.

  • الإعدادات الافتراضية ل Azure Resource Manager من البيئة: AzureCloud. "https://management.azure.com/"؛
  • لإدارة الخدمة (ASM): "https://management.core.windows.net/"
  • بالنسبة إلى Azure KeyVault: "https://vault.azure.net"
  • بالنسبة إلى Azure Batch: "https://batch.core.windows.net"
  • بالنسبة إلى Azure Active Directory Graph: "https://graph.windows.net"

الأساليب

getToken()

إعداد طلب GET وإرساله إلى نقطة نهاية خدمة تشير إليها خدمة التطبيق، والتي تستجيب برمز الوصول المميز.

الأساليب المتوارثة

parseTokenResponse(string)

تحليل سلسلة tokenResponse json إلى كائن، وتحويل الخصائص على المستوى الأول إلى camelCase. يحاول هذا الأسلوب توحيد tokenResponse

signRequest(WebResource)

توقيع طلب باستخدام عنوان المصادقة.

تفاصيل المنشئ

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

إنشاء مثيل MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

المعلمات

تفاصيل الخاصية

clientId

معرف العميل للهوية المدارة التي ترغب في الرمز المميز لها. مطلوب، إذا كانت خدمة التطبيق الخاصة بك تحتوي على هويات مدارة يعينها المستخدم.

clientId?: string

قيمة الخاصية

string

msiApiVersion

إصدار واجهة برمجة التطبيقات لعامل MSI المحلي. القيمة الافتراضية هي "2017-09-01".

msiApiVersion?: string

قيمة الخاصية

string

msiEndpoint

عنوان URL المحلي الذي يمكن لتطبيقك طلب الرموز المميزة منه. ما لم يتم تحديد هذه الخاصية، سيتم استخدام أي من متغيري البيئة IDENTITY_ENDPOINT أو MSI_ENDPOINT كقيمة افتراضية.

msiEndpoint: string

قيمة الخاصية

string

msiSecret

السر المستخدم في الاتصال بين التعليمات البرمجية الخاصة بك وعامل MSI المحلي. ما لم يتم تحديد هذه الخاصية، سيتم استخدام أي من متغيري البيئة IDENTITY_SECRET أو MSI_SECRET كقيمة افتراضية.

msiSecret: string

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

resource

نقاط نهاية مورد Azure.

  • الإعدادات الافتراضية ل Azure Resource Manager من البيئة: AzureCloud. "https://management.azure.com/"؛
  • لإدارة الخدمة (ASM): "https://management.core.windows.net/"
  • بالنسبة إلى Azure KeyVault: "https://vault.azure.net"
  • بالنسبة إلى Azure Batch: "https://batch.core.windows.net"
  • بالنسبة إلى Azure Active Directory Graph: "https://graph.windows.net"
resource: string

قيمة الخاصية

string

موروث منMSITokenCredentials.resource

تفاصيل الأسلوب

getToken()

إعداد طلب GET وإرساله إلى نقطة نهاية خدمة تشير إليها خدمة التطبيق، والتي تستجيب برمز الوصول المميز.

function getToken(): Promise<MSITokenResponse>

المرتجعات

Promise<MSITokenResponse>

وعد مع tokenResponse (tokenType وaccessToken هما الخاصيتان المهمتان).

تفاصيل الأساليب المتوارثة

parseTokenResponse(string)

تحليل سلسلة tokenResponse json إلى كائن، وتحويل الخصائص على المستوى الأول إلى camelCase. يحاول هذا الأسلوب توحيد tokenResponse

function parseTokenResponse(body: string): TokenResponse

المعلمات

body

string

سلسلة json

المرتجعات

TokenResponse

الرمز المميزالمسؤولية (tokenType وaccessToken هما الخاصيتان المهمتان).

موروث منMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

توقيع طلب باستخدام عنوان المصادقة.

function signRequest(webResource: WebResource): Promise<WebResource>

المعلمات

webResource
WebResource

WebResource الذي سيتم توقيعه.

المرتجعات

Promise<WebResource>

وعد باستخدام WebResource الموقع.

موروث منMSITokenCredentials.signRequest