Azure.Identity.xml 187 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Azure.Identity</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Azure.Identity.AsyncLockWithValue`1">
  8. <summary>
  9. Primitive that combines async lock and value cache
  10. </summary>
  11. <typeparam name="T"></typeparam>
  12. </member>
  13. <member name="M:Azure.Identity.AsyncLockWithValue`1.GetLockOrValueAsync(System.Boolean,System.Threading.CancellationToken)">
  14. <summary>
  15. Method that either returns cached value or acquire a lock.
  16. If one caller has acquired a lock, other callers will be waiting for the lock to be released.
  17. If value is set, lock is released and all waiters get that value.
  18. If value isn't set, the next waiter in the queue will get the lock.
  19. </summary>
  20. <param name="async"></param>
  21. <param name="cancellationToken"></param>
  22. <returns></returns>
  23. </member>
  24. <member name="T:Azure.Identity.AuthenticationFailedException">
  25. <summary>
  26. An exception class raised for errors in authenticating client requests.
  27. </summary>
  28. </member>
  29. <member name="M:Azure.Identity.AuthenticationFailedException.#ctor(System.String)">
  30. <summary>
  31. Creates a new AuthenticationFailedException with the specified message.
  32. </summary>
  33. <param name="message">The message describing the authentication failure.</param>
  34. </member>
  35. <member name="M:Azure.Identity.AuthenticationFailedException.#ctor(System.String,System.Exception)">
  36. <summary>
  37. Creates a new AuthenticationFailedException with the specified message.
  38. </summary>
  39. <param name="message">The message describing the authentication failure.</param>
  40. <param name="innerException">The exception underlying the authentication failure.</param>
  41. </member>
  42. <member name="M:Azure.Identity.AuthenticationFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  43. <summary>
  44. A constructor used for serialization.
  45. </summary>
  46. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" />.</param>
  47. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" />.</param>
  48. <returns></returns>
  49. </member>
  50. <member name="T:Azure.Identity.AuthenticationRecord">
  51. <summary>
  52. Account information relating to an authentication request.
  53. </summary>
  54. <seealso cref="T:Azure.Identity.TokenCachePersistenceOptions" />.
  55. </member>
  56. <member name="P:Azure.Identity.AuthenticationRecord.Username">
  57. <summary>
  58. The user principal or service principal name of the account.
  59. </summary>
  60. </member>
  61. <member name="P:Azure.Identity.AuthenticationRecord.Authority">
  62. <summary>
  63. The authority host used to authenticate the account.
  64. </summary>
  65. </member>
  66. <member name="P:Azure.Identity.AuthenticationRecord.HomeAccountId">
  67. <summary>
  68. A unique identifier of the account.
  69. </summary>
  70. </member>
  71. <member name="P:Azure.Identity.AuthenticationRecord.TenantId">
  72. <summary>
  73. The tenant the account should authenticate in.
  74. </summary>
  75. </member>
  76. <member name="P:Azure.Identity.AuthenticationRecord.ClientId">
  77. <summary>
  78. The client id of the application which performed the original authentication
  79. </summary>
  80. </member>
  81. <member name="M:Azure.Identity.AuthenticationRecord.Serialize(System.IO.Stream,System.Threading.CancellationToken)">
  82. <summary>
  83. Serializes the <see cref="T:Azure.Identity.AuthenticationRecord" /> to the specified <see cref="T:System.IO.Stream" />.
  84. </summary>
  85. <param name="stream">The <see cref="T:System.IO.Stream" /> which the serialized <see cref="T:Azure.Identity.AuthenticationRecord" /> will be written to.</param>
  86. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  87. </member>
  88. <member name="M:Azure.Identity.AuthenticationRecord.SerializeAsync(System.IO.Stream,System.Threading.CancellationToken)">
  89. <summary>
  90. Serializes the <see cref="T:Azure.Identity.AuthenticationRecord" /> to the specified <see cref="T:System.IO.Stream" />.
  91. </summary>
  92. <param name="stream">The <see cref="T:System.IO.Stream" /> to which the serialized <see cref="T:Azure.Identity.AuthenticationRecord" /> will be written.</param>
  93. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  94. </member>
  95. <member name="M:Azure.Identity.AuthenticationRecord.Deserialize(System.IO.Stream,System.Threading.CancellationToken)">
  96. <summary>
  97. Deserializes the <see cref="T:Azure.Identity.AuthenticationRecord" /> from the specified <see cref="T:System.IO.Stream" />.
  98. </summary>
  99. <param name="stream">The <see cref="T:System.IO.Stream" /> from which the serialized <see cref="T:Azure.Identity.AuthenticationRecord" /> will be read.</param>
  100. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  101. </member>
  102. <member name="M:Azure.Identity.AuthenticationRecord.DeserializeAsync(System.IO.Stream,System.Threading.CancellationToken)">
  103. <summary>
  104. Deserializes the <see cref="T:Azure.Identity.AuthenticationRecord" /> from the specified <see cref="T:System.IO.Stream" />.
  105. </summary>
  106. <param name="stream">The <see cref="T:System.IO.Stream" /> from which the serialized <see cref="T:Azure.Identity.AuthenticationRecord" /> will be read.</param>
  107. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  108. </member>
  109. <member name="T:Azure.Identity.AuthenticationRequiredException">
  110. <summary>
  111. An exception indicating that interactive authentication is required.
  112. </summary>
  113. </member>
  114. <member name="M:Azure.Identity.AuthenticationRequiredException.#ctor(System.String,Azure.Core.TokenRequestContext)">
  115. <summary>
  116. Creates a new <see cref="T:Azure.Identity.AuthenticationRequiredException" /> with the specified message and context.
  117. </summary>
  118. <param name="message">The message describing the authentication failure.</param>
  119. <param name="context">The details of the authentication request.</param>
  120. </member>
  121. <member name="M:Azure.Identity.AuthenticationRequiredException.#ctor(System.String,Azure.Core.TokenRequestContext,System.Exception)">
  122. <summary>
  123. Creates a new <see cref="T:Azure.Identity.AuthenticationRequiredException" /> with the specified message, context and inner exception.
  124. </summary>
  125. <param name="message">The message describing the authentication failure.</param>
  126. <param name="context">The details of the authentication request.</param>
  127. <param name="innerException">The exception underlying the authentication failure.</param>
  128. </member>
  129. <member name="M:Azure.Identity.AuthenticationRequiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  130. <summary>
  131. A constructor used for serialization.
  132. </summary>
  133. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" />.</param>
  134. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" />.</param>
  135. <returns></returns>
  136. </member>
  137. <member name="P:Azure.Identity.AuthenticationRequiredException.TokenRequestContext">
  138. <summary>
  139. The details of the authentication request which resulted in the authentication failure.
  140. </summary>
  141. </member>
  142. <member name="T:Azure.Identity.AzureAuthorityHosts">
  143. <summary>
  144. Defines fields exposing the well known authority hosts for the Azure Public Cloud and sovereign clouds.
  145. </summary>
  146. </member>
  147. <member name="P:Azure.Identity.AzureAuthorityHosts.AzurePublicCloud">
  148. <summary>
  149. The host of the Azure Active Directory authority for tenants in the Azure Public Cloud.
  150. </summary>
  151. </member>
  152. <member name="P:Azure.Identity.AzureAuthorityHosts.AzureChina">
  153. <summary>
  154. The host of the Azure Active Directory authority for tenants in the Azure China Cloud.
  155. </summary>
  156. </member>
  157. <member name="P:Azure.Identity.AzureAuthorityHosts.AzureGermany">
  158. <summary>
  159. The host of the Azure Active Directory authority for tenants in the Azure German Cloud.
  160. </summary>
  161. </member>
  162. <member name="P:Azure.Identity.AzureAuthorityHosts.AzureGovernment">
  163. <summary>
  164. The host of the Azure Active Directory authority for tenants in the Azure US Government Cloud.
  165. </summary>
  166. </member>
  167. <member name="T:Azure.Identity.AuthorizationCodeCredential">
  168. <summary>
  169. Authenticates by redeeming an authorization code previously obtained from Azure Active Directory. See
  170. <seealso href="https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow" /> for more information
  171. about the authorization code authentication flow.
  172. </summary>
  173. </member>
  174. <member name="M:Azure.Identity.AuthorizationCodeCredential.#ctor">
  175. <summary>
  176. Protected constructor for mocking.
  177. </summary>
  178. </member>
  179. <member name="M:Azure.Identity.AuthorizationCodeCredential.#ctor(System.String,System.String,System.String,System.String)">
  180. <summary>
  181. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a prefetched authorization code.
  182. </summary>
  183. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  184. <param name="clientId">The client (application) ID of the service principal</param>
  185. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  186. <param name="authorizationCode">The authorization code obtained from a call to authorize. The code should be obtained with all required scopes.
  187. See https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow for more information.</param>
  188. </member>
  189. <member name="M:Azure.Identity.AuthorizationCodeCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.AuthorizationCodeCredentialOptions)">
  190. <summary>
  191. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a prefetched authorization code.
  192. </summary>
  193. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  194. <param name="clientId">The client (application) ID of the service principal</param>
  195. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  196. <param name="authorizationCode">The authorization code obtained from a call to authorize. The code should be obtained with all required scopes.
  197. See https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow for more information.</param>
  198. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  199. </member>
  200. <member name="M:Azure.Identity.AuthorizationCodeCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  201. <summary>
  202. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a prefetched authorization code.
  203. </summary>
  204. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  205. <param name="clientId">The client (application) ID of the service principal</param>
  206. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  207. <param name="authorizationCode">The authorization code obtained from a call to authorize. The code should be obtained with all required scopes.
  208. See https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-auth-code-flow for more information.</param>
  209. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  210. </member>
  211. <member name="M:Azure.Identity.AuthorizationCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  212. <summary>
  213. Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called automatically by
  214. Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  215. </summary>
  216. <param name="requestContext">The details of the authentication request.</param>
  217. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  218. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  219. </member>
  220. <member name="M:Azure.Identity.AuthorizationCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  221. <summary>
  222. Obtains a token from the Azure Active Directory service, using the specified authorization code authenticate. This method is called automatically by
  223. Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  224. </summary>
  225. <param name="requestContext">The details of the authentication request.</param>
  226. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  227. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  228. </member>
  229. <member name="T:Azure.Identity.AuthorizationCodeCredentialOptions">
  230. <summary>
  231. Options used to configure the <see cref="T:Azure.Identity.AuthorizationCodeCredential" />.
  232. </summary>
  233. </member>
  234. <member name="P:Azure.Identity.AuthorizationCodeCredentialOptions.RedirectUri">
  235. <summary>
  236. The redirect Uri that will be sent with the GetToken request.
  237. </summary>
  238. </member>
  239. <member name="T:Azure.Identity.AzureApplicationCredential">
  240. <summary>
  241. Provides a <see cref="T:Azure.Core.TokenCredential" /> implementation which chains the <see cref="T:Azure.Identity.EnvironmentCredential" /> and <see cref="T:Azure.Identity.ManagedIdentityCredential" /> implementations to be tried in order
  242. until one of the getToken methods returns a non-default <see cref="T:Azure.Core.AccessToken" />.
  243. </summary>
  244. <remarks>
  245. This credential is designed for applications deployed to Azure <see cref="T:Azure.Identity.DefaultAzureCredential" /> is
  246. better suited to local development). It authenticates service principals and managed identities..
  247. </remarks>
  248. </member>
  249. <member name="M:Azure.Identity.AzureApplicationCredential.#ctor">
  250. <summary>
  251. Initializes an instance of the <see cref="T:Azure.Identity.AzureApplicationCredential" />.
  252. </summary>
  253. </member>
  254. <member name="M:Azure.Identity.AzureApplicationCredential.#ctor(Azure.Identity.AzureApplicationCredentialOptions)">
  255. <summary>
  256. Initializes an instance of the <see cref="T:Azure.Identity.AzureApplicationCredential" />.
  257. </summary>
  258. <param name="options">The <see cref="T:Azure.Identity.TokenCredentialOptions" /> to configure this credential.</param>
  259. </member>
  260. <member name="M:Azure.Identity.AzureApplicationCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  261. <summary>
  262. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the specified sources, returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />.
  263. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  264. </summary>
  265. <param name="requestContext">The details of the authentication request.</param>
  266. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  267. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  268. </member>
  269. <member name="M:Azure.Identity.AzureApplicationCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  270. <summary>
  271. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the specified sources, returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />.
  272. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  273. </summary>
  274. <param name="requestContext">The details of the authentication request.</param>
  275. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  276. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  277. </member>
  278. <member name="T:Azure.Identity.AzureApplicationCredentialOptions">
  279. <summary>
  280. Options to configure the <see cref="T:Azure.Identity.AzureApplicationCredential" /> authentication flow and requests made to Azure Identity services.
  281. </summary>
  282. </member>
  283. <member name="P:Azure.Identity.AzureApplicationCredentialOptions.ManagedIdentityClientId">
  284. <summary>
  285. Specifies the client id of the azure ManagedIdentity in the case of user assigned identity.
  286. </summary>
  287. </member>
  288. <member name="T:Azure.Identity.AzureCliCredential">
  289. <summary>
  290. Enables authentication to Azure Active Directory using Azure CLI to obtain an access token.
  291. </summary>
  292. </member>
  293. <member name="M:Azure.Identity.AzureCliCredential.#ctor">
  294. <summary>
  295. Create an instance of CliCredential class.
  296. </summary>
  297. </member>
  298. <member name="M:Azure.Identity.AzureCliCredential.#ctor(Azure.Identity.AzureCliCredentialOptions)">
  299. <summary>
  300. Create an instance of CliCredential class.
  301. </summary>
  302. <param name="options"> The Azure Active Directory tenant (directory) Id of the service principal. </param>
  303. </member>
  304. <member name="M:Azure.Identity.AzureCliCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  305. <summary>
  306. Obtains a access token from Azure CLI credential, using this access token to authenticate. This method called by Azure SDK clients.
  307. </summary>
  308. <param name="requestContext"></param>
  309. <param name="cancellationToken"></param>
  310. <returns></returns>
  311. </member>
  312. <member name="M:Azure.Identity.AzureCliCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  313. <summary>
  314. Obtains a access token from Azure CLI service, using the access token to authenticate. This method id called by Azure SDK clients.
  315. </summary>
  316. <param name="requestContext"></param>
  317. <param name="cancellationToken"></param>
  318. <returns></returns>
  319. </member>
  320. <member name="T:Azure.Identity.AzureCliCredentialOptions">
  321. <summary>
  322. Options for configuring the <see cref="T:Azure.Identity.AzureCliCredential" />.
  323. </summary>
  324. </member>
  325. <member name="P:Azure.Identity.AzureCliCredentialOptions.TenantId">
  326. <summary>
  327. The Azure Active Directory tenant (directory) Id of the service principal
  328. </summary>
  329. </member>
  330. <member name="T:Azure.Identity.AzurePowerShellCredential">
  331. <summary>
  332. Enables authentication to Azure Active Directory using Azure PowerShell to obtain an access token.
  333. </summary>
  334. </member>
  335. <member name="M:Azure.Identity.AzurePowerShellCredential.#ctor">
  336. <summary>
  337. Creates a new instance of the <see cref="T:Azure.Identity.AzurePowerShellCredential" />.
  338. </summary>
  339. </member>
  340. <member name="M:Azure.Identity.AzurePowerShellCredential.#ctor(Azure.Identity.AzurePowerShellCredentialOptions)">
  341. <summary>
  342. Creates a new instance of the <see cref="T:Azure.Identity.AzurePowerShellCredential" /> with the specified options.
  343. </summary>
  344. <param name="options">Options for configuring the credential.</param>
  345. </member>
  346. <member name="M:Azure.Identity.AzurePowerShellCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  347. <summary>
  348. Obtains a access token from Azure PowerShell, using the access token to authenticate. This method id called by Azure SDK clients.
  349. </summary>
  350. <param name="requestContext"></param>
  351. <param name="cancellationToken"></param>
  352. <returns></returns>
  353. </member>
  354. <member name="M:Azure.Identity.AzurePowerShellCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  355. <summary>
  356. Obtains a access token from Azure PowerShell, using the access token to authenticate. This method id called by Azure SDK clients.
  357. </summary>
  358. <param name="requestContext"></param>
  359. <param name="cancellationToken"></param>
  360. <returns></returns>
  361. </member>
  362. <member name="T:Azure.Identity.AzurePowerShellCredentialOptions">
  363. <summary>
  364. Options for configuring the <see cref="T:Azure.Identity.AzurePowerShellCredential" />.
  365. </summary>
  366. </member>
  367. <member name="P:Azure.Identity.AzurePowerShellCredentialOptions.TenantId">
  368. <summary>
  369. The Azure Active Directory tenant (directory) Id of the service principal
  370. </summary>
  371. </member>
  372. <member name="T:Azure.Identity.ChainedTokenCredential">
  373. <summary>
  374. Provides a <see cref="T:Azure.Core.TokenCredential" /> implementation which chains multiple <see cref="T:Azure.Core.TokenCredential" /> implementations to be tried in order
  375. until one of the getToken methods returns a non-default <see cref="T:Azure.Core.AccessToken" />.
  376. </summary>
  377. <example>
  378. <para>
  379. The ChainedTokenCredential class provides the ability to link together multiple credential instances to be tried sequentially when authenticating.
  380. The following example demonstrates creating a credential which will attempt to authenticate using managed identity, and fall back to Azure CLI for authentication
  381. if a managed identity is unavailable in the current environment.
  382. </para>
  383. <code snippet="Snippet:CustomChainedTokenCredential" language="csharp">
  384. // Authenticate using managed identity if it is available; otherwise use the Azure CLI to authenticate.
  385. var credential = new ChainedTokenCredential(new ManagedIdentityCredential(), new AzureCliCredential());
  386. var eventHubProducerClient = new EventHubProducerClient("myeventhub.eventhubs.windows.net", "myhubpath", credential);
  387. </code>
  388. </example>
  389. </member>
  390. <member name="M:Azure.Identity.ChainedTokenCredential.#ctor">
  391. <summary>
  392. Constructor for instrumenting in tests
  393. </summary>
  394. </member>
  395. <member name="M:Azure.Identity.ChainedTokenCredential.#ctor(Azure.Core.TokenCredential[])">
  396. <summary>
  397. Creates an instance with the specified <see cref="T:Azure.Core.TokenCredential" /> sources.
  398. </summary>
  399. <param name="sources">The ordered chain of <see cref="T:Azure.Core.TokenCredential" /> implementations to tried when calling <see cref="M:Azure.Identity.ChainedTokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> or <see cref="M:Azure.Identity.ChainedTokenCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /></param>
  400. </member>
  401. <member name="M:Azure.Identity.ChainedTokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  402. <summary>
  403. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the specified sources, returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  404. </summary>
  405. <param name="requestContext">The details of the authentication request.</param>
  406. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  407. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  408. </member>
  409. <member name="M:Azure.Identity.ChainedTokenCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  410. <summary>
  411. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the specified sources, returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  412. </summary>
  413. <param name="requestContext">The details of the authentication request.</param>
  414. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  415. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  416. </member>
  417. <member name="T:Azure.Identity.ClientAssertionCredential">
  418. <summary>
  419. Enables authentication of an AAD service principal using a signed client assertion.
  420. </summary>
  421. </member>
  422. <member name="M:Azure.Identity.ClientAssertionCredential.#ctor">
  423. <summary>
  424. Protected constructor for mocking.
  425. </summary>
  426. </member>
  427. <member name="M:Azure.Identity.ClientAssertionCredential.#ctor(System.String,System.String,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.String}},Azure.Identity.ClientAssertionCredentialOptions)">
  428. <summary>
  429. Creates an instance of the ClientCertificateCredential with an asynchronous callback that provides a signed client assertion to authenticate against Azure Active Directory.
  430. </summary>
  431. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  432. <param name="clientId">The client (application) ID of the service principal</param>
  433. <param name="assertionCallback">An asynchronous callback returning a valid client assertion used to authenticate the service principal.</param>
  434. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  435. </member>
  436. <member name="M:Azure.Identity.ClientAssertionCredential.#ctor(System.String,System.String,System.Func{System.String},Azure.Identity.ClientAssertionCredentialOptions)">
  437. <summary>
  438. Creates an instance of the ClientCertificateCredential with a synchronous callback that provides a signed client assertion to authenticate against Azure Active Directory.
  439. </summary>
  440. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  441. <param name="clientId">The client (application) ID of the service principal</param>
  442. <param name="assertionCallback">A synchronous callback returning a valid client assertion used to authenticate the service principal.</param>
  443. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  444. </member>
  445. <member name="M:Azure.Identity.ClientAssertionCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  446. <summary>
  447. Obtains a token from the Azure Active Directory service, by calling the assertionCallback specified when constructing the credential to obtain a client assertion for authentication.
  448. </summary>
  449. <param name="requestContext">The details of the authentication request.</param>
  450. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  451. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  452. </member>
  453. <member name="M:Azure.Identity.ClientAssertionCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  454. <summary>
  455. Obtains a token from the Azure Active Directory service, by calling the assertionCallback specified when constructing the credential to obtain a client assertion for authentication.
  456. </summary>
  457. <param name="requestContext">The details of the authentication request.</param>
  458. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  459. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  460. </member>
  461. <member name="T:Azure.Identity.ClientAssertionCredentialOptions">
  462. <summary>
  463. Options used to configure the <see cref="T:Azure.Identity.ClientAssertionCredential" />.
  464. </summary>
  465. </member>
  466. <member name="T:Azure.Identity.ClientCertificateCredential">
  467. <summary>
  468. Enables authentication of a service principal in to Azure Active Directory using a X509 certificate that is assigned to it's App Registration. More information
  469. on how to configure certificate authentication can be found here:
  470. https://docs.microsoft.com/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad
  471. </summary>
  472. </member>
  473. <member name="P:Azure.Identity.ClientCertificateCredential.TenantId">
  474. <summary>
  475. Gets the Azure Active Directory tenant (directory) Id of the service principal
  476. </summary>
  477. </member>
  478. <member name="P:Azure.Identity.ClientCertificateCredential.ClientId">
  479. <summary>
  480. Gets the client (application) ID of the service principal
  481. </summary>
  482. </member>
  483. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor">
  484. <summary>
  485. Protected constructor for mocking.
  486. </summary>
  487. </member>
  488. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.String)">
  489. <summary>
  490. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  491. </summary>
  492. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  493. <param name="clientId">The client (application) ID of the service principal</param>
  494. <param name="clientCertificatePath">The path to a file which contains both the client certificate and private key.</param>
  495. </member>
  496. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  497. <summary>
  498. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  499. </summary>
  500. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  501. <param name="clientId">The client (application) ID of the service principal</param>
  502. <param name="clientCertificatePath">The path to a file which contains both the client certificate and private key.</param>
  503. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  504. </member>
  505. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.String,Azure.Identity.ClientCertificateCredentialOptions)">
  506. <summary>
  507. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  508. </summary>
  509. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  510. <param name="clientId">The client (application) ID of the service principal</param>
  511. <param name="clientCertificatePath">The path to a file which contains both the client certificate and private key.</param>
  512. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  513. </member>
  514. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2)">
  515. <summary>
  516. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  517. </summary>
  518. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  519. <param name="clientId">The client (application) ID of the service principal</param>
  520. <param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
  521. </member>
  522. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,Azure.Identity.TokenCredentialOptions)">
  523. <summary>
  524. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  525. </summary>
  526. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  527. <param name="clientId">The client (application) ID of the service principal</param>
  528. <param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
  529. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  530. </member>
  531. <member name="M:Azure.Identity.ClientCertificateCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,Azure.Identity.ClientCertificateCredentialOptions)">
  532. <summary>
  533. Creates an instance of the ClientCertificateCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  534. </summary>
  535. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  536. <param name="clientId">The client (application) ID of the service principal</param>
  537. <param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
  538. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  539. </member>
  540. <member name="M:Azure.Identity.ClientCertificateCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  541. <summary>
  542. Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  543. </summary>
  544. <param name="requestContext">The details of the authentication request.</param>
  545. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  546. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  547. </member>
  548. <member name="M:Azure.Identity.ClientCertificateCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  549. <summary>
  550. Obtains a token from the Azure Active Directory service, using the specified X509 certificate to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  551. </summary>
  552. <param name="requestContext">The details of the authentication request.</param>
  553. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  554. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  555. </member>
  556. <member name="T:Azure.Identity.ClientCertificateCredentialOptions">
  557. <summary>
  558. Options used to configure the <see cref="T:Azure.Identity.ClientCertificateCredential" />.
  559. </summary>
  560. </member>
  561. <member name="P:Azure.Identity.ClientCertificateCredentialOptions.TokenCachePersistenceOptions">
  562. <summary>
  563. Specifies the <see cref="P:Azure.Identity.ClientCertificateCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
  564. </summary>
  565. </member>
  566. <member name="P:Azure.Identity.ClientCertificateCredentialOptions.SendCertificateChain">
  567. <summary>
  568. Will include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the <see cref="T:Azure.Identity.ClientCertificateCredential" />.
  569. </summary>
  570. </member>
  571. <member name="P:Azure.Identity.ClientCertificateCredentialOptions.RegionalAuthority">
  572. <summary>
  573. Specifies either the specific <see cref="P:Azure.Identity.ClientCertificateCredentialOptions.RegionalAuthority" /> (preferred), or use <see cref="P:Azure.Identity.RegionalAuthority.AutoDiscoverRegion" /> to attempt to auto-detect the region.
  574. If not specified or auto-detection fails the non-regional endpoint will be used.
  575. </summary>
  576. </member>
  577. <member name="T:Azure.Identity.ClientSecretCredential">
  578. <summary>
  579. Enables authentication to Azure Active Directory using a client secret that was generated for an App Registration. More information on how
  580. to configure a client secret can be found here:
  581. https://docs.microsoft.com/azure/active-directory/develop/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application
  582. </summary>
  583. </member>
  584. <member name="P:Azure.Identity.ClientSecretCredential.TenantId">
  585. <summary>
  586. Gets the Azure Active Directory tenant (directory) Id of the service principal
  587. </summary>
  588. </member>
  589. <member name="P:Azure.Identity.ClientSecretCredential.ClientId">
  590. <summary>
  591. Gets the client (application) ID of the service principal
  592. </summary>
  593. </member>
  594. <member name="P:Azure.Identity.ClientSecretCredential.ClientSecret">
  595. <summary>
  596. Gets the client secret that was generated for the App Registration used to authenticate the client.
  597. </summary>
  598. </member>
  599. <member name="M:Azure.Identity.ClientSecretCredential.#ctor">
  600. <summary>
  601. Protected constructor for mocking.
  602. </summary>
  603. </member>
  604. <member name="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String)">
  605. <summary>
  606. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a client secret.
  607. </summary>
  608. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  609. <param name="clientId">The client (application) ID of the service principal</param>
  610. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  611. </member>
  612. <member name="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String,Azure.Identity.ClientSecretCredentialOptions)">
  613. <summary>
  614. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a client secret.
  615. </summary>
  616. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  617. <param name="clientId">The client (application) ID of the service principal</param>
  618. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  619. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  620. </member>
  621. <member name="M:Azure.Identity.ClientSecretCredential.#ctor(System.String,System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  622. <summary>
  623. Creates an instance of the ClientSecretCredential with the details needed to authenticate against Azure Active Directory with a client secret.
  624. </summary>
  625. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  626. <param name="clientId">The client (application) ID of the service principal</param>
  627. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  628. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  629. </member>
  630. <member name="M:Azure.Identity.ClientSecretCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  631. <summary>
  632. Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  633. </summary>
  634. <param name="requestContext">The details of the authentication request.</param>
  635. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  636. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  637. </member>
  638. <member name="M:Azure.Identity.ClientSecretCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  639. <summary>
  640. Obtains a token from the Azure Active Directory service, using the specified client secret to authenticate. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  641. </summary>
  642. <param name="requestContext">The details of the authentication request.</param>
  643. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  644. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  645. </member>
  646. <member name="T:Azure.Identity.ClientSecretCredentialOptions">
  647. <summary>
  648. Options used to configure the <see cref="T:Azure.Identity.ClientSecretCredential" />.
  649. </summary>
  650. </member>
  651. <member name="P:Azure.Identity.ClientSecretCredentialOptions.TokenCachePersistenceOptions">
  652. <summary>
  653. Specifies the <see cref="P:Azure.Identity.ClientSecretCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
  654. </summary>
  655. </member>
  656. <member name="P:Azure.Identity.ClientSecretCredentialOptions.RegionalAuthority">
  657. <summary>
  658. Specifies either the specific <see cref="P:Azure.Identity.ClientSecretCredentialOptions.RegionalAuthority" /> (preferred), or use <see cref="P:Azure.Identity.RegionalAuthority.AutoDiscoverRegion" /> to attempt to auto-detect the region.
  659. If not specified or auto-detection fails the non-regional endpoint will be used.
  660. </summary>
  661. </member>
  662. <member name="T:Azure.Identity.DefaultAzureCredential">
  663. <summary>
  664. Provides a default <see cref="T:Azure.Core.TokenCredential" /> authentication flow for applications that will be deployed to Azure. The following credential
  665. types if enabled will be tried, in order:
  666. <list type="bullet">
  667. <item><description><see cref="T:Azure.Identity.EnvironmentCredential" /></description></item>
  668. <item><description><see cref="T:Azure.Identity.ManagedIdentityCredential" /></description></item>
  669. <item><description><see cref="T:Azure.Identity.SharedTokenCacheCredential" /></description></item>
  670. <item><description><see cref="T:Azure.Identity.VisualStudioCredential" /></description></item>
  671. <item><description><see cref="T:Azure.Identity.VisualStudioCodeCredential" /></description></item>
  672. <item><description><see cref="T:Azure.Identity.AzureCliCredential" /></description></item>
  673. <item><description><see cref="T:Azure.Identity.AzurePowerShellCredential" /></description></item>
  674. <item><description><see cref="T:Azure.Identity.InteractiveBrowserCredential" /></description></item>
  675. </list>
  676. Consult the documentation of these credential types for more information on how they attempt authentication.
  677. </summary>
  678. <remarks>
  679. Note that credentials requiring user interaction, such as the <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are not included by default. Callers must explicitly enable this when
  680. constructing the <see cref="T:Azure.Identity.DefaultAzureCredential" /> either by setting the includeInteractiveCredentials parameter to true, or the setting the
  681. <see cref="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeInteractiveBrowserCredential" /> property to false when passing <see cref="T:Azure.Identity.DefaultAzureCredentialOptions" />.
  682. </remarks>
  683. <example>
  684. <para>
  685. This example demonstrates authenticating the BlobClient from the Azure.Storage.Blobs client library using the DefaultAzureCredential,
  686. deployed to an Azure resource with a user assigned managed identity configured.
  687. </para>
  688. <code snippet="Snippet:UserAssignedManagedIdentity" language="csharp">
  689. // When deployed to an azure host, the default azure credential will authenticate the specified user assigned managed identity.
  690. string userAssignedClientId = "&lt;your managed identity client Id&gt;";
  691. var credential = new DefaultAzureCredential(new DefaultAzureCredentialOptions { ManagedIdentityClientId = userAssignedClientId });
  692. var blobClient = new BlobClient(new Uri("https://myaccount.blob.core.windows.net/mycontainer/myblob"), credential);
  693. </code>
  694. </example>
  695. </member>
  696. <member name="M:Azure.Identity.DefaultAzureCredential.#ctor(System.Boolean)">
  697. <summary>
  698. Creates an instance of the DefaultAzureCredential class.
  699. </summary>
  700. <param name="includeInteractiveCredentials">Specifies whether credentials requiring user interaction will be included in the default authentication flow.</param>
  701. </member>
  702. <member name="M:Azure.Identity.DefaultAzureCredential.#ctor(Azure.Identity.DefaultAzureCredentialOptions)">
  703. <summary>
  704. Creates an instance of the <see cref="T:Azure.Identity.DefaultAzureCredential" /> class.
  705. </summary>
  706. <param name="options">Options that configure the management of the requests sent to Azure Active Directory services, and determine which credentials are included in the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.</param>
  707. </member>
  708. <member name="M:Azure.Identity.DefaultAzureCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  709. <summary>
  710. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the included credentials in the order <see cref="T:Azure.Identity.EnvironmentCredential" />, <see cref="T:Azure.Identity.ManagedIdentityCredential" />, <see cref="T:Azure.Identity.SharedTokenCacheCredential" />,
  711. and <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  712. </summary>
  713. <remarks>
  714. Note that credentials requiring user interaction, such as the <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are not included by default.
  715. </remarks>
  716. <param name="requestContext">The details of the authentication request.</param>
  717. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  718. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  719. </member>
  720. <member name="M:Azure.Identity.DefaultAzureCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  721. <summary>
  722. Sequentially calls <see cref="M:Azure.Core.TokenCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> on all the included credentials in the order <see cref="T:Azure.Identity.EnvironmentCredential" />, <see cref="T:Azure.Identity.ManagedIdentityCredential" />, <see cref="T:Azure.Identity.SharedTokenCacheCredential" />,
  723. and <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> returning the first successfully obtained <see cref="T:Azure.Core.AccessToken" />. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  724. </summary>
  725. <remarks>
  726. Note that credentials requiring user interaction, such as the <see cref="T:Azure.Identity.InteractiveBrowserCredential" />, are not included by default.
  727. </remarks>
  728. <param name="requestContext">The details of the authentication request.</param>
  729. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  730. <returns>The first <see cref="T:Azure.Core.AccessToken" /> returned by the specified sources. Any credential which raises a <see cref="T:Azure.Identity.CredentialUnavailableException" /> will be skipped.</returns>
  731. </member>
  732. <member name="T:Azure.Identity.DefaultAzureCredentialOptions">
  733. <summary>
  734. Options to configure the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow and requests made to Azure Identity services.
  735. </summary>
  736. </member>
  737. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.InteractiveBrowserTenantId">
  738. <summary>
  739. The tenant id of the user to authenticate, in the case the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authenticates through, the
  740. <see cref="T:Azure.Identity.InteractiveBrowserCredential" />. The default is null and will authenticate users to their default tenant.
  741. The value can also be set by setting the environment variable AZURE_TENANT_ID.
  742. </summary>
  743. </member>
  744. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.SharedTokenCacheTenantId">
  745. <summary>
  746. Specifies the tenant id of the preferred authentication account, to be retrieved from the shared token cache for single sign on authentication with
  747. development tools, in the case multiple accounts are found in the shared token.
  748. </summary>
  749. <remarks>
  750. If multiple accounts are found in the shared token cache and no value is specified, or the specified value matches no accounts in
  751. the cache the SharedTokenCacheCredential will not be used for authentication.
  752. </remarks>
  753. </member>
  754. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.VisualStudioTenantId">
  755. <summary>
  756. The tenant id of the user to authenticate, in the case the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authenticates through, the
  757. <see cref="T:Azure.Identity.VisualStudioCredential" />. The default is null and will authenticate users to their default tenant.
  758. The value can also be set by setting the environment variable AZURE_TENANT_ID.
  759. </summary>
  760. </member>
  761. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.VisualStudioCodeTenantId">
  762. <summary>
  763. The tenant id of the user to authenticate, in the case the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authenticates through, the
  764. <see cref="T:Azure.Identity.VisualStudioCodeCredential" />. The default is null and will authenticate users to their default tenant.
  765. The value can also be set by setting the environment variable AZURE_TENANT_ID.
  766. </summary>
  767. </member>
  768. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.SharedTokenCacheUsername">
  769. <summary>
  770. Specifies the preferred authentication account to be retrieved from the shared token cache for single sign on authentication with
  771. development tools. In the case multiple accounts are found in the shared token.
  772. </summary>
  773. <remarks>
  774. If multiple accounts are found in the shared token cache and no value is specified, or the specified value matches no accounts in
  775. the cache the SharedTokenCacheCredential will not be used for authentication.
  776. </remarks>
  777. </member>
  778. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.InteractiveBrowserCredentialClientId">
  779. <summary>
  780. Specifies the client id of the selected credential
  781. </summary>
  782. </member>
  783. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ManagedIdentityClientId">
  784. <summary>
  785. Specifies the client id of a user assigned ManagedIdentity. If this value is configured, then <see cref="P:Azure.Identity.DefaultAzureCredentialOptions.ManagedIdentityResourceId" /> should not be configured.
  786. </summary>
  787. </member>
  788. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ManagedIdentityResourceId">
  789. <summary>
  790. Specifies the resource id of a user assigned ManagedIdentity. If this value is configured, then <see cref="P:Azure.Identity.DefaultAzureCredentialOptions.ManagedIdentityClientId" /> should not be configured.
  791. </summary>
  792. </member>
  793. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeEnvironmentCredential">
  794. <summary>
  795. Specifies whether the <see cref="T:Azure.Identity.EnvironmentCredential" /> will be excluded from the authentication flow. Setting to true disables reading
  796. authentication details from the process' environment variables.
  797. </summary>
  798. </member>
  799. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeManagedIdentityCredential">
  800. <summary>
  801. Specifies whether the <see cref="T:Azure.Identity.ManagedIdentityCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  802. Setting to true disables authenticating with managed identity endpoints.
  803. </summary>
  804. </member>
  805. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeSharedTokenCacheCredential">
  806. <summary>
  807. Specifies whether the <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  808. Setting to true disables single sign on authentication with development tools which write to the shared token cache.
  809. The default is <c>true</c>.
  810. </summary>
  811. </member>
  812. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeInteractiveBrowserCredential">
  813. <summary>
  814. Specifies whether the <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  815. Setting to true disables launching the default system browser to authenticate in development environments.
  816. The default is <c>true</c>.
  817. </summary>
  818. </member>
  819. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeAzureCliCredential">
  820. <summary>
  821. Specifies whether the <see cref="T:Azure.Identity.AzureCliCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  822. </summary>
  823. </member>
  824. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeVisualStudioCredential">
  825. <summary>
  826. Specifies whether the <see cref="T:Azure.Identity.VisualStudioCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  827. </summary>
  828. </member>
  829. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeVisualStudioCodeCredential">
  830. <summary>
  831. Specifies whether the <see cref="T:Azure.Identity.VisualStudioCodeCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  832. </summary>
  833. </member>
  834. <member name="P:Azure.Identity.DefaultAzureCredentialOptions.ExcludeAzurePowerShellCredential">
  835. <summary>
  836. Specifies whether the <see cref="T:Azure.Identity.AzurePowerShellCredential" /> will be excluded from the <see cref="T:Azure.Identity.DefaultAzureCredential" /> authentication flow.
  837. </summary>
  838. </member>
  839. <member name="T:Azure.Identity.DeviceCodeCredential">
  840. <summary>
  841. A <see cref="T:Azure.Core.TokenCredential" /> implementation which authenticates a user using the device code flow, and provides access tokens for that user account.
  842. For more information on the device code authentication flow see https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/wiki/Device-Code-Flow.
  843. </summary>
  844. </member>
  845. <member name="M:Azure.Identity.DeviceCodeCredential.#ctor">
  846. <summary>
  847. Creates a new <see cref="T:Azure.Identity.DeviceCodeCredential" />, which will authenticate users using the device code flow.
  848. </summary>
  849. </member>
  850. <member name="M:Azure.Identity.DeviceCodeCredential.#ctor(Azure.Identity.DeviceCodeCredentialOptions)">
  851. <summary>
  852. Creates a new <see cref="T:Azure.Identity.DeviceCodeCredential" /> with the specified options, which will authenticate users using the device code flow.
  853. </summary>
  854. <param name="options">The client options for the newly created <see cref="T:Azure.Identity.DeviceCodeCredential" />.</param>
  855. </member>
  856. <member name="M:Azure.Identity.DeviceCodeCredential.#ctor(System.Func{Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.String,Azure.Identity.TokenCredentialOptions)">
  857. <summary>
  858. Creates a new DeviceCodeCredential with the specified options, which will authenticate users with the specified application.
  859. </summary>
  860. <param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
  861. <param name="clientId">The client id of the application to which the users will authenticate</param>
  862. <param name="options">The client options for the newly created DeviceCodeCredential</param>
  863. </member>
  864. <member name="M:Azure.Identity.DeviceCodeCredential.#ctor(System.Func{Azure.Identity.DeviceCodeInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  865. <summary>
  866. Creates a new DeviceCodeCredential with the specified options, which will authenticate users with the specified application.
  867. </summary>
  868. <param name="deviceCodeCallback">The callback to be executed to display the device code to the user</param>
  869. <param name="tenantId">The tenant id of the application to which users will authenticate. This can be null for multi-tenanted applications.</param>
  870. <param name="clientId">The client id of the application to which the users will authenticate</param>
  871. <param name="options">The client options for the newly created DeviceCodeCredential</param>
  872. </member>
  873. <member name="M:Azure.Identity.DeviceCodeCredential.Authenticate(System.Threading.CancellationToken)">
  874. <summary>
  875. Interactively authenticates a user via the default browser.
  876. </summary>
  877. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  878. <returns>The result of the authentication request, containing the acquired <see cref="T:Azure.Core.AccessToken" />, and the <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account.</returns>
  879. </member>
  880. <member name="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(System.Threading.CancellationToken)">
  881. <summary>
  882. Interactively authenticates a user via the default browser.
  883. </summary>
  884. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  885. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account on future execution of credentials using the same persisted token cache.</returns>
  886. </member>
  887. <member name="M:Azure.Identity.DeviceCodeCredential.Authenticate(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  888. <summary>
  889. Interactively authenticates a user via the default browser.
  890. </summary>
  891. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  892. <param name="requestContext">The details of the authentication request.</param>
  893. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  894. </member>
  895. <member name="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  896. <summary>
  897. Interactively authenticates a user via the default browser.
  898. </summary>
  899. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  900. <param name="requestContext">The details of the authentication request.</param>
  901. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  902. </member>
  903. <member name="M:Azure.Identity.DeviceCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  904. <summary>
  905. Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  906. </summary>
  907. <param name="requestContext">The details of the authentication request.</param>
  908. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  909. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  910. </member>
  911. <member name="M:Azure.Identity.DeviceCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  912. <summary>
  913. Obtains a token for a user account, authenticating them through the device code authentication flow. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  914. </summary>
  915. <param name="requestContext">The details of the authentication request.</param>
  916. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  917. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  918. </member>
  919. <member name="T:Azure.Identity.DeviceCodeCredentialOptions">
  920. <summary>
  921. Options to configure the <see cref="T:Azure.Identity.DeviceCodeCredential" />.
  922. </summary>
  923. </member>
  924. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.DisableAutomaticAuthentication">
  925. <summary>
  926. Prevents the <see cref="T:Azure.Identity.DeviceCodeCredential" /> from automatically prompting the user. If automatic authentication is disabled a AuthenticationRequiredException will be thrown from <see cref="M:Azure.Identity.DeviceCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> and <see cref="M:Azure.Identity.DeviceCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> in the case that
  927. user interaction is necessary. The application is responsible for handling this exception, and calling <see cref="M:Azure.Identity.DeviceCodeCredential.Authenticate(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Identity.DeviceCodeCredential.AuthenticateAsync(System.Threading.CancellationToken)" /> to authenticate the user interactively.
  928. </summary>
  929. </member>
  930. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.TenantId">
  931. <summary>
  932. The tenant ID the user will be authenticated to. If not specified the user will be authenticated to their home tenant.
  933. </summary>
  934. </member>
  935. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.ClientId">
  936. <summary>
  937. The client ID of the application used to authenticate the user. If not specified the user will be authenticated with an Azure development application.
  938. </summary>
  939. </member>
  940. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.TokenCachePersistenceOptions">
  941. <summary>
  942. Specifies the <see cref="P:Azure.Identity.DeviceCodeCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
  943. </summary>
  944. </member>
  945. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.AuthenticationRecord">
  946. <summary>
  947. The <see cref="T:Azure.Identity.AuthenticationRecord" /> captured from a previous authentication.
  948. </summary>
  949. </member>
  950. <member name="P:Azure.Identity.DeviceCodeCredentialOptions.DeviceCodeCallback">
  951. <summary>
  952. The callback which will be executed to display the device code login details to the user. In not specified the device code and login instructions will be printed to the console.
  953. </summary>
  954. </member>
  955. <member name="T:Azure.Identity.EnvironmentCredential">
  956. <summary>
  957. Enables authentication to Azure Active Directory using client secret, or username and password,
  958. details configured in the following environment variables:
  959. <list type="table">
  960. <listheader><term>Variable</term><description>Description</description></listheader>
  961. <item><term>AZURE_TENANT_ID</term><description>The Azure Active Directory tenant(directory) ID.</description></item>
  962. <item><term>AZURE_CLIENT_ID</term><description>The client(application) ID of an App Registration in the tenant.</description></item>
  963. <item><term>AZURE_CLIENT_SECRET</term><description>A client secret that was generated for the App Registration.</description></item>
  964. <item><term>AZURE_CLIENT_CERTIFICATE_PATH</term><description>A path to certificate and private key pair in PEM or PFX format, which can authenticate the App Registration.</description></item>
  965. <item><term>AZURE_CLIENT_SEND_CERTIFICATE_CHAIN</term><description>Specifies whether an authentication request will include an x5c header to support subject name / issuer based authentication. When set to `true` or `1`, authentication requests include the x5c header.</description></item>
  966. <item><term>AZURE_USERNAME</term><description>The username, also known as upn, of an Azure Active Directory user account.</description></item>
  967. <item><term>AZURE_PASSWORD</term><description>The password of the Azure Active Directory user account. Note this does not support accounts with MFA enabled.</description></item>
  968. </list>
  969. This credential ultimately uses a <see cref="T:Azure.Identity.ClientSecretCredential" />, <see cref="T:Azure.Identity.ClientCertificateCredential" />, or <see cref="T:Azure.Identity.UsernamePasswordCredential" /> to
  970. perform the authentication using these details. Please consult the
  971. documentation of that class for more details.
  972. </summary>
  973. </member>
  974. <member name="M:Azure.Identity.EnvironmentCredential.#ctor">
  975. <summary>
  976. Creates an instance of the EnvironmentCredential class and reads client secret details from environment variables.
  977. If the expected environment variables are not found at this time, the GetToken method will return the default <see cref="T:Azure.Core.AccessToken" /> when invoked.
  978. </summary>
  979. </member>
  980. <member name="M:Azure.Identity.EnvironmentCredential.#ctor(Azure.Identity.TokenCredentialOptions)">
  981. <summary>
  982. Creates an instance of the EnvironmentCredential class and reads client secret details from environment variables.
  983. If the expected environment variables are not found at this time, the GetToken method will return the default <see cref="T:Azure.Core.AccessToken" /> when invoked.
  984. </summary>
  985. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  986. </member>
  987. <member name="M:Azure.Identity.EnvironmentCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  988. <summary>
  989. Obtains a token from the Azure Active Directory service, using the specified client details specified in the environment variables
  990. AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET or AZURE_USERNAME and AZURE_PASSWORD to authenticate.
  991. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  992. </summary>
  993. <remarks>
  994. If the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET are not specified, the default <see cref="T:Azure.Core.AccessToken" />
  995. </remarks>
  996. <param name="requestContext">The details of the authentication request.</param>
  997. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  998. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  999. </member>
  1000. <member name="M:Azure.Identity.EnvironmentCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1001. <summary>
  1002. Obtains a token from the Azure Active Directory service, using the specified client details specified in the environment variables
  1003. AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET or AZURE_USERNAME and AZURE_PASSWORD to authenticate.
  1004. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1005. </summary>
  1006. <remarks>
  1007. If the environment variables AZURE_TENANT_ID, AZURE_CLIENT_ID, and AZURE_CLIENT_SECRET are not specifeid, the default <see cref="T:Azure.Core.AccessToken" />
  1008. </remarks>
  1009. <param name="requestContext">The details of the authentication request.</param>
  1010. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1011. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls, or a default <see cref="T:Azure.Core.AccessToken" />.</returns>
  1012. </member>
  1013. <member name="T:Azure.Identity.InteractiveBrowserCredential">
  1014. <summary>
  1015. A <see cref="T:Azure.Core.TokenCredential" /> implementation which launches the system default browser to interactively authenticate a user, and obtain an access token.
  1016. The browser will only be launched to authenticate the user once, then will silently acquire access tokens through the users refresh token as long as it's valid.
  1017. </summary>
  1018. </member>
  1019. <member name="M:Azure.Identity.InteractiveBrowserCredential.#ctor">
  1020. <summary>
  1021. Creates a new <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> with the specified options, which will authenticate users.
  1022. </summary>
  1023. </member>
  1024. <member name="M:Azure.Identity.InteractiveBrowserCredential.#ctor(Azure.Identity.InteractiveBrowserCredentialOptions)">
  1025. <summary>
  1026. Creates a new <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> with the specified options, which will authenticate users with the specified application.
  1027. </summary>
  1028. <param name="options">The client options for the newly created <see cref="T:Azure.Identity.InteractiveBrowserCredential" />.</param>
  1029. </member>
  1030. <member name="M:Azure.Identity.InteractiveBrowserCredential.#ctor(System.String)">
  1031. <summary>
  1032. Creates a new <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> with the specified options, which will authenticate users with the specified application.
  1033. </summary>
  1034. <param name="clientId">The client id of the application to which the users will authenticate</param>
  1035. </member>
  1036. <member name="M:Azure.Identity.InteractiveBrowserCredential.#ctor(System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  1037. <summary>
  1038. Creates a new <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> with the specified options, which will authenticate users with the specified application.
  1039. </summary>
  1040. <param name="tenantId">The tenant id of the application and the users to authenticate. Can be null in the case of multi-tenant applications.</param>
  1041. <param name="clientId">The client id of the application to which the users will authenticate</param>
  1042. TODO: need to link to info on how the application has to be created to authenticate users, for multiple applications
  1043. <param name="options">The client options for the newly created <see cref="T:Azure.Identity.InteractiveBrowserCredential" />.</param>
  1044. </member>
  1045. <member name="M:Azure.Identity.InteractiveBrowserCredential.Authenticate(System.Threading.CancellationToken)">
  1046. <summary>
  1047. Interactively authenticates a user via the default browser.
  1048. </summary>
  1049. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1050. <returns>The result of the authentication request, containing the acquired <see cref="T:Azure.Core.AccessToken" />, and the <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account.</returns>
  1051. </member>
  1052. <member name="M:Azure.Identity.InteractiveBrowserCredential.AuthenticateAsync(System.Threading.CancellationToken)">
  1053. <summary>
  1054. Interactively authenticates a user via the default browser. The resulting <see cref="T:Azure.Identity.AuthenticationRecord" /> will automatically be used in subsequent calls to <see cref="M:Azure.Identity.InteractiveBrowserCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />.
  1055. </summary>
  1056. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1057. <returns>The result of the authentication request, containing the acquired <see cref="T:Azure.Core.AccessToken" />, and the <see cref="T:Azure.Identity.AuthenticationRecord" /> which can be used to silently authenticate the account.</returns>
  1058. </member>
  1059. <member name="M:Azure.Identity.InteractiveBrowserCredential.Authenticate(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1060. <summary>
  1061. Interactively authenticates a user via the default browser. The resulting <see cref="T:Azure.Identity.AuthenticationRecord" /> will automatically be used in subsequent calls to <see cref="M:Azure.Identity.InteractiveBrowserCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" />.
  1062. </summary>
  1063. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1064. <param name="requestContext">The details of the authentication request.</param>
  1065. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1066. </member>
  1067. <member name="M:Azure.Identity.InteractiveBrowserCredential.AuthenticateAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1068. <summary>
  1069. Interactively authenticates a user via the default browser.
  1070. </summary>
  1071. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1072. <param name="requestContext">The details of the authentication request.</param>
  1073. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1074. </member>
  1075. <member name="M:Azure.Identity.InteractiveBrowserCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1076. <summary>
  1077. Obtains an <see cref="T:Azure.Core.AccessToken" /> token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1078. </summary>
  1079. <param name="requestContext">The details of the authentication request.</param>
  1080. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1081. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  1082. </member>
  1083. <member name="M:Azure.Identity.InteractiveBrowserCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1084. <summary>
  1085. Obtains an <see cref="T:Azure.Core.AccessToken" /> token for a user account silently if the user has already authenticated, otherwise the default browser is launched to authenticate the user. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1086. </summary>
  1087. <param name="requestContext">The details of the authentication request.</param>
  1088. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1089. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  1090. </member>
  1091. <member name="T:Azure.Identity.InteractiveBrowserCredentialOptions">
  1092. <summary>
  1093. Options to configure the <see cref="T:Azure.Identity.InteractiveBrowserCredential" />.
  1094. </summary>
  1095. </member>
  1096. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.DisableAutomaticAuthentication">
  1097. <summary>
  1098. Prevents the <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> from automatically prompting the user. If automatic authentication is disabled a AuthenticationRequiredException will be thrown from <see cref="M:Azure.Identity.InteractiveBrowserCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> and <see cref="M:Azure.Identity.InteractiveBrowserCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)" /> in the case that
  1099. user interaction is necessary. The application is responsible for handling this exception, and calling <see cref="M:Azure.Identity.InteractiveBrowserCredential.Authenticate(System.Threading.CancellationToken)" /> or <see cref="M:Azure.Identity.InteractiveBrowserCredential.AuthenticateAsync(System.Threading.CancellationToken)" /> to authenticate the user interactively.
  1100. </summary>
  1101. </member>
  1102. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.TenantId">
  1103. <summary>
  1104. The tenant ID the user will be authenticated to. If not specified the user will be authenticated to the home tenant.
  1105. </summary>
  1106. </member>
  1107. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.ClientId">
  1108. <summary>
  1109. The client ID of the application used to authenticate the user. If not specified the user will be authenticated with an Azure development application.
  1110. </summary>
  1111. </member>
  1112. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.TokenCachePersistenceOptions">
  1113. <summary>
  1114. Specifies the <see cref="P:Azure.Identity.InteractiveBrowserCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
  1115. </summary>
  1116. </member>
  1117. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.RedirectUri">
  1118. <summary>
  1119. Uri where the STS will call back the application with the security token. This parameter is not required if the caller is not using a custom <see cref="P:Azure.Identity.InteractiveBrowserCredentialOptions.ClientId" />. In
  1120. the case that the caller is using their own <see cref="P:Azure.Identity.InteractiveBrowserCredentialOptions.ClientId" /> the value must match the redirect url specified when creating the application registration.
  1121. </summary>
  1122. </member>
  1123. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.AuthenticationRecord">
  1124. <summary>
  1125. The <see cref="T:Azure.Identity.AuthenticationRecord" /> captured from a previous authentication.
  1126. </summary>
  1127. </member>
  1128. <member name="P:Azure.Identity.InteractiveBrowserCredentialOptions.LoginHint">
  1129. <summary>
  1130. Avoids the account prompt and pre-populates the username of the account to login.
  1131. </summary>
  1132. </member>
  1133. <member name="T:Azure.Identity.ManagedIdentityCredential">
  1134. <summary>
  1135. Attempts authentication using a managed identity that has been assigned to the deployment environment. This authentication type works in Azure VMs,
  1136. App Service and Azure Functions applications, as well as the Azure Cloud Shell. More information about configuring managed identities can be found here:
  1137. https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview
  1138. </summary>
  1139. </member>
  1140. <member name="M:Azure.Identity.ManagedIdentityCredential.#ctor">
  1141. <summary>
  1142. Protected constructor for mocking.
  1143. </summary>
  1144. </member>
  1145. <member name="M:Azure.Identity.ManagedIdentityCredential.#ctor(System.String,Azure.Identity.TokenCredentialOptions)">
  1146. <summary>
  1147. Creates an instance of the ManagedIdentityCredential capable of authenticating a resource with a managed identity.
  1148. </summary>
  1149. <param name="clientId">
  1150. The client id to authenticate for a user assigned managed identity. More information on user assigned managed identities can be found here:
  1151. https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview#how-a-user-assigned-managed-identity-works-with-an-azure-vm
  1152. </param>
  1153. <param name="options">Options to configure the management of the requests sent to the Azure Active Directory service.</param>
  1154. </member>
  1155. <member name="M:Azure.Identity.ManagedIdentityCredential.#ctor(Azure.Core.ResourceIdentifier,Azure.Identity.TokenCredentialOptions)">
  1156. <summary>
  1157. Creates an instance of the ManagedIdentityCredential capable of authenticating a resource with a managed identity.
  1158. </summary>
  1159. <param name="resourceId">
  1160. The resource id to authenticate for a user assigned managed identity. More information on user assigned managed identities can be found here:
  1161. https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview#how-a-user-assigned-managed-identity-works-with-an-azure-vm
  1162. </param>
  1163. <param name="options">Options to configure the management of the requests sent to the Azure Active Directory service.</param>
  1164. </member>
  1165. <member name="M:Azure.Identity.ManagedIdentityCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1166. <summary>
  1167. Obtains an <see cref="T:Azure.Core.AccessToken" /> from the Managed Identity service if available. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1168. </summary>
  1169. <param name="requestContext">The details of the authentication request.</param>
  1170. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1171. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls, or a default <see cref="T:Azure.Core.AccessToken" /> if no managed identity is available.</returns>
  1172. </member>
  1173. <member name="M:Azure.Identity.ManagedIdentityCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1174. <summary>
  1175. Obtains an <see cref="T:Azure.Core.AccessToken" /> from the Managed Identity service if available. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1176. </summary>
  1177. <param name="requestContext">The details of the authentication request.</param>
  1178. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1179. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls, or a default <see cref="T:Azure.Core.AccessToken" /> if no managed identity is available.</returns>
  1180. </member>
  1181. <member name="T:Azure.Identity.OnBehalfOfCredential">
  1182. <summary>
  1183. Enables authentication to Azure Active Directory using an On-Behalf-Of flow.
  1184. </summary>
  1185. </member>
  1186. <member name="M:Azure.Identity.OnBehalfOfCredential.#ctor">
  1187. <summary>
  1188. Protected constructor for mocking.
  1189. </summary>
  1190. </member>
  1191. <member name="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
  1192. <summary>
  1193. Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  1194. </summary>
  1195. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  1196. <param name="clientId">The client (application) ID of the service principal</param>
  1197. <param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
  1198. <param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
  1199. </member>
  1200. <member name="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,Azure.Identity.OnBehalfOfCredentialOptions)">
  1201. <summary>
  1202. Creates an instance of the OnBehalfOfCredential with the details needed to authenticate against Azure Active Directory with the specified certificate.
  1203. </summary>
  1204. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  1205. <param name="clientId">The client (application) ID of the service principal</param>
  1206. <param name="clientCertificate">The authentication X509 Certificate of the service principal</param>
  1207. <param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
  1208. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  1209. </member>
  1210. <member name="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.String,System.String)">
  1211. <summary>
  1212. Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate with Azure Active Directory.
  1213. </summary>
  1214. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  1215. <param name="clientId">The client (application) ID of the service principal</param>
  1216. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  1217. <param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
  1218. </member>
  1219. <member name="M:Azure.Identity.OnBehalfOfCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.OnBehalfOfCredentialOptions)">
  1220. <summary>
  1221. Creates an instance of the <see cref="T:Azure.Identity.OnBehalfOfCredential" /> with the details needed to authenticate with Azure Active Directory.
  1222. </summary>
  1223. <param name="tenantId">The Azure Active Directory tenant (directory) Id of the service principal.</param>
  1224. <param name="clientId">The client (application) ID of the service principal</param>
  1225. <param name="clientSecret">A client secret that was generated for the App Registration used to authenticate the client.</param>
  1226. <param name="userAssertion">The access token that will be used by <see cref="T:Azure.Identity.OnBehalfOfCredential" /> as the user assertion when requesting On-Behalf-Of tokens.</param>
  1227. <param name="options">Options that allow to configure the management of the requests sent to the Azure Active Directory service.</param>
  1228. </member>
  1229. <member name="M:Azure.Identity.OnBehalfOfCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1230. <summary>
  1231. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1232. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1233. </member>
  1234. <member name="M:Azure.Identity.OnBehalfOfCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1235. <summary>
  1236. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1237. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1238. </member>
  1239. <member name="T:Azure.Identity.OnBehalfOfCredentialOptions">
  1240. <summary>
  1241. </summary>
  1242. </member>
  1243. <member name="P:Azure.Identity.OnBehalfOfCredentialOptions.TokenCachePersistenceOptions">
  1244. <summary>
  1245. The <see cref="P:Azure.Identity.OnBehalfOfCredentialOptions.TokenCachePersistenceOptions" />.
  1246. </summary>
  1247. </member>
  1248. <member name="P:Azure.Identity.OnBehalfOfCredentialOptions.SendCertificateChain">
  1249. <summary>
  1250. Will include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the <see cref="T:Azure.Identity.ClientCertificateCredential" />.
  1251. </summary>
  1252. </member>
  1253. <member name="P:Azure.Identity.OnBehalfOfCredentialOptions.RegionalAuthority">
  1254. <summary>
  1255. Specifies either the specific <see cref="P:Azure.Identity.OnBehalfOfCredentialOptions.RegionalAuthority" /> (preferred), or use <see cref="P:Azure.Identity.RegionalAuthority.AutoDiscoverRegion" /> to attempt to auto-detect the region.
  1256. If not specified or auto-detection fails the non-regional endpoint will be used.
  1257. </summary>
  1258. </member>
  1259. <member name="T:Azure.Identity.SharedTokenCacheCredential">
  1260. <summary>
  1261. Authenticates using tokens in the local cache shared between Microsoft applications.
  1262. </summary>
  1263. </member>
  1264. <member name="M:Azure.Identity.SharedTokenCacheCredential.#ctor">
  1265. <summary>
  1266. Creates a new <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> which will authenticate users signed in through developer tools supporting Azure single sign on.
  1267. </summary>
  1268. </member>
  1269. <member name="M:Azure.Identity.SharedTokenCacheCredential.#ctor(Azure.Identity.SharedTokenCacheCredentialOptions)">
  1270. <summary>
  1271. Creates a new <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> which will authenticate users signed in through developer tools supporting Azure single sign on.
  1272. </summary>
  1273. <param name="options">The client options for the newly created <see cref="T:Azure.Identity.SharedTokenCacheCredential" /></param>
  1274. </member>
  1275. <member name="M:Azure.Identity.SharedTokenCacheCredential.#ctor(System.String,Azure.Identity.TokenCredentialOptions)">
  1276. <summary>
  1277. Creates a new <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> which will authenticate users signed in through developer tools supporting Azure single sign on.
  1278. </summary>
  1279. <param name="username">The username of the user to authenticate</param>
  1280. <param name="options">The client options for the newly created <see cref="T:Azure.Identity.SharedTokenCacheCredential" /></param>
  1281. </member>
  1282. <member name="M:Azure.Identity.SharedTokenCacheCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1283. <summary>
  1284. Obtains an <see cref="T:Azure.Core.AccessToken" /> token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1285. </summary>
  1286. <param name="requestContext">The details of the authentication request.</param>
  1287. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime</param>
  1288. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls</returns>
  1289. </member>
  1290. <member name="M:Azure.Identity.SharedTokenCacheCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1291. <summary>
  1292. Obtains an <see cref="T:Azure.Core.AccessToken" /> token for a user account silently if the user has already authenticated to another Microsoft application participating in SSO through a shared MSAL cache. This method is called automatically by Azure SDK client libraries. You may call this method directly, but you must also handle token caching and token refreshing.
  1293. </summary>
  1294. <param name="requestContext">The details of the authentication request.</param>
  1295. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime</param>
  1296. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls</returns>
  1297. </member>
  1298. <member name="T:Azure.Identity.SharedTokenCacheCredentialOptions">
  1299. <summary>
  1300. Options to configure the <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> authentication.
  1301. </summary>
  1302. </member>
  1303. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.ClientId">
  1304. <summary>
  1305. The client id of the application registration used to authenticate users in the cache.
  1306. </summary>
  1307. </member>
  1308. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.Username">
  1309. <summary>
  1310. Specifies the preferred authentication account username, or UPN, to be retrieved from the shared token cache for single sign on authentication with
  1311. development tools, in the case multiple accounts are found in the shared token.
  1312. </summary>
  1313. </member>
  1314. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.TenantId">
  1315. <summary>
  1316. Specifies the tenant id of the preferred authentication account, to be retrieved from the shared token cache for single sign on authentication with
  1317. development tools, in the case multiple accounts are found in the shared token.
  1318. </summary>
  1319. </member>
  1320. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.EnableGuestTenantAuthentication">
  1321. <summary>
  1322. When set to true the <see cref="T:Azure.Identity.SharedTokenCacheCredential" /> can be used to authenticate to tenants other than the home tenant, requiring <see cref="P:Azure.Identity.SharedTokenCacheCredentialOptions.Username" /> and <see cref="P:Azure.Identity.SharedTokenCacheCredentialOptions.TenantId" /> also to be specified as well.
  1323. </summary>
  1324. </member>
  1325. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.AuthenticationRecord">
  1326. <summary>
  1327. The <see cref="T:Azure.Identity.AuthenticationRecord" /> captured from a previous authentication with an interactive credential, such as the <see cref="T:Azure.Identity.InteractiveBrowserCredential" /> or <see cref="T:Azure.Identity.DeviceCodeCredential" />.
  1328. </summary>
  1329. </member>
  1330. <member name="P:Azure.Identity.SharedTokenCacheCredentialOptions.TokenCachePersistenceOptions">
  1331. <summary>
  1332. Specifies the <see cref="P:Azure.Identity.SharedTokenCacheCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential.
  1333. </summary>
  1334. </member>
  1335. <member name="M:Azure.Identity.SharedTokenCacheCredentialOptions.#ctor">
  1336. <summary>
  1337. Initializes a new instance of <see cref="T:Azure.Identity.SharedTokenCacheCredentialOptions" />.
  1338. </summary>
  1339. </member>
  1340. <member name="M:Azure.Identity.SharedTokenCacheCredentialOptions.#ctor(Azure.Identity.TokenCachePersistenceOptions)">
  1341. <summary>
  1342. Initializes a new instance of <see cref="T:Azure.Identity.SharedTokenCacheCredentialOptions" />.
  1343. </summary>
  1344. <param name="tokenCacheOptions">The <see cref="P:Azure.Identity.SharedTokenCacheCredentialOptions.TokenCachePersistenceOptions" /> that will apply to the token cache used by this credential.</param>
  1345. </member>
  1346. <member name="T:Azure.Identity.TokenCredentialOptions">
  1347. <summary>
  1348. Options to configure requests made to the OAUTH identity service.
  1349. </summary>
  1350. </member>
  1351. <member name="M:Azure.Identity.TokenCredentialOptions.#ctor">
  1352. <summary>
  1353. Constructs a new <see cref="T:Azure.Identity.TokenCredentialOptions" /> instance.
  1354. </summary>
  1355. </member>
  1356. <member name="P:Azure.Identity.TokenCredentialOptions.AuthorityHost">
  1357. <summary>
  1358. The host of the Azure Active Directory authority. The default is https://login.microsoftonline.com/. For well known authority hosts for Azure cloud instances see <see cref="T:Azure.Identity.AzureAuthorityHosts" />.
  1359. </summary>
  1360. </member>
  1361. <member name="P:Azure.Identity.TokenCredentialOptions.IsLoggingPIIEnabled">
  1362. <summary>
  1363. Gets or sets value indicating if ETW logging that contains PII content should be logged.
  1364. Setting this property will not disable redaction of <see cref="T:Azure.Core.Request" /> Content. To enable logging of sensitive <see cref="P:Azure.Core.Request.Content" />
  1365. the <see cref="P:Azure.Core.DiagnosticsOptions.IsLoggingContentEnabled" /> property must be set to <c>true</c>.
  1366. </summary>
  1367. </member>
  1368. <member name="P:Azure.Identity.TokenCredentialOptions.Diagnostics">
  1369. <summary>
  1370. Gets the credential diagnostic options.
  1371. </summary>
  1372. </member>
  1373. <member name="T:Azure.Identity.UsernamePasswordCredential">
  1374. <summary>
  1375. Enables authentication to Azure Active Directory using a user's username and password. If the user has MFA enabled this
  1376. credential will fail to get a token throwing an <see cref="T:Azure.Identity.AuthenticationFailedException" />. Also, this credential requires a high degree of
  1377. trust and is not recommended outside of prototyping when more secure credentials can be used.
  1378. </summary>
  1379. </member>
  1380. <member name="M:Azure.Identity.UsernamePasswordCredential.#ctor">
  1381. <summary>
  1382. Protected constructor for mocking
  1383. </summary>
  1384. </member>
  1385. <member name="M:Azure.Identity.UsernamePasswordCredential.#ctor(System.String,System.String,System.String,System.String)">
  1386. <summary>
  1387. Creates an instance of the <see cref="T:Azure.Identity.UsernamePasswordCredential" /> with the details needed to authenticate against Azure Active Directory with a simple username
  1388. and password.
  1389. </summary>
  1390. <param name="username">The user account's username, also known as UPN.</param>
  1391. <param name="password">The user account's password.</param>
  1392. <param name="tenantId">The Azure Active Directory tenant (directory) ID or name.</param>
  1393. <param name="clientId">The client (application) ID of an App Registration in the tenant.</param>
  1394. </member>
  1395. <member name="M:Azure.Identity.UsernamePasswordCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.TokenCredentialOptions)">
  1396. <summary>
  1397. Creates an instance of the <see cref="T:Azure.Identity.UsernamePasswordCredential" /> with the details needed to authenticate against Azure Active Directory with a simple username
  1398. and password.
  1399. </summary>
  1400. <param name="username">The user account's user name, UPN.</param>
  1401. <param name="password">The user account's password.</param>
  1402. <param name="tenantId">The Azure Active Directory tenant (directory) ID or name.</param>
  1403. <param name="clientId">The client (application) ID of an App Registration in the tenant.</param>
  1404. <param name="options">The client options for the newly created UsernamePasswordCredential</param>
  1405. </member>
  1406. <member name="M:Azure.Identity.UsernamePasswordCredential.#ctor(System.String,System.String,System.String,System.String,Azure.Identity.UsernamePasswordCredentialOptions)">
  1407. <summary>
  1408. Creates an instance of the <see cref="T:Azure.Identity.UsernamePasswordCredential" /> with the details needed to authenticate against Azure Active Directory with a simple username
  1409. and password.
  1410. </summary>
  1411. <param name="username">The user account's user name, UPN.</param>
  1412. <param name="password">The user account's password.</param>
  1413. <param name="tenantId">The Azure Active Directory tenant (directory) ID or name.</param>
  1414. <param name="clientId">The client (application) ID of an App Registration in the tenant.</param>
  1415. <param name="options">The client options for the newly created UsernamePasswordCredential</param>
  1416. </member>
  1417. <member name="M:Azure.Identity.UsernamePasswordCredential.Authenticate(System.Threading.CancellationToken)">
  1418. <summary>
  1419. Authenticates the user using the specified username and password.
  1420. </summary>
  1421. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1422. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1423. </member>
  1424. <member name="M:Azure.Identity.UsernamePasswordCredential.AuthenticateAsync(System.Threading.CancellationToken)">
  1425. <summary>
  1426. Authenticates the user using the specified username and password.
  1427. </summary>
  1428. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1429. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1430. </member>
  1431. <member name="M:Azure.Identity.UsernamePasswordCredential.Authenticate(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1432. <summary>
  1433. Authenticates the user using the specified username and password.
  1434. </summary>
  1435. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1436. <param name="requestContext">The details of the authentication request.</param>
  1437. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1438. </member>
  1439. <member name="M:Azure.Identity.UsernamePasswordCredential.AuthenticateAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1440. <summary>
  1441. Authenticates the user using the specified username and password.
  1442. </summary>
  1443. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1444. <param name="requestContext">The details of the authentication request.</param>
  1445. <returns>The <see cref="T:Azure.Identity.AuthenticationRecord" /> of the authenticated account.</returns>
  1446. </member>
  1447. <member name="M:Azure.Identity.UsernamePasswordCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1448. <summary>
  1449. Obtains a token for a user account, authenticating them using the given username and password. Note: This will fail with
  1450. an <see cref="T:Azure.Identity.AuthenticationFailedException" /> if the specified user account has MFA enabled. This method is called automatically by Azure SDK client libraries.
  1451. You may call this method directly, but you must also handle token caching and token refreshing.
  1452. </summary>
  1453. <param name="requestContext">The details of the authentication request.</param>
  1454. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1455. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  1456. </member>
  1457. <member name="M:Azure.Identity.UsernamePasswordCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1458. <summary>
  1459. Obtains a token for a user account, authenticating them using the given username and password. Note: This will fail with
  1460. an <see cref="T:Azure.Identity.AuthenticationFailedException" /> if the specified user account has MFA enabled. This method is called automatically by Azure SDK client libraries.
  1461. You may call this method directly, but you must also handle token caching and token refreshing.
  1462. </summary>
  1463. <param name="requestContext">The details of the authentication request.</param>
  1464. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
  1465. <returns>An <see cref="T:Azure.Core.AccessToken" /> which can be used to authenticate service client calls.</returns>
  1466. </member>
  1467. <member name="T:Azure.Identity.UsernamePasswordCredentialOptions">
  1468. <summary>
  1469. Options to configure the <see cref="T:Azure.Identity.UsernamePasswordCredential" />.
  1470. </summary>
  1471. </member>
  1472. <member name="P:Azure.Identity.UsernamePasswordCredentialOptions.TokenCachePersistenceOptions">
  1473. <summary>
  1474. Specifies the <see cref="P:Azure.Identity.UsernamePasswordCredentialOptions.TokenCachePersistenceOptions" /> to be used by the credential. If not options are specified, the token cache will not be persisted to disk.
  1475. </summary>
  1476. </member>
  1477. <member name="T:Azure.Identity.VisualStudioCodeCredential">
  1478. <summary>
  1479. Enables authentication to Azure Active Directory using data from Visual Studio Code.
  1480. </summary>
  1481. </member>
  1482. <member name="M:Azure.Identity.VisualStudioCodeCredential.#ctor">
  1483. <summary>
  1484. Creates a new instance of the <see cref="T:Azure.Identity.VisualStudioCodeCredential" />.
  1485. </summary>
  1486. </member>
  1487. <member name="M:Azure.Identity.VisualStudioCodeCredential.#ctor(Azure.Identity.VisualStudioCodeCredentialOptions)">
  1488. <summary>
  1489. Creates a new instance of the <see cref="T:Azure.Identity.VisualStudioCodeCredential" /> with the specified options.
  1490. </summary>
  1491. <param name="options">Options for configuring the credential.</param>
  1492. </member>
  1493. <member name="M:Azure.Identity.VisualStudioCodeCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1494. <summary>
  1495. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1496. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1497. </member>
  1498. <member name="M:Azure.Identity.VisualStudioCodeCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1499. <summary>
  1500. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1501. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1502. </member>
  1503. <member name="T:Azure.Identity.VisualStudioCodeCredentialOptions">
  1504. <summary>
  1505. Options for configuring the <see cref="T:Azure.Identity.VisualStudioCodeCredential" />.
  1506. </summary>
  1507. </member>
  1508. <member name="P:Azure.Identity.VisualStudioCodeCredentialOptions.TenantId">
  1509. <summary>
  1510. The tenant ID the user will be authenticated to. If not specified the user will be authenticated to the tenant the user originally authenticated to via the Visual Studio Code Azure Account plugin.
  1511. </summary>
  1512. </member>
  1513. <member name="T:Azure.Identity.VisualStudioCredential">
  1514. <summary>
  1515. Enables authentication to Azure Active Directory using data from Visual Studio
  1516. </summary>
  1517. </member>
  1518. <member name="M:Azure.Identity.VisualStudioCredential.#ctor">
  1519. <summary>
  1520. Creates a new instance of the <see cref="T:Azure.Identity.VisualStudioCredential" />.
  1521. </summary>
  1522. </member>
  1523. <member name="M:Azure.Identity.VisualStudioCredential.#ctor(Azure.Identity.VisualStudioCredentialOptions)">
  1524. <summary>
  1525. Creates a new instance of the <see cref="T:Azure.Identity.VisualStudioCredential" /> with the specified options.
  1526. </summary>
  1527. <param name="options">Options for configuring the credential.</param>
  1528. </member>
  1529. <member name="M:Azure.Identity.VisualStudioCredential.GetTokenAsync(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1530. <summary>
  1531. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1532. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1533. </member>
  1534. <member name="M:Azure.Identity.VisualStudioCredential.GetToken(Azure.Core.TokenRequestContext,System.Threading.CancellationToken)">
  1535. <summary>
  1536. Gets an <see cref="T:Azure.Core.AccessToken" /> for the specified set of scopes.
  1537. </summary><param name="requestContext">The <see cref="T:Azure.Core.TokenRequestContext" /> with authentication information.</param><param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> to use.</param><returns>A valid <see cref="T:Azure.Core.AccessToken" />.</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>
  1538. </member>
  1539. <member name="T:Azure.Identity.VisualStudioCredentialOptions">
  1540. <summary>
  1541. Options for configuring the <see cref="T:Azure.Identity.VisualStudioCredential" />.
  1542. </summary>
  1543. </member>
  1544. <member name="P:Azure.Identity.VisualStudioCredentialOptions.TenantId">
  1545. <summary>
  1546. The tenant ID the user will be authenticated to. If not specified the user will be authenticated to their home tenant.
  1547. </summary>
  1548. </member>
  1549. <member name="T:Azure.Identity.CredentialUnavailableException">
  1550. <summary>
  1551. An exception indicating a <see cref="T:Azure.Core.TokenCredential" /> did not attempt to authenticate and retrieve <see cref="T:Azure.Core.AccessToken" />, as its prerequisite information or state was not available.
  1552. </summary>
  1553. </member>
  1554. <member name="M:Azure.Identity.CredentialUnavailableException.#ctor(System.String)">
  1555. <summary>
  1556. Creates a new <see cref="T:Azure.Identity.CredentialUnavailableException" /> with the specified message.
  1557. </summary>
  1558. <param name="message">The message describing the authentication failure.</param>
  1559. </member>
  1560. <member name="M:Azure.Identity.CredentialUnavailableException.#ctor(System.String,System.Exception)">
  1561. <summary>
  1562. Creates a new <see cref="T:Azure.Identity.CredentialUnavailableException" /> with the specified message.
  1563. </summary>
  1564. <param name="message">The message describing the authentication failure.</param>
  1565. <param name="innerException">The exception underlying the authentication failure.</param>
  1566. </member>
  1567. <member name="M:Azure.Identity.CredentialUnavailableException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1568. <summary>
  1569. A constructor used for serialization.
  1570. </summary>
  1571. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" />.</param>
  1572. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" />.</param>
  1573. <returns></returns>
  1574. </member>
  1575. <member name="T:Azure.Identity.DeviceCodeInfo">
  1576. <summary>
  1577. Details of the device code to present to a user to allow them to authenticate through the device code authentication flow.
  1578. </summary>
  1579. </member>
  1580. <member name="P:Azure.Identity.DeviceCodeInfo.UserCode">
  1581. <summary>
  1582. User code returned by the service
  1583. </summary>
  1584. </member>
  1585. <member name="P:Azure.Identity.DeviceCodeInfo.DeviceCode">
  1586. <summary>
  1587. Device code returned by the service
  1588. </summary>
  1589. </member>
  1590. <member name="P:Azure.Identity.DeviceCodeInfo.VerificationUri">
  1591. <summary>
  1592. Verification URL where the user must navigate to authenticate using the device code and credentials.
  1593. </summary>
  1594. </member>
  1595. <member name="P:Azure.Identity.DeviceCodeInfo.ExpiresOn">
  1596. <summary>
  1597. Time when the device code will expire.
  1598. </summary>
  1599. </member>
  1600. <member name="P:Azure.Identity.DeviceCodeInfo.Message">
  1601. <summary>
  1602. User friendly text response that can be used for display purpose.
  1603. </summary>
  1604. </member>
  1605. <member name="P:Azure.Identity.DeviceCodeInfo.ClientId">
  1606. <summary>
  1607. Identifier of the client requesting device code.
  1608. </summary>
  1609. </member>
  1610. <member name="P:Azure.Identity.DeviceCodeInfo.Scopes">
  1611. <summary>
  1612. List of the scopes that would be held by token.
  1613. </summary>
  1614. </member>
  1615. <member name="T:Azure.Identity.HttpPipelineClientFactory">
  1616. <summary>
  1617. This class is an HttpClient factory which creates an HttpClient which delegates it's transport to an HttpPipeline, to enable MSAL to send requests through an Azure.Core HttpPipeline.
  1618. </summary>
  1619. </member>
  1620. <member name="T:Azure.Identity.IdentityModelFactory">
  1621. <summary>
  1622. Model factory that enables mocking for the Azure Identity library.
  1623. </summary>
  1624. </member>
  1625. <member name="M:Azure.Identity.IdentityModelFactory.AuthenticationRecord(System.String,System.String,System.String,System.String,System.String)">
  1626. <summary>
  1627. Initializes a new instance of the <see cref="M:Azure.Identity.IdentityModelFactory.AuthenticationRecord(System.String,System.String,System.String,System.String,System.String)" /> class for mocking purposes.
  1628. </summary>
  1629. <param name="username">Sets the <see cref="P:Azure.Identity.AuthenticationRecord.Username" />.</param>
  1630. <param name="authority">Sets the <see cref="P:Azure.Identity.AuthenticationRecord.Authority" />.</param>
  1631. <param name="homeAccountId">Sets the <see cref="P:Azure.Identity.AuthenticationRecord.HomeAccountId" />.</param>
  1632. <param name="tenantId">Sets the <see cref="P:Azure.Identity.AuthenticationRecord.TenantId" />.</param>
  1633. <param name="clientId">Sets the <see cref="P:Azure.Identity.AuthenticationRecord.ClientId" />.</param>
  1634. <returns>A new instance of the <see cref="M:Azure.Identity.IdentityModelFactory.AuthenticationRecord(System.String,System.String,System.String,System.String,System.String)" /> for mocking purposes.</returns>
  1635. </member>
  1636. <member name="M:Azure.Identity.IdentityModelFactory.DeviceCodeInfo(System.String,System.String,System.Uri,System.DateTimeOffset,System.String,System.String,System.Collections.Generic.IReadOnlyCollection{System.String})">
  1637. <summary>
  1638. Initializes a new instance of the <see cref="M:Azure.Identity.IdentityModelFactory.DeviceCodeInfo(System.String,System.String,System.Uri,System.DateTimeOffset,System.String,System.String,System.Collections.Generic.IReadOnlyCollection{System.String})" /> class for mocking purposes.
  1639. </summary>
  1640. <param name="userCode">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.UserCode" />.</param>
  1641. <param name="deviceCode">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.DeviceCode" />.</param>
  1642. <param name="verificationUri">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.VerificationUri" />.</param>
  1643. <param name="expiresOn">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.ExpiresOn" />.</param>
  1644. <param name="message">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.Message" />.</param>
  1645. <param name="clientId">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.ClientId" />.</param>
  1646. <param name="scopes">Sets the <see cref="P:Azure.Identity.DeviceCodeInfo.Scopes" />.</param>
  1647. <returns>A new instance of the <see cref="M:Azure.Identity.IdentityModelFactory.DeviceCodeInfo(System.String,System.String,System.Uri,System.DateTimeOffset,System.String,System.String,System.Collections.Generic.IReadOnlyCollection{System.String})" /> for mocking purposes.</returns>
  1648. </member>
  1649. <member name="T:Azure.Identity.IX509Certificate2Provider">
  1650. <summary>
  1651. IX509Certificate2Provider provides a way to control how the X509Certificate2 object is fetched.
  1652. </summary>
  1653. </member>
  1654. <member name="M:Azure.Identity.MsalCacheHelperWrapper.#ctor">
  1655. <summary>
  1656. Default Constructor.
  1657. </summary>
  1658. </member>
  1659. <member name="M:Azure.Identity.MsalCacheHelperWrapper.InitializeAsync(Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties,System.Diagnostics.TraceSource)">
  1660. <summary>
  1661. Creates a new instance of Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.
  1662. To configure MSAL to use this cache persistence, call Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.RegisterCache(Microsoft.Identity.Client.ITokenCache)
  1663. </summary>
  1664. <param name="storageCreationProperties"></param>
  1665. <param name="logger">Passing null uses a default logger</param>
  1666. <returns>A new instance of Microsoft.Identity.Client.Extensions.Msal.MsalCacheHelper.</returns>
  1667. </member>
  1668. <member name="M:Azure.Identity.MsalCacheHelperWrapper.VerifyPersistence">
  1669. <summary>
  1670. Performs a write -&gt; read -&gt; clear using the underlying persistence mechanism
  1671. and throws an Microsoft.Identity.Client.Extensions.Msal.MsalCachePersistenceException
  1672. if something goes wrong.
  1673. </summary>
  1674. <remarks>
  1675. Does not overwrite the token cache. Should never fail on Windows and Mac where
  1676. the cache accessors are guaranteed to exist by the OS.
  1677. </remarks>
  1678. </member>
  1679. <member name="M:Azure.Identity.MsalCacheHelperWrapper.RegisterCache(Microsoft.Identity.Client.ITokenCache)">
  1680. <summary>
  1681. Registers a token cache to synchronize with on disk storage.
  1682. </summary>
  1683. <param name="tokenCache"></param>
  1684. </member>
  1685. <member name="M:Azure.Identity.MsalCacheHelperWrapper.UnregisterCache(Microsoft.Identity.Client.ITokenCache)">
  1686. <summary>
  1687. Unregisters a token cache so it no longer synchronizes with on disk storage.
  1688. </summary>
  1689. <param name="tokenCache"></param>
  1690. </member>
  1691. <member name="M:Azure.Identity.MsalCacheHelperWrapper.LoadUnencryptedTokenCache">
  1692. <summary>
  1693. Extracts the token cache data from the persistent store
  1694. </summary>
  1695. <remarks>
  1696. This method should be used with care. The data returned is unencrypted.
  1697. </remarks>
  1698. <returns>UTF-8 byte array of the unencrypted token cache</returns>
  1699. </member>
  1700. <member name="M:Azure.Identity.MsalCacheHelperWrapper.SaveUnencryptedTokenCache(System.Byte[])">
  1701. <summary>
  1702. Saves an unencrypted, UTF-8 encoded byte array representing an MSAL token cache.
  1703. The save operation will persist the data in a secure location, as configured
  1704. in Microsoft.Identity.Client.Extensions.Msal.StorageCreationProperties
  1705. </summary>
  1706. </member>
  1707. <member name="M:Azure.Identity.MsalClientBase`1.#ctor">
  1708. <summary>
  1709. For mocking purposes only.
  1710. </summary>
  1711. </member>
  1712. <member name="M:Azure.Identity.MsalConfidentialClient.#ctor">
  1713. <summary>
  1714. For mocking purposes only.
  1715. </summary>
  1716. </member>
  1717. <member name="T:Azure.Identity.RegionalAuthority">
  1718. <summary>
  1719. Identifies the regional authority to be used for authentication.
  1720. </summary>
  1721. </member>
  1722. <member name="M:Azure.Identity.RegionalAuthority.#ctor(System.String)">
  1723. <summary>
  1724. Initializes a new instance of the <see cref="T:Azure.Identity.RegionalAuthority" /> structure.
  1725. </summary>
  1726. <param name="value">The string value of the instance.</param>
  1727. </member>
  1728. <member name="P:Azure.Identity.RegionalAuthority.AutoDiscoverRegion">
  1729. <summary>
  1730. In cases where the region is not known ahead of time, attempts to automatically discover the appropriate <see cref="T:Azure.Identity.RegionalAuthority" />. This works on some azure hosts, such as some VMs (through IDMS), and Azure Functions (using host populated environment variables).
  1731. If the auto-detection fails, the non-regional authority is used.
  1732. </summary>
  1733. </member>
  1734. <member name="P:Azure.Identity.RegionalAuthority.USWest">
  1735. <summary>
  1736. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'westus' region.
  1737. </summary>
  1738. </member>
  1739. <member name="P:Azure.Identity.RegionalAuthority.USWest2">
  1740. <summary>
  1741. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'westus2' region.
  1742. </summary>
  1743. </member>
  1744. <member name="P:Azure.Identity.RegionalAuthority.USCentral">
  1745. <summary>
  1746. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'centralus' region.
  1747. </summary>
  1748. </member>
  1749. <member name="P:Azure.Identity.RegionalAuthority.USEast">
  1750. <summary>
  1751. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'eastus' region.
  1752. </summary>
  1753. </member>
  1754. <member name="P:Azure.Identity.RegionalAuthority.USEast2">
  1755. <summary>
  1756. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'eastus2' region.
  1757. </summary>
  1758. </member>
  1759. <member name="P:Azure.Identity.RegionalAuthority.USNorthCentral">
  1760. <summary>
  1761. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'northcentralus' region.
  1762. </summary>
  1763. </member>
  1764. <member name="P:Azure.Identity.RegionalAuthority.USSouthCentral">
  1765. <summary>
  1766. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'southcentralus' region.
  1767. </summary>
  1768. </member>
  1769. <member name="P:Azure.Identity.RegionalAuthority.USWestCentral">
  1770. <summary>
  1771. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'westcentralus' region.
  1772. </summary>
  1773. </member>
  1774. <member name="P:Azure.Identity.RegionalAuthority.CanadaCentral">
  1775. <summary>
  1776. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'canadacentral' region.
  1777. </summary>
  1778. </member>
  1779. <member name="P:Azure.Identity.RegionalAuthority.CanadaEast">
  1780. <summary>
  1781. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'canadaeast' region.
  1782. </summary>
  1783. </member>
  1784. <member name="P:Azure.Identity.RegionalAuthority.BrazilSouth">
  1785. <summary>
  1786. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'brazilsouth' region.
  1787. </summary>
  1788. </member>
  1789. <member name="P:Azure.Identity.RegionalAuthority.EuropeNorth">
  1790. <summary>
  1791. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'northeurope' region.
  1792. </summary>
  1793. </member>
  1794. <member name="P:Azure.Identity.RegionalAuthority.EuropeWest">
  1795. <summary>
  1796. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'westeurope' region.
  1797. </summary>
  1798. </member>
  1799. <member name="P:Azure.Identity.RegionalAuthority.UKSouth">
  1800. <summary>
  1801. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'uksouth' region.
  1802. </summary>
  1803. </member>
  1804. <member name="P:Azure.Identity.RegionalAuthority.UKWest">
  1805. <summary>
  1806. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'ukwest' region.
  1807. </summary>
  1808. </member>
  1809. <member name="P:Azure.Identity.RegionalAuthority.FranceCentral">
  1810. <summary>
  1811. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'francecentral' region.
  1812. </summary>
  1813. </member>
  1814. <member name="P:Azure.Identity.RegionalAuthority.FranceSouth">
  1815. <summary>
  1816. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'francesouth' region.
  1817. </summary>
  1818. </member>
  1819. <member name="P:Azure.Identity.RegionalAuthority.SwitzerlandNorth">
  1820. <summary>
  1821. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'switzerlandnorth' region.
  1822. </summary>
  1823. </member>
  1824. <member name="P:Azure.Identity.RegionalAuthority.SwitzerlandWest">
  1825. <summary>
  1826. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'switzerlandwest' region.
  1827. </summary>
  1828. </member>
  1829. <member name="P:Azure.Identity.RegionalAuthority.GermanyNorth">
  1830. <summary>
  1831. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'germanynorth' region.
  1832. </summary>
  1833. </member>
  1834. <member name="P:Azure.Identity.RegionalAuthority.GermanyWestCentral">
  1835. <summary>
  1836. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'germanywestcentral' region.
  1837. </summary>
  1838. </member>
  1839. <member name="P:Azure.Identity.RegionalAuthority.NorwayWest">
  1840. <summary>
  1841. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'norwaywest' region.
  1842. </summary>
  1843. </member>
  1844. <member name="P:Azure.Identity.RegionalAuthority.NorwayEast">
  1845. <summary>
  1846. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'norwayeast' region.
  1847. </summary>
  1848. </member>
  1849. <member name="P:Azure.Identity.RegionalAuthority.AsiaEast">
  1850. <summary>
  1851. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'eastasia' region.
  1852. </summary>
  1853. </member>
  1854. <member name="P:Azure.Identity.RegionalAuthority.AsiaSouthEast">
  1855. <summary>
  1856. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'southeastasia' region.
  1857. </summary>
  1858. </member>
  1859. <member name="P:Azure.Identity.RegionalAuthority.JapanEast">
  1860. <summary>
  1861. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'japaneast' region.
  1862. </summary>
  1863. </member>
  1864. <member name="P:Azure.Identity.RegionalAuthority.JapanWest">
  1865. <summary>
  1866. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'japanwest' region.
  1867. </summary>
  1868. </member>
  1869. <member name="P:Azure.Identity.RegionalAuthority.AustraliaEast">
  1870. <summary>
  1871. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'australiaeast' region.
  1872. </summary>
  1873. </member>
  1874. <member name="P:Azure.Identity.RegionalAuthority.AustraliaSouthEast">
  1875. <summary>
  1876. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'australiasoutheast' region.
  1877. </summary>
  1878. </member>
  1879. <member name="P:Azure.Identity.RegionalAuthority.AustraliaCentral">
  1880. <summary>
  1881. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'australiacentral' region.
  1882. </summary>
  1883. </member>
  1884. <member name="P:Azure.Identity.RegionalAuthority.AustraliaCentral2">
  1885. <summary>
  1886. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'australiacentral2' region.
  1887. </summary>
  1888. </member>
  1889. <member name="P:Azure.Identity.RegionalAuthority.IndiaCentral">
  1890. <summary>
  1891. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'centralindia' region.
  1892. </summary>
  1893. </member>
  1894. <member name="P:Azure.Identity.RegionalAuthority.IndiaSouth">
  1895. <summary>
  1896. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'southindia' region.
  1897. </summary>
  1898. </member>
  1899. <member name="P:Azure.Identity.RegionalAuthority.IndiaWest">
  1900. <summary>
  1901. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'westindia' region.
  1902. </summary>
  1903. </member>
  1904. <member name="P:Azure.Identity.RegionalAuthority.KoreaSouth">
  1905. <summary>
  1906. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'koreasouth' region.
  1907. </summary>
  1908. </member>
  1909. <member name="P:Azure.Identity.RegionalAuthority.KoreaCentral">
  1910. <summary>
  1911. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'koreacentral' region.
  1912. </summary>
  1913. </member>
  1914. <member name="P:Azure.Identity.RegionalAuthority.UAECentral">
  1915. <summary>
  1916. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'uaecentral' region.
  1917. </summary>
  1918. </member>
  1919. <member name="P:Azure.Identity.RegionalAuthority.UAENorth">
  1920. <summary>
  1921. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'uaenorth' region.
  1922. </summary>
  1923. </member>
  1924. <member name="P:Azure.Identity.RegionalAuthority.SouthAfricaNorth">
  1925. <summary>
  1926. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'southafricanorth' region.
  1927. </summary>
  1928. </member>
  1929. <member name="P:Azure.Identity.RegionalAuthority.SouthAfricaWest">
  1930. <summary>
  1931. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'southafricawest' region.
  1932. </summary>
  1933. </member>
  1934. <member name="P:Azure.Identity.RegionalAuthority.ChinaNorth">
  1935. <summary>
  1936. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'chinanorth' region.
  1937. </summary>
  1938. </member>
  1939. <member name="P:Azure.Identity.RegionalAuthority.ChinaEast">
  1940. <summary>
  1941. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'chinaeast' region.
  1942. </summary>
  1943. </member>
  1944. <member name="P:Azure.Identity.RegionalAuthority.ChinaNorth2">
  1945. <summary>
  1946. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'chinanorth2' region.
  1947. </summary>
  1948. </member>
  1949. <member name="P:Azure.Identity.RegionalAuthority.ChinaEast2">
  1950. <summary>
  1951. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'chinaeast2' region.
  1952. </summary>
  1953. </member>
  1954. <member name="P:Azure.Identity.RegionalAuthority.GermanyCentral">
  1955. <summary>
  1956. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'germanycentral' region.
  1957. </summary>
  1958. </member>
  1959. <member name="P:Azure.Identity.RegionalAuthority.GermanyNorthEast">
  1960. <summary>
  1961. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'germanynortheast' region.
  1962. </summary>
  1963. </member>
  1964. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSVirginia">
  1965. <summary>
  1966. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usgovvirginia' region.
  1967. </summary>
  1968. </member>
  1969. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSIowa">
  1970. <summary>
  1971. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usgoviowa' region.
  1972. </summary>
  1973. </member>
  1974. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSArizona">
  1975. <summary>
  1976. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usgovarizona' region.
  1977. </summary>
  1978. </member>
  1979. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSTexas">
  1980. <summary>
  1981. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usgovtexas' region.
  1982. </summary>
  1983. </member>
  1984. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSDodEast">
  1985. <summary>
  1986. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usdodeast' region.
  1987. </summary>
  1988. </member>
  1989. <member name="P:Azure.Identity.RegionalAuthority.GovernmentUSDodCentral">
  1990. <summary>
  1991. Uses the <see cref="T:Azure.Identity.RegionalAuthority" /> for the Azure 'usdodcentral' region.
  1992. </summary>
  1993. </member>
  1994. <member name="M:Azure.Identity.RegionalAuthority.op_Equality(Azure.Identity.RegionalAuthority,Azure.Identity.RegionalAuthority)">
  1995. <summary>
  1996. Determines if two <see cref="T:Azure.Identity.RegionalAuthority" /> values are the same.
  1997. </summary>
  1998. <param name="left">The first <see cref="T:Azure.Identity.RegionalAuthority" /> to compare.</param>
  1999. <param name="right">The second <see cref="T:Azure.Identity.RegionalAuthority" /> to compare.</param>
  2000. <returns>True if <paramref name="left" /> and <paramref name="right" /> are the same; otherwise, false.</returns>
  2001. </member>
  2002. <member name="M:Azure.Identity.RegionalAuthority.op_Inequality(Azure.Identity.RegionalAuthority,Azure.Identity.RegionalAuthority)">
  2003. <summary>
  2004. Determines if two <see cref="T:Azure.Identity.RegionalAuthority" /> values are different.
  2005. </summary>
  2006. <param name="left">The first <see cref="T:Azure.Identity.RegionalAuthority" /> to compare.</param>
  2007. <param name="right">The second <see cref="T:Azure.Identity.RegionalAuthority" /> to compare.</param>
  2008. <returns>True if <paramref name="left" /> and <paramref name="right" /> are different; otherwise, false.</returns>
  2009. </member>
  2010. <member name="M:Azure.Identity.RegionalAuthority.op_Implicit(System.String)~Azure.Identity.RegionalAuthority">
  2011. <summary>
  2012. Converts a string to a <see cref="T:Azure.Identity.RegionalAuthority" />.
  2013. </summary>
  2014. <param name="value">The string value to convert.</param>
  2015. </member>
  2016. <member name="M:Azure.Identity.RegionalAuthority.Equals(System.Object)">
  2017. <summary>Indicates whether this instance and a specified object are equal.</summary><param name="obj">The object to compare with the current instance.</param><returns><see langword="true" /> if <paramref name="obj" /> and this instance are the same type and represent the same value; otherwise, <see langword="false" />.</returns>
  2018. </member>
  2019. <member name="M:Azure.Identity.RegionalAuthority.Equals(Azure.Identity.RegionalAuthority)">
  2020. <summary>Indicates whether the current object is equal to another object of the same type.</summary><param name="other">An object to compare with this object.</param><returns><see langword="true" /> if the current object is equal to the <paramref name="other" /> parameter; otherwise, <see langword="false" />.</returns>
  2021. </member>
  2022. <member name="M:Azure.Identity.RegionalAuthority.GetHashCode">
  2023. <summary>Returns the hash code for this instance.</summary><returns>A 32-bit signed integer that is the hash code for this instance.</returns>
  2024. </member>
  2025. <member name="M:Azure.Identity.RegionalAuthority.ToString">
  2026. <summary>Returns the fully qualified type name of this instance.</summary><returns>The fully qualified type name.</returns>
  2027. </member>
  2028. <member name="M:Azure.Identity.TenantIdResolver.Resolve(System.String,Azure.Core.TokenRequestContext)">
  2029. <summary>
  2030. Resolves the tenantId based on the supplied configuration values.
  2031. </summary>
  2032. <param name="explicitTenantId">The tenantId passed to the ctor of the Credential.</param>
  2033. <param name="context">The <see cref="T:Azure.Core.TokenRequestContext" />.</param>
  2034. <returns>The tenantId to be used for authorization.</returns>
  2035. </member>
  2036. <member name="T:Azure.Identity.TokenCache">
  2037. <summary>
  2038. A cache for Tokens.
  2039. </summary>
  2040. </member>
  2041. <member name="P:Azure.Identity.TokenCache.Data">
  2042. <summary>
  2043. The internal state of the cache.
  2044. </summary>
  2045. </member>
  2046. <member name="M:Azure.Identity.TokenCache.#ctor(Azure.Identity.TokenCachePersistenceOptions)">
  2047. <summary>
  2048. Creates a new instance of <see cref="T:Azure.Identity.TokenCache" /> with the specified options.
  2049. </summary>
  2050. <param name="options">Options controlling the storage of the <see cref="T:Azure.Identity.TokenCache" />.</param>
  2051. </member>
  2052. <member name="F:Azure.Identity.TokenCache.TokenCacheUpdatedAsync">
  2053. <summary>
  2054. A delegate that is called with the cache contents when the underlying <see cref="T:Azure.Identity.TokenCache" /> has been updated.
  2055. </summary>
  2056. </member>
  2057. <member name="F:Azure.Identity.TokenCache.RefreshCacheFromOptionsAsync">
  2058. <summary>
  2059. A delegate that will be called before the cache is accessed. The data returned will be used to set the current state of the cache.
  2060. </summary>
  2061. </member>
  2062. <member name="M:Azure.Identity.TokenCache.ResetWrapperCache">
  2063. <summary>
  2064. Resets the <see cref="F:Azure.Identity.TokenCache.cacheHelperLock" /> so that tests can validate multiple calls to <see cref="M:Azure.Identity.TokenCache.RegisterCache(System.Boolean,Microsoft.Identity.Client.ITokenCache,System.Threading.CancellationToken)" />
  2065. This should only be used for testing.
  2066. </summary>
  2067. </member>
  2068. <member name="T:Azure.Identity.TokenCacheData">
  2069. <summary>
  2070. Details related to a <see cref="T:Azure.Identity.UnsafeTokenCacheOptions" /> cache delegate.
  2071. </summary>
  2072. </member>
  2073. <member name="M:Azure.Identity.TokenCacheData.#ctor(System.ReadOnlyMemory{System.Byte})">
  2074. <summary>
  2075. Constructs a new <see cref="T:Azure.Identity.TokenCacheData" /> instance with the specified cache bytes.
  2076. </summary>
  2077. <param name="cacheBytes">The serialized content of the token cache.</param>
  2078. </member>
  2079. <member name="P:Azure.Identity.TokenCacheData.CacheBytes">
  2080. <summary>
  2081. The bytes representing the state of the token cache.
  2082. </summary>
  2083. </member>
  2084. <member name="T:Azure.Identity.TokenCachePersistenceOptions">
  2085. <summary>
  2086. Options controlling the storage of the token cache.
  2087. </summary>
  2088. <example>
  2089. <para>
  2090. This is an example showing how TokenCachePersistenceOptions and an AuthenticationRecord can be used together to enable silent authentication
  2091. across executions of a client application.
  2092. </para>
  2093. <code snippet="Snippet:AuthenticationRecord_TokenCachePersistenceOptions" language="csharp">
  2094. const string TOKEN_CACHE_NAME = "MyTokenCache";
  2095. InteractiveBrowserCredential credential;
  2096. AuthenticationRecord authRecord;
  2097. // Check if an AuthenticationRecord exists on disk.
  2098. // If it does not exist, get one and serialize it to disk.
  2099. // If it does exist, load it from disk and deserialize it.
  2100. if (!File.Exists(AUTH_RECORD_PATH))
  2101. {
  2102. // Construct a credential with TokenCachePersistenceOptions specified to ensure that the token cache is persisted to disk.
  2103. // We can also optionally specify a name for the cache to avoid having it cleared by other applications.
  2104. credential = new InteractiveBrowserCredential(
  2105. new InteractiveBrowserCredentialOptions { TokenCachePersistenceOptions = new TokenCachePersistenceOptions { Name = TOKEN_CACHE_NAME } });
  2106. // Call AuthenticateAsync to fetch a new AuthenticationRecord.
  2107. authRecord = await credential.AuthenticateAsync();
  2108. // Serialize the AuthenticationRecord to disk so that it can be re-used across executions of this initialization code.
  2109. using var authRecordStream = new FileStream(AUTH_RECORD_PATH, FileMode.Create, FileAccess.Write);
  2110. await authRecord.SerializeAsync(authRecordStream);
  2111. }
  2112. else
  2113. {
  2114. // Load the previously serialized AuthenticationRecord from disk and deserialize it.
  2115. using var authRecordStream = new FileStream(AUTH_RECORD_PATH, FileMode.Open, FileAccess.Read);
  2116. authRecord = await AuthenticationRecord.DeserializeAsync(authRecordStream);
  2117. // Construct a new client with our TokenCachePersistenceOptions with the addition of the AuthenticationRecord property.
  2118. // This tells the credential to use the same token cache in addition to which account to try and fetch from cache when GetToken is called.
  2119. credential = new InteractiveBrowserCredential(
  2120. new InteractiveBrowserCredentialOptions
  2121. {
  2122. TokenCachePersistenceOptions = new TokenCachePersistenceOptions { Name = TOKEN_CACHE_NAME },
  2123. AuthenticationRecord = authRecord
  2124. });
  2125. }
  2126. // Construct our client with the credential which is connected to the token cache
  2127. // with the capability of silent authentication for the account specified in the AuthenticationRecord.
  2128. var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), credential);
  2129. </code>
  2130. </example>
  2131. </member>
  2132. <member name="P:Azure.Identity.TokenCachePersistenceOptions.Name">
  2133. <summary>
  2134. Name uniquely identifying the <see cref="T:Azure.Identity.TokenCachePersistenceOptions" />.
  2135. </summary>
  2136. </member>
  2137. <member name="P:Azure.Identity.TokenCachePersistenceOptions.UnsafeAllowUnencryptedStorage">
  2138. <summary>
  2139. If set to true the token cache may be persisted as an unencrypted file if no OS level user encryption is available. When set to false the token cache
  2140. will throw a <see cref="T:Azure.Identity.CredentialUnavailableException" /> in the event no OS level user encryption is available.
  2141. </summary>
  2142. </member>
  2143. <member name="T:Azure.Identity.TokenCacheRefreshArgs">
  2144. <summary>
  2145. Args setnt to TokenCache OnBefore and OnAfter events.
  2146. </summary>
  2147. </member>
  2148. <member name="P:Azure.Identity.TokenCacheRefreshArgs.SuggestedCacheKey">
  2149. <summary>
  2150. A suggested token cache key, which can be used with general purpose storage mechanisms that allow
  2151. storing key-value pairs and key based retrieval. Useful in applications that store 1 token cache per user,
  2152. the recommended pattern for web apps.
  2153. The value is:
  2154. <list type="bullet">
  2155. <item>the homeAccountId for AcquireTokenSilent, GetAccount(homeAccountId), RemoveAccount and when writing tokens on confidential client calls</item>
  2156. <item>clientID + "_AppTokenCache" for AcquireTokenForClient</item>
  2157. <item>clientID_tenantID + "_AppTokenCache" for AcquireTokenForClient when tenant specific authority</item>
  2158. <item>the hash of the original token for AcquireTokenOnBehalfOf</item>
  2159. </list>
  2160. </summary>
  2161. </member>
  2162. <member name="T:Azure.Identity.TokenCacheUpdatedArgs">
  2163. <summary>
  2164. Data regarding an update of a token cache.
  2165. </summary>
  2166. </member>
  2167. <member name="P:Azure.Identity.TokenCacheUpdatedArgs.UnsafeCacheData">
  2168. <summary>
  2169. The <see cref="T:Azure.Identity.TokenCachePersistenceOptions" /> instance which was updated.
  2170. </summary>
  2171. </member>
  2172. <member name="T:Azure.Identity.TokenCredentialDiagnosticsOptions">
  2173. <summary>
  2174. Exposes client options related to logging, telemetry, and distributed tracing.
  2175. </summary>
  2176. </member>
  2177. <member name="P:Azure.Identity.TokenCredentialDiagnosticsOptions.IsAccountIdentifierLoggingEnabled">
  2178. <summary>
  2179. If <c>true</c>, we try to log the account identifiers by parsing the received access token.
  2180. The account identifiers we try to log are:
  2181. <list type="bullet">
  2182. <item><description>The Application or Client Identifier</description></item>
  2183. <item><description>User Principal Name</description></item>
  2184. <item><description>Tenant Identifier</description></item>
  2185. <item><description>Object Identifier of the authenticated user or application</description></item>
  2186. </list>
  2187. </summary>
  2188. </member>
  2189. <member name="T:Azure.Identity.UnsafeTokenCacheOptions">
  2190. <summary>
  2191. Options controlling the storage of the token cache.
  2192. </summary>
  2193. </member>
  2194. <member name="M:Azure.Identity.UnsafeTokenCacheOptions.TokenCacheUpdatedAsync(Azure.Identity.TokenCacheUpdatedArgs)">
  2195. <summary>
  2196. The delegate to be called when the Updated event fires.
  2197. </summary>
  2198. </member>
  2199. <member name="M:Azure.Identity.UnsafeTokenCacheOptions.RefreshCacheAsync">
  2200. <summary>
  2201. Returns the bytes used to initialize the token cache. This would most likely have come from the <see cref="T:Azure.Identity.TokenCacheUpdatedArgs" />.
  2202. This implementation will get called by the default implementation of <see cref="M:Azure.Identity.UnsafeTokenCacheOptions.RefreshCacheAsync(Azure.Identity.TokenCacheRefreshArgs,System.Threading.CancellationToken)" />.
  2203. It is recommended to provide an implementation for <see cref="M:Azure.Identity.UnsafeTokenCacheOptions.RefreshCacheAsync(Azure.Identity.TokenCacheRefreshArgs,System.Threading.CancellationToken)" /> rather than this method.
  2204. </summary>
  2205. </member>
  2206. <member name="M:Azure.Identity.UnsafeTokenCacheOptions.RefreshCacheAsync(Azure.Identity.TokenCacheRefreshArgs,System.Threading.CancellationToken)">
  2207. <summary>
  2208. Returns the bytes used to initialize the token cache. This would most likely have come from the <see cref="T:Azure.Identity.TokenCacheUpdatedArgs" />.
  2209. It is recommended that if this method is overriden, there is no need to provide a duplicate implementation for the parameterless <see cref="M:Azure.Identity.UnsafeTokenCacheOptions.RefreshCacheAsync" />.
  2210. </summary>
  2211. <param name="args">The <see cref="T:Azure.Identity.TokenCacheRefreshArgs" /> containing information about the current state of the cache.</param>
  2212. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken" /> controlling the lifetime of this operation.</param>
  2213. </member>
  2214. <member name="M:Azure.Identity.Validations.ValidateTenantId(System.String,System.String,System.Boolean)">
  2215. <summary>
  2216. As tenant id is used in constructing authority endpoints and in command line invocation we validate the character set of the tenant id matches allowed characters.
  2217. </summary>
  2218. </member>
  2219. <member name="M:Azure.Identity.Validations.CanUseLegacyPowerShell(System.Boolean)">
  2220. <summary>
  2221. PowerShell Legacy can only be used on Windows OS systems.
  2222. </summary>
  2223. <param name="useLegacyPowerShell"></param>
  2224. <returns></returns>
  2225. </member>
  2226. <member name="T:Azure.Identity.X509Certificate2FromFileProvider">
  2227. <summary>
  2228. X509Certificate2FromFileProvider provides an X509Certificate2 from a file on disk. It supports both
  2229. "pfx" and "pem" encoded certificates.
  2230. </summary>
  2231. </member>
  2232. <member name="T:Azure.Identity.X509Certificate2FromObjectProvider">
  2233. <summary>
  2234. X509Certificate2FromObjectProvider provides an X509Certificate2 from an existing instance.
  2235. </summary>
  2236. </member>
  2237. <member name="T:Azure.Core.AppContextSwitchHelper">
  2238. <summary>
  2239. Helper for interacting with AppConfig settings and their related Environment variable settings.
  2240. </summary>
  2241. </member>
  2242. <member name="M:Azure.Core.AppContextSwitchHelper.GetConfigValue(System.String,System.String)">
  2243. <summary>
  2244. Determines if either an AppContext switch or its corresponding Environment Variable is set
  2245. </summary>
  2246. <param name="appContexSwitchName">Name of the AppContext switch.</param>
  2247. <param name="environmentVariableName">Name of the Environment variable.</param>
  2248. <returns>If the AppContext switch has been set, returns the value of the switch.
  2249. If the AppContext switch has not been set, returns the value of the environment variable.
  2250. False if neither is set.
  2251. </returns>
  2252. </member>
  2253. <member name="T:Azure.Core.Argument">
  2254. <summary>
  2255. Argument validation.
  2256. </summary>
  2257. <remarks>
  2258. <para>This class should be shared via source using Azure.Core.props and contain only common argument validation.
  2259. It is declared partial so that you can use the same familiar class name but extend it with project-specific validation.
  2260. To extend the functionality of this class, just declare your own partial <see cref="T:Azure.Core.Argument" /> class with project-specific methods.
  2261. </para>
  2262. <para>
  2263. Be sure to document exceptions thrown by these methods on your public methods.
  2264. </para>
  2265. </remarks>
  2266. </member>
  2267. <member name="M:Azure.Core.Argument.AssertNotNull``1(``0,System.String)">
  2268. <summary>
  2269. Throws if <paramref name="value" /> is null.
  2270. </summary>
  2271. <param name="value">The value to validate.</param>
  2272. <param name="name">The name of the parameter.</param>
  2273. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> is null.</exception>
  2274. </member>
  2275. <member name="M:Azure.Core.Argument.AssertNotNull``1(System.Nullable{``0},System.String)">
  2276. <summary>
  2277. Throws if <paramref name="value" /> has not been initialized.
  2278. </summary>
  2279. <param name="value">The value to validate.</param>
  2280. <param name="name">The name of the parameter.</param>
  2281. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> has not been initialized.</exception>
  2282. </member>
  2283. <member name="M:Azure.Core.Argument.AssertNotNullOrEmpty``1(System.Collections.Generic.IEnumerable{``0},System.String)">
  2284. <summary>
  2285. Throws if <paramref name="value" /> is null or an empty collection.
  2286. </summary>
  2287. <param name="value">The value to validate.</param>
  2288. <param name="name">The name of the parameter.</param>
  2289. <exception cref="T:System.ArgumentException"><paramref name="value" /> is an empty collection.</exception>
  2290. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> is null.</exception>
  2291. </member>
  2292. <member name="M:Azure.Core.Argument.AssertNotNullOrEmpty(System.String,System.String)">
  2293. <summary>
  2294. Throws if <paramref name="value" /> is null or an empty string.
  2295. </summary>
  2296. <param name="value">The value to validate.</param>
  2297. <param name="name">The name of the parameter.</param>
  2298. <exception cref="T:System.ArgumentException"><paramref name="value" /> is an empty string.</exception>
  2299. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> is null.</exception>
  2300. </member>
  2301. <member name="M:Azure.Core.Argument.AssertNotNullOrWhiteSpace(System.String,System.String)">
  2302. <summary>
  2303. Throws if <paramref name="value" /> is null, an empty string, or consists only of white-space characters.
  2304. </summary>
  2305. <param name="value">The value to validate.</param>
  2306. <param name="name">The name of the parameter.</param>
  2307. <exception cref="T:System.ArgumentException"><paramref name="value" /> is an empty string or consists only of white-space characters.</exception>
  2308. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> is null.</exception>
  2309. </member>
  2310. <member name="M:Azure.Core.Argument.AssertNotDefault``1(``0@,System.String)">
  2311. <summary>
  2312. Throws if <paramref name="value" /> is the default value for type <typeparamref name="T" />.
  2313. </summary>
  2314. <typeparam name="T">The type of structure to validate which implements <see cref="T:System.IEquatable`1" />.</typeparam>
  2315. <param name="value">The value to validate.</param>
  2316. <param name="name">The name of the parameter.</param>
  2317. <exception cref="T:System.ArgumentException"><paramref name="value" /> is the default value for type <typeparamref name="T" />.</exception>
  2318. </member>
  2319. <member name="M:Azure.Core.Argument.AssertInRange``1(``0,``0,``0,System.String)">
  2320. <summary>
  2321. Throws if <paramref name="value" /> is less than the <paramref name="minimum" /> or greater than the <paramref name="maximum" />.
  2322. </summary>
  2323. <typeparam name="T">The type of to validate which implements <see cref="T:System.IComparable`1" />.</typeparam>
  2324. <param name="value">The value to validate.</param>
  2325. <param name="minimum">The minimum value to compare.</param>
  2326. <param name="maximum">The maximum value to compare.</param>
  2327. <param name="name">The name of the parameter.</param>
  2328. </member>
  2329. <member name="M:Azure.Core.Argument.CheckNotNull``1(``0,System.String)">
  2330. <summary>
  2331. Throws if <paramref name="value" /> has not been initialized; otherwise, returns <paramref name="value" />.
  2332. </summary>
  2333. <param name="value">The value to validate.</param>
  2334. <param name="name">The name of the parameter.</param>
  2335. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> has not been initialized.</exception>
  2336. </member>
  2337. <member name="M:Azure.Core.Argument.CheckNotNullOrEmpty(System.String,System.String)">
  2338. <summary>
  2339. Throws if <paramref name="value" /> is null or an empty string; otherwise, returns <paramref name="value" />.
  2340. </summary>
  2341. <param name="value">The value to validate.</param>
  2342. <param name="name">The name of the parameter.</param>
  2343. <exception cref="T:System.ArgumentException"><paramref name="value" /> is an empty string.</exception>
  2344. <exception cref="T:System.ArgumentNullException"><paramref name="value" /> is null.</exception>
  2345. </member>
  2346. <member name="M:Azure.Core.Argument.AssertNull``1(``0,System.String,System.String)">
  2347. <summary>
  2348. Throws if <paramref name="value" /> is not null.
  2349. </summary>
  2350. <param name="value">The value to validate.</param>
  2351. <param name="name">The name of the parameter.</param>
  2352. <param name="message">The error message.</param>
  2353. <exception cref="T:System.ArgumentException"><paramref name="value" /> is not null.</exception>
  2354. </member>
  2355. <member name="T:Azure.Core.ArrayBufferWriter`1">
  2356. <summary>
  2357. Represents a heap-based, array-backed output sink into which <typeparam name="T" /> data can be written.
  2358. </summary>
  2359. </member>
  2360. <member name="M:Azure.Core.ArrayBufferWriter`1.#ctor">
  2361. <summary>
  2362. Creates an instance of an <see cref="T:Azure.Core.ArrayBufferWriter`1" />, in which data can be written to,
  2363. with the default initial capacity.
  2364. </summary>
  2365. </member>
  2366. <member name="M:Azure.Core.ArrayBufferWriter`1.#ctor(System.Int32)">
  2367. <summary>
  2368. Creates an instance of an <see cref="T:Azure.Core.ArrayBufferWriter`1" />, in which data can be written to,
  2369. with an initial capacity specified.
  2370. </summary>
  2371. <param name="initialCapacity">The minimum capacity with which to initialize the underlying buffer.</param>
  2372. <exception cref="T:System.ArgumentException">
  2373. Thrown when <paramref name="initialCapacity" /> is not positive (i.e. less than or equal to 0).
  2374. </exception>
  2375. </member>
  2376. <member name="P:Azure.Core.ArrayBufferWriter`1.WrittenMemory">
  2377. <summary>
  2378. Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlyMemory`1" />.
  2379. </summary>
  2380. </member>
  2381. <member name="P:Azure.Core.ArrayBufferWriter`1.WrittenSpan">
  2382. <summary>
  2383. Returns the data written to the underlying buffer so far, as a <see cref="T:System.ReadOnlySpan`1" />.
  2384. </summary>
  2385. </member>
  2386. <member name="P:Azure.Core.ArrayBufferWriter`1.WrittenCount">
  2387. <summary>
  2388. Returns the amount of data written to the underlying buffer so far.
  2389. </summary>
  2390. </member>
  2391. <member name="P:Azure.Core.ArrayBufferWriter`1.Capacity">
  2392. <summary>
  2393. Returns the total amount of space within the underlying buffer.
  2394. </summary>
  2395. </member>
  2396. <member name="P:Azure.Core.ArrayBufferWriter`1.FreeCapacity">
  2397. <summary>
  2398. Returns the amount of space available that can still be written into without forcing the underlying buffer to grow.
  2399. </summary>
  2400. </member>
  2401. <member name="M:Azure.Core.ArrayBufferWriter`1.Clear">
  2402. <summary>
  2403. Clears the data written to the underlying buffer.
  2404. </summary>
  2405. <remarks>
  2406. You must clear the <see cref="T:Azure.Core.ArrayBufferWriter`1" /> before trying to re-use it.
  2407. </remarks>
  2408. </member>
  2409. <member name="M:Azure.Core.ArrayBufferWriter`1.Advance(System.Int32)">
  2410. <summary>
  2411. Notifies <see cref="T:System.Buffers.IBufferWriter`1" /> that <paramref name="count" /> amount of data was written to the output <see cref="T:System.Span`1" />/<see cref="T:System.Memory`1" />.
  2412. </summary>
  2413. <exception cref="T:System.ArgumentException">
  2414. Thrown when <paramref name="count" /> is negative.
  2415. </exception>
  2416. <exception cref="T:System.InvalidOperationException">
  2417. Thrown when attempting to advance past the end of the underlying buffer.
  2418. </exception>
  2419. <remarks>
  2420. You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
  2421. </remarks>
  2422. </member>
  2423. <member name="M:Azure.Core.ArrayBufferWriter`1.GetMemory(System.Int32)">
  2424. <summary>
  2425. Returns a <see cref="T:System.Memory`1" /> to write to that is at least the requested length (specified by <paramref name="sizeHint" />).
  2426. If no <paramref name="sizeHint" /> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
  2427. </summary>
  2428. <exception cref="T:System.ArgumentException">
  2429. Thrown when <paramref name="sizeHint" /> is negative.
  2430. </exception>
  2431. <remarks>
  2432. This will never return an empty <see cref="T:System.Memory`1" />.
  2433. </remarks>
  2434. <remarks>
  2435. There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
  2436. </remarks>
  2437. <remarks>
  2438. You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
  2439. </remarks>
  2440. </member>
  2441. <member name="M:Azure.Core.ArrayBufferWriter`1.GetSpan(System.Int32)">
  2442. <summary>
  2443. Returns a <see cref="T:System.Span`1" /> to write to that is at least the requested length (specified by <paramref name="sizeHint" />).
  2444. If no <paramref name="sizeHint" /> is provided (or it's equal to <code>0</code>), some non-empty buffer is returned.
  2445. </summary>
  2446. <exception cref="T:System.ArgumentException">
  2447. Thrown when <paramref name="sizeHint" /> is negative.
  2448. </exception>
  2449. <remarks>
  2450. This will never return an empty <see cref="T:System.Span`1" />.
  2451. </remarks>
  2452. <remarks>
  2453. There is no guarantee that successive calls will return the same buffer or the same-sized buffer.
  2454. </remarks>
  2455. <remarks>
  2456. You must request a new buffer after calling Advance to continue writing more data and cannot write to a previously acquired buffer.
  2457. </remarks>
  2458. </member>
  2459. <member name="T:Azure.Core.AzureResourceProviderNamespaceAttribute">
  2460. <summary>
  2461. This attribute should be set on all client assemblies with value of one of the resource providers
  2462. from the https://docs.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers list.
  2463. </summary>
  2464. </member>
  2465. <member name="M:Azure.Core.Pipeline.ClientDiagnostics.ExtractFailureContent(System.String,Azure.Core.ResponseHeaders,System.Collections.Generic.IDictionary{System.String,System.String}@)">
  2466. <summary>
  2467. Partial method that can optionally be defined to extract the error
  2468. message, code, and details in a service specific manner.
  2469. </summary>
  2470. <param name="content">The error content.</param>
  2471. <param name="responseHeaders">The response headers.</param>
  2472. <param name="additionalInfo">Additional error details.</param>
  2473. </member>
  2474. <member name="T:Azure.Core.Pipeline.DiagnosticScope.ActivityKind">
  2475. <summary>
  2476. Kind describes the relationship between the Activity, its parents, and its children in a Trace.
  2477. </summary>
  2478. </member>
  2479. <member name="F:Azure.Core.Pipeline.DiagnosticScope.ActivityKind.Internal">
  2480. <summary>
  2481. Default value.
  2482. Indicates that the Activity represents an internal operation within an application, as opposed to an operations with remote parents or children.
  2483. </summary>
  2484. </member>
  2485. <member name="F:Azure.Core.Pipeline.DiagnosticScope.ActivityKind.Server">
  2486. <summary>
  2487. Server activity represents request incoming from external component.
  2488. </summary>
  2489. </member>
  2490. <member name="F:Azure.Core.Pipeline.DiagnosticScope.ActivityKind.Client">
  2491. <summary>
  2492. Client activity represents outgoing request to the external component.
  2493. </summary>
  2494. </member>
  2495. <member name="F:Azure.Core.Pipeline.DiagnosticScope.ActivityKind.Producer">
  2496. <summary>
  2497. Producer activity represents output provided to external components.
  2498. </summary>
  2499. </member>
  2500. <member name="F:Azure.Core.Pipeline.DiagnosticScope.ActivityKind.Consumer">
  2501. <summary>
  2502. Consumer activity represents output received from an external component.
  2503. </summary>
  2504. </member>
  2505. <member name="T:Azure.Core.Pipeline.ActivityExtensions">
  2506. <summary>
  2507. Until we can reference the 5.0 of System.Diagnostics.DiagnosticSource
  2508. </summary>
  2509. </member>
  2510. <member name="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1">
  2511. <summary>
  2512. Both <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1" /> and <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerator`1" /> are defined as public structs so that foreach can use duck typing
  2513. to call <see cref="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.GetEnumerator" /> and avoid heap memory allocation.
  2514. Please don't delete this method and don't make these types private.
  2515. </summary>
  2516. <typeparam name="T"></typeparam>
  2517. </member>
  2518. <member name="T:Azure.Core.HttpPipelineMessageHandler">
  2519. <summary>
  2520. An HttpMessageHandler which delegates SendAsync to a specified HttpPipeline.
  2521. </summary>
  2522. </member>
  2523. <member name="M:Azure.Core.Base64Url.Decode(System.String)">
  2524. <summary> Converts a Base64URL encoded string to a string.</summary>
  2525. <param name="encoded">The Base64Url encoded string containing UTF8 bytes for a string.</param>
  2526. <returns>The string represented by the Base64URL encoded string.</returns>
  2527. </member>
  2528. <member name="M:Azure.Core.Base64Url.Encode(System.Byte[])">
  2529. <summary>Encode a byte array as a Base64URL encoded string.</summary>
  2530. <param name="bytes">Raw byte input buffer.</param>
  2531. <returns>The bytes, encoded as a Base64URL string.</returns>
  2532. </member>
  2533. <member name="M:Azure.Core.Base64Url.DecodeString(System.String)">
  2534. <summary> Converts a Base64URL encoded string to a string.</summary>
  2535. <param name="encoded">The Base64Url encoded string containing UTF8 bytes for a string.</param>
  2536. <returns>The string represented by the Base64URL encoded string.</returns>
  2537. </member>
  2538. <member name="M:Azure.Core.Base64Url.EncodeString(System.String)">
  2539. <summary>Encode a string as a Base64URL encoded string.</summary>
  2540. <param name="value">String input buffer.</param>
  2541. <returns>The UTF8 bytes for the string, encoded as a Base64URL string.</returns>
  2542. </member>
  2543. <member name="T:Azure.Core.LightweightPkcs8Decoder">
  2544. <summary>
  2545. This is a very targeted PKCS#8 decoder for use when reading a PKCS# encoded RSA private key from an
  2546. DER encoded ASN.1 blob. In an ideal world, we would be able to call AsymmetricAlgorithm.ImportPkcs8PrivateKey
  2547. off an RSA object to import the private key from a byte array, which we got from the PEM file. There
  2548. are a few issues with this however:
  2549. 1. ImportPkcs8PrivateKey does not exist in the Desktop .NET Framework as of today.
  2550. 2. ImportPkcs8PrivateKey was added to .NET Core in 3.0, and we'd love to be able to support this
  2551. on older versions of .NET Core.
  2552. This code is able to decode RSA keys (without any attributes) from well formed PKCS#8 blobs.
  2553. </summary>
  2554. </member>
  2555. <member name="T:Azure.Core.PemReader">
  2556. <summary>
  2557. Reads PEM streams to parse PEM fields or load certificates.
  2558. </summary>
  2559. </member>
  2560. <member name="M:Azure.Core.PemReader.LoadCertificate(System.ReadOnlySpan{System.Char},System.Byte[],Azure.Core.PemReader.KeyType,System.Boolean,System.Security.Cryptography.X509Certificates.X509KeyStorageFlags)">
  2561. <summary>
  2562. Loads an <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> from PEM data.
  2563. </summary>
  2564. <param name="data">The PEM data to parse.</param>
  2565. <param name="cer">Optional public certificate data if not defined within the PEM data.</param>
  2566. <param name="keyType">
  2567. Optional <see cref="T:Azure.Core.PemReader.KeyType" /> of the certificate private key. The default is <see cref="F:Azure.Core.PemReader.KeyType.Auto" /> to automatically detect.
  2568. Only support for <see cref="F:Azure.Core.PemReader.KeyType.RSA" /> is implemented by shared code.
  2569. </param>
  2570. <param name="allowCertificateOnly">Whether to create an <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> if no private key is read.</param>
  2571. <param name="keyStorageFlags">A combination of the enumeration values that control where and how to import the certificate.</param>
  2572. <returns>An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> loaded from the PEM data.</returns>
  2573. <exception cref="T:System.Security.Cryptography.CryptographicException">A cryptographic exception occurred when trying to create the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" />.</exception>
  2574. <exception cref="T:System.IO.InvalidDataException"><paramref name="cer" /> is null and no CERTIFICATE field is defined in PEM, or no PRIVATE KEY is defined in PEM.</exception>
  2575. <exception cref="T:System.NotSupportedException">The <paramref name="keyType" /> is not supported.</exception>
  2576. <exception cref="T:System.PlatformNotSupportedException">Creating a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> from PEM data is not supported on the current platform.</exception>
  2577. </member>
  2578. <member name="M:Azure.Core.PemReader.TryRead(System.ReadOnlySpan{System.Char},Azure.Core.PemReader.PemField@)">
  2579. <summary>
  2580. Attempts to read the next PEM field from the given data.
  2581. </summary>
  2582. <param name="data">The PEM data to parse.</param>
  2583. <param name="field">The PEM first complete PEM field that was found.</param>
  2584. <returns>True if a valid PEM field was parsed; otherwise, false.</returns>
  2585. <remarks>
  2586. To find subsequent fields, pass a slice of <paramref name="data" /> past the found <see cref="P:Azure.Core.PemReader.PemField.Length" />.
  2587. </remarks>
  2588. </member>
  2589. <member name="T:Azure.Core.PemReader.KeyType">
  2590. <summary>
  2591. Key type of the certificate private key.
  2592. </summary>
  2593. </member>
  2594. <member name="F:Azure.Core.PemReader.KeyType.Unknown">
  2595. <summary>
  2596. The key type is unknown.
  2597. </summary>
  2598. </member>
  2599. <member name="F:Azure.Core.PemReader.KeyType.Auto">
  2600. <summary>
  2601. Attempt to detect the key type.
  2602. </summary>
  2603. </member>
  2604. <member name="F:Azure.Core.PemReader.KeyType.RSA">
  2605. <summary>
  2606. RSA key type.
  2607. </summary>
  2608. </member>
  2609. <member name="F:Azure.Core.PemReader.KeyType.ECDsa">
  2610. <summary>
  2611. ECDsa key type.
  2612. </summary>
  2613. </member>
  2614. <member name="T:Azure.Core.PemReader.PemField">
  2615. <summary>
  2616. A PEM field including its section header and encoded data.
  2617. </summary>
  2618. </member>
  2619. <member name="P:Azure.Core.PemReader.PemField.Start">
  2620. <summary>
  2621. The offset of the section from the start of the input PEM stream.
  2622. </summary>
  2623. </member>
  2624. <member name="P:Azure.Core.PemReader.PemField.Label">
  2625. <summary>
  2626. A span of the section label from within the PEM stream.
  2627. </summary>
  2628. </member>
  2629. <member name="P:Azure.Core.PemReader.PemField.Data">
  2630. <summary>
  2631. A span of the section data from within the PEM stream.
  2632. </summary>
  2633. </member>
  2634. <member name="P:Azure.Core.PemReader.PemField.Length">
  2635. <summary>
  2636. The length of the section from the <see cref="P:Azure.Core.PemReader.PemField.Start" />.
  2637. </summary>
  2638. </member>
  2639. <member name="M:Azure.Core.PemReader.PemField.FromBase64Data">
  2640. <summary>
  2641. Decodes the base64-encoded <see cref="P:Azure.Core.PemReader.PemField.Data" />
  2642. </summary>
  2643. <returns></returns>
  2644. </member>
  2645. <member name="P:Azure.Identity.AuthenticationAccount.Microsoft#Identity#Client#IAccount#Username">
  2646. <summary>
  2647. Gets a string containing the displayable value in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c>.
  2648. This can be null.
  2649. </summary><remarks>This property replaces the <c>DisplayableId</c> property of <c>IUser</c> in previous versions of MSAL.NET</remarks>
  2650. </member>
  2651. <member name="P:Azure.Identity.AuthenticationAccount.Microsoft#Identity#Client#IAccount#Environment">
  2652. <summary>
  2653. Gets a string containing the identity provider for this account, e.g. <c>login.microsoftonline.com</c>.
  2654. </summary><remarks>This property replaces the <c>IdentityProvider</c> property of <c>IUser</c> in previous versions of MSAL.NET
  2655. except that IdentityProvider was a URL with information about the tenant (in addition to the cloud environment), whereas Environment is only the <see cref="P:System.Uri.Host" /></remarks>
  2656. </member>
  2657. <member name="P:Azure.Identity.AuthenticationAccount.Microsoft#Identity#Client#IAccount#HomeAccountId">
  2658. <summary>
  2659. AccountId of the home account for the user. This uniquely identifies the user across AAD tenants.
  2660. </summary><remarks>Can be null, for example if this account was migrated to MSAL.NET from ADAL.NET v3's token cache</remarks>
  2661. </member>
  2662. <member name="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
  2663. <summary>Returns an enumerator that iterates through the collection.</summary><returns>An enumerator that can be used to iterate through the collection.</returns>
  2664. </member>
  2665. <member name="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.System#Collections#IEnumerable#GetEnumerator">
  2666. <summary>Returns an enumerator that iterates through a collection.</summary><returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
  2667. </member>
  2668. <member name="P:Azure.Core.Pipeline.TaskExtensions.Enumerator`1.System#Collections#IEnumerator#Current">
  2669. <summary>Gets the element in the collection at the current position of the enumerator.</summary><returns>The element in the collection at the current position of the enumerator.</returns>
  2670. </member>
  2671. </members>
  2672. </doc>