Skip to main content

ManagedIdentityCredential

Struct ManagedIdentityCredential 

Source
pub struct ManagedIdentityCredential { /* private fields */ }
Expand description

Authenticates via an Azure Managed Identity by calling the Instance Metadata Service (IMDS) token endpoint (GET {endpoint}?api-version=2018-02-01&resource=<resource> with the Metadata: true header).

The endpoint defaults to the IMDS address but is overridden from the IDENTITY_ENDPOINT/MSI_ENDPOINT environment variables (as set by App Service / Functions) or via with_endpoint — which also makes it loopback-testable. An optional user-assigned identity client id may be supplied.

Implementations§

Source§

impl ManagedIdentityCredential

Source

pub fn new(scope: impl Into<String>) -> Self

Create a managed-identity credential acquiring tokens for scope.

The IMDS endpoint is taken from IDENTITY_ENDPOINT, then MSI_ENDPOINT, then DEFAULT_IMDS_ENDPOINT; an IDENTITY_HEADER, when present, is forwarded as X-IDENTITY-HEADER.

Source

pub fn with_endpoint(self, endpoint: impl Into<String>) -> Self

Override the token endpoint (default DEFAULT_IMDS_ENDPOINT or the environment) — the seam used by loopback tests.

Source

pub fn with_client_id(self, client_id: impl Into<String>) -> Self

Pin a user-assigned managed identity by its client id.

Source

pub fn with_identity_header(self, header: impl Into<String>) -> Self

Set the X-IDENTITY-HEADER value (App Service / Functions secret).

Trait Implementations§

Source§

impl TokenCredential for ManagedIdentityCredential

Source§

fn get_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Fetch a bearer token to send as Authorization: Bearer <token>.
Source§

fn get_token_for_scope<'life0, 'life1, 'async_trait>( &'life0 self, scope: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch a bearer token for a specific scope (audience), e.g. "https://ai.azure.com/.default". Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more