-
Notifications
You must be signed in to change notification settings - Fork 263
/
WorkloadIdentityCredential.xml
140 lines (140 loc) · 9.7 KB
/
WorkloadIdentityCredential.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<Type Name="WorkloadIdentityCredential" FullName="Azure.Identity.WorkloadIdentityCredential">
<TypeSignature Language="C#" Value="public class WorkloadIdentityCredential : Azure.Core.TokenCredential" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WorkloadIdentityCredential extends Azure.Core.TokenCredential" />
<TypeSignature Language="DocId" Value="T:Azure.Identity.WorkloadIdentityCredential" />
<TypeSignature Language="VB.NET" Value="Public Class WorkloadIdentityCredential
Inherits TokenCredential" />
<TypeSignature Language="F#" Value="type WorkloadIdentityCredential = class
 inherit TokenCredential" />
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.9.0.0</AssemblyVersion>
<AssemblyVersion>1.10.0.0</AssemblyVersion>
<AssemblyVersion>1.10.1.0</AssemblyVersion>
<AssemblyVersion>1.10.2.0</AssemblyVersion>
<AssemblyVersion>1.10.3.0</AssemblyVersion>
<AssemblyVersion>1.10.4.0</AssemblyVersion>
<AssemblyVersion>1.11.0.0</AssemblyVersion>
<AssemblyVersion>1.11.1.0</AssemblyVersion>
<AssemblyVersion>1.11.2.0</AssemblyVersion>
<AssemblyVersion>1.11.3.0</AssemblyVersion>
<AssemblyVersion>1.11.4.0</AssemblyVersion>
<AssemblyVersion>1.12.0.0</AssemblyVersion>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Core.TokenCredential</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
WorkloadIdentityCredential supports Microsoft Entra Workload ID authentication on Kubernetes and other hosts supporting workload identity.
Refer to <a href="https://learn.microsoft.com/azure/aks/workload-identity-overview">Microsoft Entra Workload ID</a> for more information.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WorkloadIdentityCredential ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.WorkloadIdentityCredential.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates a new instance of the <see cref="T:Azure.Identity.WorkloadIdentityCredential" /> with the default options.
When no options are specified AZURE_TENANT_ID, AZURE_CLIENT_ID and AZURE_FEDERATED_TOKEN_FILE must be specified in the environment.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WorkloadIdentityCredential (Azure.Identity.WorkloadIdentityCredentialOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Azure.Identity.WorkloadIdentityCredentialOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.WorkloadIdentityCredential.#ctor(Azure.Identity.WorkloadIdentityCredentialOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (options As WorkloadIdentityCredentialOptions)" />
<MemberSignature Language="F#" Value="new Azure.Identity.WorkloadIdentityCredential : Azure.Identity.WorkloadIdentityCredentialOptions -> Azure.Identity.WorkloadIdentityCredential" Usage="new Azure.Identity.WorkloadIdentityCredential options" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="options" Type="Azure.Identity.WorkloadIdentityCredentialOptions" />
</Parameters>
<Docs>
<param name="options">Options that allow to configure the management of the requests sent to Microsoft Entra ID.</param>
<summary>
Creates a new instance of the <see cref="T:Azure.Identity.WorkloadIdentityCredential" /> with the specified options.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetToken">
<MemberSignature Language="C#" Value="public override Azure.Core.AccessToken GetToken (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype Azure.Core.AccessToken GetToken(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.WorkloadIdentityCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetToken (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As AccessToken" />
<MemberSignature Language="F#" Value="override this.GetToken : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> Azure.Core.AccessToken" Usage="workloadIdentityCredential.GetToken (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.AccessToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestContext">The details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Obtains a access token for the specified set of scopes.
</summary>
<returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
<remarks>Caching and management of the lifespan for the <see cref="T:Azure.Core.AccessToken" /> is considered the responsibility of the caller: each call should request a fresh token being requested.</remarks>
<exception cref="T:Azure.Identity.AuthenticationFailedException">Thrown when the authentication failed.</exception>
</Docs>
</Member>
<Member MemberName="GetTokenAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<Azure.Core.AccessToken> GetTokenAsync (Azure.Core.TokenRequestContext requestContext, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<valuetype Azure.Core.AccessToken> GetTokenAsync(valuetype Azure.Core.TokenRequestContext requestContext, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Identity.WorkloadIdentityCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTokenAsync (requestContext As TokenRequestContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of AccessToken)" />
<MemberSignature Language="F#" Value="override this.GetTokenAsync : Azure.Core.TokenRequestContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Core.AccessToken>" Usage="workloadIdentityCredential.GetTokenAsync (requestContext, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Identity</AssemblyName>
<AssemblyVersion>1.12.1.0</AssemblyVersion>
<AssemblyVersion>1.13.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<Azure.Core.AccessToken></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="requestContext" Type="Azure.Core.TokenRequestContext" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="requestContext">The details of the authentication request.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Obtains a access token for the specified set of scopes.
</summary>
<returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
<remarks>Caching and management of the lifespan for the <see cref="T:Azure.Core.AccessToken" /> is considered the responsibility of the caller: each call should request a fresh token being requested.</remarks>
<exception cref="T:Azure.Identity.AuthenticationFailedException">Thrown when the authentication failed.</exception>
</Docs>
</Member>
</Members>
</Type>