Compartilhar via

MSIAppServiceTokenCredentials class

  • Referência
Pacote:
@azure/ms-rest-nodeauth

Fornece informações sobre credenciais de token de identidade de serviço gerenciado em um ambiente do Serviço de Aplicativo.

Extends
MSITokenCredentials

Construtores

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Cria uma instância de MSIAppServiceTokenCredentials.

Propriedades

clientId

A clientId da identidade gerenciada para a qual você gostaria que o token fosse. Obrigatório, se o serviço de aplicativo tiver identidades gerenciadas atribuídas pelo usuário.
msiApiVersion

A versão da API do agente MSI local. O valor padrão é "2017-09-01".
msiEndpoint

A URL local da qual seu aplicativo pode solicitar tokens. A menos que essa propriedade seja especificada, qualquer uma das duas variáveis de ambiente IDENTITY_ENDPOINT ou MSI_ENDPOINT será usada como o valor padrão.
msiSecret

O segredo usado na comunicação entre seu código e o agente MSI local. A menos que essa propriedade seja especificada, qualquer uma das duas variáveis de ambiente IDENTITY_SECRET ou MSI_SECRET será usada como o valor padrão.

Propriedades herdadas

resource

Pontos de extremidade de recursos do Azure.

  • Usa como padrão o Azure Resource Manager do ambiente: AzureCloud. "https://management.azure.com/"
  • For ServiceManagement (ASM): "https://management.core.windows.net/"
  • Para o Azure KeyVault: "https://vault.azure.net"
  • Para o Lote do Azure: "https://batch.core.windows.net"
  • Para o Azure Active Directory Graph: "https://graph.windows.net"

Métodos

getToken()

Prepara e envia uma solicitação GET para um ponto de extremidade de serviço indicado pelo serviço de aplicativo, que responde com o token de acesso.

Métodos herdados

parseTokenResponse(string)

Analisa uma cadeia de caracteres json tokenResponse em um objeto e converte propriedades no primeiro nível em camelCase. Esse método tenta padronizar o tokenResponse
signRequest(WebResource)

Assina uma solicitação com o cabeçalho autenticação.

Detalhes do construtor

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Cria uma instância de MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Parâmetros

options
MSIAppServiceOptions

Detalhes da propriedade

clientId

A clientId da identidade gerenciada para a qual você gostaria que o token fosse. Obrigatório, se o serviço de aplicativo tiver identidades gerenciadas atribuídas pelo usuário.

clientId?: string

Valor da propriedade

string

msiApiVersion

A versão da API do agente MSI local. O valor padrão é "2017-09-01".

msiApiVersion?: string

Valor da propriedade

string

msiEndpoint

A URL local da qual seu aplicativo pode solicitar tokens. A menos que essa propriedade seja especificada, qualquer uma das duas variáveis de ambiente IDENTITY_ENDPOINT ou MSI_ENDPOINT será usada como o valor padrão.

msiEndpoint: string

Valor da propriedade

string

msiSecret

O segredo usado na comunicação entre seu código e o agente MSI local. A menos que essa propriedade seja especificada, qualquer uma das duas variáveis de ambiente IDENTITY_SECRET ou MSI_SECRET será usada como o valor padrão.

msiSecret: string

Valor da propriedade

string

Detalhes das propriedades herdadas

resource

Pontos de extremidade de recursos do Azure.

  • Usa como padrão o Azure Resource Manager do ambiente: AzureCloud. "https://management.azure.com/"
  • For ServiceManagement (ASM): "https://management.core.windows.net/"
  • Para o Azure KeyVault: "https://vault.azure.net"
  • Para o Lote do Azure: "https://batch.core.windows.net"
  • Para o Azure Active Directory Graph: "https://graph.windows.net"
resource: string

Valor da propriedade

string

herdado deMSITokenCredentials.resource

Detalhes do método

getToken()

Prepara e envia uma solicitação GET para um ponto de extremidade de serviço indicado pelo serviço de aplicativo, que responde com o token de acesso.

function getToken(): Promise<MSITokenResponse>

Retornos

Promise<MSITokenResponse>

Prometa com o tokenResponse (tokenType e accessToken são as duas propriedades importantes).

Detalhes do método herdado

parseTokenResponse(string)

Analisa uma cadeia de caracteres json tokenResponse em um objeto e converte propriedades no primeiro nível em camelCase. Esse método tenta padronizar o tokenResponse

function parseTokenResponse(body: string): TokenResponse

Parâmetros

body

string

Uma cadeia de caracteres json

Retornos

TokenResponse

O tokenResponse (tokenType e accessToken são as duas propriedades importantes).

Herdado deMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Assina uma solicitação com o cabeçalho autenticação.

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

Parâmetros

webResource
WebResource

O WebResource a ser assinado.

Retornos

Promise<WebResource>

Prometa com WebResource assinado.

Herdado de MSITokenCredentials.signRequest