MSIAppServiceTokenCredentials class
Proporciona información sobre las credenciales de token de identidad de servicio administradas en un entorno de App Service.
- Extends
Constructores
| MSIApp |
Crea una instancia de MSIAppServiceTokenCredentials. |
Propiedades
| client |
ClientId de la identidad administrada para la que desea el token. Obligatorio, si el servicio de aplicaciones tiene identidades administradas asignadas por el usuario. |
| msi |
Versión de API del agente MSI local. El valor predeterminado es "2017-09-01". |
| msi |
Dirección URL local desde la que la aplicación puede solicitar tokens.
A menos que se especifique esta propiedad, cualquiera de las dos variables de entorno |
| msi |
Secreto usado en la comunicación entre el código y el agente MSI local.
A menos que se especifique esta propiedad, cualquiera de las dos variables de entorno |
Propiedades heredadas
| resource | Puntos de conexión de recursos de Azure.
|
Métodos
| get |
Prepara y envía una solicitud GET a un punto de conexión de servicio indicado por el servicio de aplicaciones, que responde con el token de acceso. |
Métodos heredados
| parse |
Analiza una cadena json tokenResponse en un objeto y convierte las propiedades en el primer nivel en camelCase. Este método intenta estandarizar tokenResponse |
| sign |
Firma una solicitud con el encabezado Authentication. |
Detalles del constructor
MSIAppServiceTokenCredentials(MSIAppServiceOptions)
Crea una instancia de MSIAppServiceTokenCredentials.
new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)
Parámetros
- options
- MSIAppServiceOptions
Detalles de las propiedades
clientId
ClientId de la identidad administrada para la que desea el token. Obligatorio, si el servicio de aplicaciones tiene identidades administradas asignadas por el usuario.
clientId?: string
Valor de propiedad
string
msiApiVersion
Versión de API del agente MSI local. El valor predeterminado es "2017-09-01".
msiApiVersion?: string
Valor de propiedad
string
msiEndpoint
Dirección URL local desde la que la aplicación puede solicitar tokens.
A menos que se especifique esta propiedad, cualquiera de las dos variables de entorno IDENTITY_ENDPOINT o MSI_ENDPOINT se usará como valor predeterminado.
msiEndpoint: string
Valor de propiedad
string
msiSecret
Secreto usado en la comunicación entre el código y el agente MSI local.
A menos que se especifique esta propiedad, cualquiera de las dos variables de entorno IDENTITY_SECRET o MSI_SECRET se usará como valor predeterminado.
msiSecret: string
Valor de propiedad
string
Detalles de las propiedades heredadas
resource
Puntos de conexión de recursos de Azure.
- El valor predeterminado es Azure Resource Manager desde el entorno: AzureCloud. "https://management.azure.com/"
- Para ServiceManagement (ASM): "https://management.core.windows.net/"
- Para Azure KeyVault: "https://vault.azure.net"
- Para Azure Batch: "https://batch.core.windows.net"
- Para Azure Active Directory Graph: "https://graph.windows.net"
resource: string
Valor de propiedad
string
heredado deMSITokenCredentials.resource
Detalles del método
getToken()
Prepara y envía una solicitud GET a un punto de conexión de servicio indicado por el servicio de aplicaciones, que responde con el token de acceso.
function getToken(): Promise<MSITokenResponse>
Devoluciones
Promise<MSITokenResponse>
La promesa con tokenResponse (tokenType y accessToken son las dos propiedades importantes).
Detalles de los métodos heredados
parseTokenResponse(string)
Analiza una cadena json tokenResponse en un objeto y convierte las propiedades en el primer nivel en camelCase. Este método intenta estandarizar tokenResponse
function parseTokenResponse(body: string): TokenResponse
Parámetros
- body
-
string
Una cadena json
Devoluciones
TokenResponse
TokenResponse (tokenType y accessToken son las dos propiedades importantes).
heredado deMSITokenCredentials.parseTokenResponse
signRequest(WebResource)
Firma una solicitud con el encabezado Authentication.
function signRequest(webResource: WebResource): Promise<WebResource>
Parámetros
- webResource
- WebResource
WebResource que se va a firmar.
Devoluciones
Promise<WebResource>
Promesa con WebResource firmado.
heredado deMSITokenCredentials.signRequest