Udostępnij za pośrednictwem

MSIAppServiceTokenCredentials class

  • Odwołanie
Pakiet:
@azure/ms-rest-nodeauth

Zawiera informacje o poświadczeniach tokenu tożsamości usługi zarządzanej w środowisku App Service.

Extends
MSITokenCredentials

Konstruktory

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Tworzy wystąpienie msiAppServiceTokenCredentials.

Właściwości

clientId

ClientId tożsamości zarządzanej, dla której chcesz utworzyć token. Wymagane, jeśli usługa App Service ma tożsamości zarządzane przypisane przez użytkownika.
msiApiVersion

Wersja interfejsu API lokalnego agenta MSI. Wartość domyślna to "2017-09-01".
msiEndpoint

Lokalny adres URL, z którego aplikacja może żądać tokenów. O ile ta właściwość nie zostanie określona, dowolna z dwóch zmiennych IDENTITY_ENDPOINT środowiskowych lub MSI_ENDPOINT zostanie użyta jako wartość domyślna.
msiSecret

Wpis tajny używany w komunikacji między kodem a lokalnym agentem MSI. O ile ta właściwość nie zostanie określona, dowolna z dwóch zmiennych IDENTITY_SECRET środowiskowych lub MSI_SECRET zostanie użyta jako wartość domyślna.

Właściwości dziedziczone

resource

Punkty końcowe zasobów platformy Azure.

  • Wartość domyślna to Azure Resource Manager ze środowiska: AzureCloud. "https://management.azure.com/"
  • W przypadku usługi ServiceManagement (ASM): "https://management.core.windows.net/"
  • W przypadku usługi Azure KeyVault: "https://vault.azure.net"
  • Dla Azure Batch: "https://batch.core.windows.net"
  • W przypadku programu Graph usługi Azure Active Directory: "https://graph.windows.net"

Metody

getToken()

Przygotowuje i wysyła żądanie GET do punktu końcowego usługi wskazanego przez usługę App Service, który odpowiada za pomocą tokenu dostępu.

Metody dziedziczone

parseTokenResponse(string)

Analizuje ciąg json tokenResponse w obiekt i konwertuje właściwości na pierwszym poziomie na camelCase. Ta metoda próbuje ustandaryzować tokenResponse
signRequest(WebResource)

Podpisuje żądanie z nagłówkiem Uwierzytelnianie.

Szczegóły konstruktora

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Tworzy wystąpienie msiAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Parametry

options
MSIAppServiceOptions

Szczegóły właściwości

clientId

ClientId tożsamości zarządzanej, dla której chcesz utworzyć token. Wymagane, jeśli usługa App Service ma tożsamości zarządzane przypisane przez użytkownika.

clientId?: string

Wartość właściwości

string

msiApiVersion

Wersja interfejsu API lokalnego agenta MSI. Wartość domyślna to "2017-09-01".

msiApiVersion?: string

Wartość właściwości

string

msiEndpoint

Lokalny adres URL, z którego aplikacja może żądać tokenów. O ile ta właściwość nie zostanie określona, dowolna z dwóch zmiennych IDENTITY_ENDPOINT środowiskowych lub MSI_ENDPOINT zostanie użyta jako wartość domyślna.

msiEndpoint: string

Wartość właściwości

string

msiSecret

Wpis tajny używany w komunikacji między kodem a lokalnym agentem MSI. O ile ta właściwość nie zostanie określona, dowolna z dwóch zmiennych IDENTITY_SECRET środowiskowych lub MSI_SECRET zostanie użyta jako wartość domyślna.

msiSecret: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

resource

Punkty końcowe zasobów platformy Azure.

  • Wartość domyślna to Azure Resource Manager ze środowiska: AzureCloud. "https://management.azure.com/"
  • W przypadku usługi ServiceManagement (ASM): "https://management.core.windows.net/"
  • W przypadku usługi Azure KeyVault: "https://vault.azure.net"
  • Dla Azure Batch: "https://batch.core.windows.net"
  • W przypadku programu Graph usługi Azure Active Directory: "https://graph.windows.net"
resource: string

Wartość właściwości

string

Dziedziczone zpliku MSITokenCredentials.resource

Szczegóły metody

getToken()

Przygotowuje i wysyła żądanie GET do punktu końcowego usługi wskazanego przez usługę App Service, który odpowiada za pomocą tokenu dostępu.

function getToken(): Promise<MSITokenResponse>

Zwraca

Promise<MSITokenResponse>

Promise with the tokenResponse (tokenType i accessToken to dwie ważne właściwości).

Szczegóły metody dziedziczonej

parseTokenResponse(string)

Analizuje ciąg json tokenResponse w obiekt i konwertuje właściwości na pierwszym poziomie na camelCase. Ta metoda próbuje ustandaryzować tokenResponse

function parseTokenResponse(body: string): TokenResponse

Parametry

body

string

Ciąg json

Zwraca

TokenResponse

TokenResponse (tokenType i accessToken to dwie ważne właściwości).

Dziedziczone zmsiTokenCredentials.parseTokenResponse

signRequest(WebResource)

Podpisuje żądanie z nagłówkiem Uwierzytelnianie.

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

Parametry

webResource
WebResource

Element WebResource do podpisania.

Zwraca

Promise<WebResource>

Promise z podpisaną usługą WebResource.

Dziedziczone zmsiTokenCredentials.signRequest