OnBehalfOfCredential Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| OnBehalfOfCredential() |
Protected constructor for mocking. |
| OnBehalfOfCredential(String, String, X509Certificate2, String) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate. |
| OnBehalfOfCredential(String, String, String, String) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID. |
| OnBehalfOfCredential(String, String, Func<String>, String, OnBehalfOfCredentialOptions) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion. |
| OnBehalfOfCredential(String, String, Func<CancellationToken,Task<String>>, String, OnBehalfOfCredentialOptions) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion. |
| OnBehalfOfCredential(String, String, X509Certificate2, String, OnBehalfOfCredentialOptions) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate. |
| OnBehalfOfCredential(String, String, String, String, OnBehalfOfCredentialOptions) |
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID. |
OnBehalfOfCredential()
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Protected constructor for mocking.
protected OnBehalfOfCredential ();Protected Sub New ()Applies to
OnBehalfOfCredential(String, String, X509Certificate2, String)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
public OnBehalfOfCredential (string tenantId, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion);new Azure.Identity.OnBehalfOfCredential : string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 * string -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientCertificate As X509Certificate2, userAssertion As String)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
- clientCertificate
- X509Certificate2
The authentication X509 Certificate of the service principal
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
Applies to
OnBehalfOfCredential(String, String, String, String)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID.
public OnBehalfOfCredential (string tenantId, string clientId, string clientSecret, string userAssertion);new Azure.Identity.OnBehalfOfCredential : string * string * string * string -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientSecret As String, userAssertion As String)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
- clientSecret
- String
A client secret that was generated for the App Registration used to authenticate the client.
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
Applies to
OnBehalfOfCredential(String, String, Func<String>, String, OnBehalfOfCredentialOptions)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion.
public OnBehalfOfCredential (string tenantId, string clientId, Func<string> clientAssertionCallback, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options = default);new Azure.Identity.OnBehalfOfCredential : string * string * Func<string> * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientAssertionCallback As Func(Of String), userAssertion As String, Optional options As OnBehalfOfCredentialOptions = Nothing)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
A synchronous callback returning a valid client assertion used to authenticate the service principal.
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
- options
- OnBehalfOfCredentialOptions
Options that allow to configure the management of the requests sent to Microsoft Entra ID.
Applies to
OnBehalfOfCredential(String, String, Func<CancellationToken,Task<String>>, String, OnBehalfOfCredentialOptions)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified client assertion.
public OnBehalfOfCredential (string tenantId, string clientId, Func<System.Threading.CancellationToken,System.Threading.Tasks.Task<string>> clientAssertionCallback, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options = default);new Azure.Identity.OnBehalfOfCredential : string * string * Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<string>> * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientAssertionCallback As Func(Of CancellationToken, Task(Of String)), userAssertion As String, Optional options As OnBehalfOfCredentialOptions = Nothing)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
- clientAssertionCallback
- Func<CancellationToken,Task<String>>
An asynchronous callback returning a valid client assertion used to authenticate the service principal.
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
- options
- OnBehalfOfCredentialOptions
Options that allow to configure the management of the requests sent to Microsoft Entra ID.
Applies to
OnBehalfOfCredential(String, String, X509Certificate2, String, OnBehalfOfCredentialOptions)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Microsoft Entra ID with the specified certificate.
public OnBehalfOfCredential (string tenantId, string clientId, System.Security.Cryptography.X509Certificates.X509Certificate2 clientCertificate, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options);new Azure.Identity.OnBehalfOfCredential : string * string * System.Security.Cryptography.X509Certificates.X509Certificate2 * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientCertificate As X509Certificate2, userAssertion As String, options As OnBehalfOfCredentialOptions)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
- clientCertificate
- X509Certificate2
The authentication X509 Certificate of the service principal
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
- options
- OnBehalfOfCredentialOptions
Options that allow to configure the management of the requests sent to Microsoft Entra ID.
Applies to
OnBehalfOfCredential(String, String, String, String, OnBehalfOfCredentialOptions)
- Source:
- OnBehalfOfCredential.cs
- Source:
- OnBehalfOfCredential.cs
Creates an instance of the OnBehalfOfCredential with the details needed to authenticate with Microsoft Entra ID.
public OnBehalfOfCredential (string tenantId, string clientId, string clientSecret, string userAssertion, Azure.Identity.OnBehalfOfCredentialOptions options);new Azure.Identity.OnBehalfOfCredential : string * string * string * string * Azure.Identity.OnBehalfOfCredentialOptions -> Azure.Identity.OnBehalfOfCredentialPublic Sub New (tenantId As String, clientId As String, clientSecret As String, userAssertion As String, options As OnBehalfOfCredentialOptions)Parameters
- tenantId
- String
The Microsoft Entra tenant (directory) ID of the service principal.
- clientId
- String
The client (application) ID of the service principal
- clientSecret
- String
A client secret that was generated for the App Registration used to authenticate the client.
- userAssertion
- String
The access token that will be used by OnBehalfOfCredential as the user assertion when requesting On-Behalf-Of tokens.
- options
- OnBehalfOfCredentialOptions
Options that allow to configure the management of the requests sent to Microsoft Entra ID.
Applies to
Azure SDK for .NET