MSIAppServiceTokenCredentials class

Pakiet:

@azure/ms-rest-nodeauth

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

Rozszerzenie

MSITokenCredentials

Konstruktory

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Tworzy wystąpienie obiektu 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. Jeśli ta właściwość nie zostanie określona, każda z dwóch zmiennych środowiskowych IDENTITY_ENDPOINT lub MSI_ENDPOINT będzie używana jako wartość domyślna.
msiSecret	Wpis tajny używany w komunikacji między kodem a lokalnym agentem MSI. Jeśli ta właściwość nie zostanie określona, każda z dwóch zmiennych środowiskowych IDENTITY_SECRET lub MSI_SECRET będzie używana jako wartość domyślna.

Właściwości dziedziczone

resource

Punkty końcowe zasobów platformy Azure. Domyślnie usługa 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" W przypadku usługi Azure Batch: "https://batch.core.windows.net" W przypadku usługi Azure Active Directory Graph: "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 standaryzacji tokenResponse
signRequest(WebResource)	Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

Szczegóły konstruktora

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Tworzy wystąpienie obiektu 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. Jeśli ta właściwość nie zostanie określona, każda z dwóch zmiennych środowiskowych IDENTITY_ENDPOINT lub MSI_ENDPOINT będzie używana 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. Jeśli ta właściwość nie zostanie określona, każda z dwóch zmiennych środowiskowych IDENTITY_SECRET lub MSI_SECRET będzie używana 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.

• Domyślnie usługa 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"
• W przypadku usługi Azure Batch: "https://batch.core.windows.net"
• W przypadku usługi Azure Active Directory Graph: "https://graph.windows.net"

resource: string

Wartość właściwości

string

dziedziczone zMSITokenCredentials.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>

Obiecaj tokenResponse (tokenType i accessToken są dwiema ważnymi właściwościami).

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 standaryzacji tokenResponse

function parseTokenResponse(body: string): TokenResponse

Parametry

body

string

Ciąg JSON

Zwraca

TokenResponse

TokenResponse (tokenType i accessToken są dwiema ważnymi właściwościami).

dziedziczone zMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

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

Parametry

webResource

WebResource

Element WebResource do podpisania.

Zwraca

Promise<WebResource>

Obietnica z podpisanym elementem WebResource.

dziedziczone zMSITokenCredentials.signRequest