Sdílet prostřednictvím


MSIAppServiceTokenCredentials class

Poskytuje informace o přihlašovacích údajích tokenu identity spravované služby v prostředí App Service.

Extends

Konstruktory

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Vytvoří instanci MSIAppServiceTokenCredentials.

Vlastnosti

clientId

ID klienta spravované identity, pro kterou chcete token získat. Vyžaduje se, pokud má vaše služba App Service spravované identity přiřazené uživatelem.

msiApiVersion

Verze api-version místního agenta MSI. Výchozí hodnota je 2017-09-01.

msiEndpoint

Místní adresa URL, ze které může aplikace požadovat tokeny. Pokud tuto vlastnost nezadáte, použije se jako výchozí hodnota jakákoli ze dvou proměnných prostředí IDENTITY_ENDPOINT nebo MSI_ENDPOINT.

msiSecret

Tajný kód používaný ke komunikaci mezi vaším kódem a místním agentem MSI. Pokud tuto vlastnost nezadáte, použije se jako výchozí hodnota jakákoli ze dvou proměnných prostředí IDENTITY_SECRET nebo MSI_SECRET.

Zděděné vlastnosti

resource

Koncové body prostředků Azure

  • Výchozí nastavení Azure Resource Manageru z prostředí: AzureCloud. "https://management.azure.com/"
  • Pro ServiceManagement (ASM): "https://management.core.windows.net/"
  • Pro Azure KeyVault: "https://vault.azure.net"
  • Pro Azure Batch: "https://batch.core.windows.net"
  • Pro Azure Active Directory Graph: "https://graph.windows.net"

Metody

getToken()

Připraví a odešle požadavek GET do koncového bodu služby označeného službou App Service, která reaguje přístupovým tokenem.

Zděděné metody

parseTokenResponse(string)

Parsuje řetězec json tokenResponse na objekt a převede vlastnosti na první úrovni na camelCase. Tato metoda se pokusí standardizovat tokenResponse.

signRequest(WebResource)

Podepíše požadavek hlavičkou Ověřování.

Podrobnosti konstruktoru

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Vytvoří instanci MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Parametry

Podrobnosti vlastnosti

clientId

ID klienta spravované identity, pro kterou chcete token získat. Vyžaduje se, pokud má vaše služba App Service spravované identity přiřazené uživatelem.

clientId?: string

Hodnota vlastnosti

string

msiApiVersion

Verze api-version místního agenta MSI. Výchozí hodnota je 2017-09-01.

msiApiVersion?: string

Hodnota vlastnosti

string

msiEndpoint

Místní adresa URL, ze které může aplikace požadovat tokeny. Pokud tuto vlastnost nezadáte, použije se jako výchozí hodnota jakákoli ze dvou proměnných prostředí IDENTITY_ENDPOINT nebo MSI_ENDPOINT.

msiEndpoint: string

Hodnota vlastnosti

string

msiSecret

Tajný kód používaný ke komunikaci mezi vaším kódem a místním agentem MSI. Pokud tuto vlastnost nezadáte, použije se jako výchozí hodnota jakákoli ze dvou proměnných prostředí IDENTITY_SECRET nebo MSI_SECRET.

msiSecret: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

resource

Koncové body prostředků Azure

  • Výchozí nastavení Azure Resource Manageru z prostředí: AzureCloud. "https://management.azure.com/"
  • Pro ServiceManagement (ASM): "https://management.core.windows.net/"
  • Pro Azure KeyVault: "https://vault.azure.net"
  • Pro Azure Batch: "https://batch.core.windows.net"
  • Pro Azure Active Directory Graph: "https://graph.windows.net"
resource: string

Hodnota vlastnosti

string

zděděno zeMSITokenCredentials.resource

Podrobnosti metody

getToken()

Připraví a odešle požadavek GET do koncového bodu služby označeného službou App Service, která reaguje přístupovým tokenem.

function getToken(): Promise<MSITokenResponse>

Návraty

Promise<MSITokenResponse>

Slib s tokenResponse (tokenType a accessToken jsou dvě důležité vlastnosti).

Podrobnosti zděděných metod

parseTokenResponse(string)

Parsuje řetězec json tokenResponse na objekt a převede vlastnosti na první úrovni na camelCase. Tato metoda se pokusí standardizovat tokenResponse.

function parseTokenResponse(body: string): TokenResponse

Parametry

body

string

Řetězec JSON

Návraty

TokenResponse

TokenResponse (tokenType a accessToken jsou dvě důležité vlastnosti).

zděděno zMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Podepíše požadavek hlavičkou Ověřování.

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

Parametry

webResource
WebResource

WebResource, který se má podepsat.

Návraty

Promise<WebResource>

Slib s podepsaným WebResourcem.

zděděno zMSITokenCredentials.signRequest