Dela via

MSIAppServiceTokenCredentials class

Paket:
@azure/ms-rest-nodeauth

Innehåller information om autentiseringsuppgifter för hanterad tjänstidentitetstoken i en App Service-miljö.

Extends
MSITokenCredentials

Konstruktorer

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Skapar en instans av MSIAppServiceTokenCredentials.

Egenskaper

clientId

ClientId för den hanterade identitet som du vill ha token för. Krävs om apptjänsten har användartilldelade hanterade identiteter.
msiApiVersion

API-versionen av den lokala MSI-agenten. Standardvärdet är "2017-09-01".
msiEndpoint

Den lokala URL som appen kan begära token från. Om inte den här egenskapen anges används någon av de två miljövariablerna IDENTITY_ENDPOINT eller MSI_ENDPOINT som standardvärde.
msiSecret

Hemligheten som används i kommunikationen mellan din kod och den lokala MSI-agenten. Om inte den här egenskapen anges används någon av de två miljövariablerna IDENTITY_SECRET eller MSI_SECRET som standardvärde.

Ärvda egenskaper

resource

Azure-resursslutpunkter.

  • Standardvärdet är Azure Resource Manager från miljön: AzureCloud. "https://management.azure.com/"Och jag har inte hört talas
  • För ServiceManagement (ASM): "https://management.core.windows.net/"
  • För Azure KeyVault: "https://vault.azure.net"
  • För Azure Batch: "https://batch.core.windows.net"
  • För Azure Active Directory Graph: "https://graph.windows.net"

Metoder

getToken()

Förbereder och skickar en GET-begäran till en tjänstslutpunkt som anges av apptjänsten, som svarar med åtkomsttoken.

Ärvda metoder

parseTokenResponse(string)

Parsar en tokenResponse json-sträng till ett objekt och konverterar egenskaper på den första nivån till camelCase. Den här metoden försöker standardisera tokenResponse
signRequest(WebResource)

Signerar en begäran med autentiseringshuvudet.

Konstruktorinformation

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Skapar en instans av MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Parametrar

options
MSIAppServiceOptions

Egenskapsinformation

clientId

ClientId för den hanterade identitet som du vill ha token för. Krävs om apptjänsten har användartilldelade hanterade identiteter.

clientId?: string

Egenskapsvärde

string

msiApiVersion

API-versionen av den lokala MSI-agenten. Standardvärdet är "2017-09-01".

msiApiVersion?: string

Egenskapsvärde

string

msiEndpoint

Den lokala URL som appen kan begära token från. Om inte den här egenskapen anges används någon av de två miljövariablerna IDENTITY_ENDPOINT eller MSI_ENDPOINT som standardvärde.

msiEndpoint: string

Egenskapsvärde

string

msiSecret

Hemligheten som används i kommunikationen mellan din kod och den lokala MSI-agenten. Om inte den här egenskapen anges används någon av de två miljövariablerna IDENTITY_SECRET eller MSI_SECRET som standardvärde.

msiSecret: string

Egenskapsvärde

string

Information om ärvda egenskaper

resource

Azure-resursslutpunkter.

  • Standardvärdet är Azure Resource Manager från miljön: AzureCloud. "https://management.azure.com/"Och jag har inte hört talas
  • För ServiceManagement (ASM): "https://management.core.windows.net/"
  • För Azure KeyVault: "https://vault.azure.net"
  • För Azure Batch: "https://batch.core.windows.net"
  • För Azure Active Directory Graph: "https://graph.windows.net"
resource: string

Egenskapsvärde

string

ärvd frånMSITokenCredentials.resource

Metodinformation

getToken()

Förbereder och skickar en GET-begäran till en tjänstslutpunkt som anges av apptjänsten, som svarar med åtkomsttoken.

function getToken(): Promise<MSITokenResponse>

Returer

Promise<MSITokenResponse>

Promise med tokenResponse (tokenType och accessToken är de två viktiga egenskaperna).

Ärvd metodinformation

parseTokenResponse(string)

Parsar en tokenResponse json-sträng till ett objekt och konverterar egenskaper på den första nivån till camelCase. Den här metoden försöker standardisera tokenResponse

function parseTokenResponse(body: string): TokenResponse

Parametrar

body

string

En json-sträng

Returer

TokenResponse

TokenResponse (tokenType och accessToken är de två viktiga egenskaperna).

ärvs frånMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Signerar en begäran med autentiseringshuvudet.

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

Parametrar

webResource
WebResource

Den WebResource som ska signeras.

Returer

Promise<WebResource>

Promise med signerad WebResource.

ärvd frånMSITokenCredentials.signRequest