Microsoft.Open.Azure.AD.CommonLibrary.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Open.Azure.AD.CommonLibrary</name> </assembly> <members> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AuthenticationFactory"> <summary> Authentication factory class picks proper token provider to obtain authentication token </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AuthenticationFactory.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AuthenticationFactory" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AuthenticationFactory.Authenticate(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,System.String,System.Security.SecureString,Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint)"> <summary> Authentication process that get ADAL configuration and pick token acquisition methods </summary> <param name="account">User account information</param> <param name="environment">Current azure environment</param> <param name="tenantId">Tenant id</param> <param name="password">User crednetial</param> <param name="promptBehavior">Prompt behavior</param> <param name="tokenCache">Token cache</param> <param name="resourceId">Resource id</param> <returns></returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AuthenticationFactory.GetAdalConfiguration(Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache)"> <summary> Build ADAL configuration. </summary> <param name="environment">Azure environment</param> <param name="tenantId">tenant id</param> <param name="resourceId">Resource id</param> <param name="tokenCache">In memory token cache</param> <returns></returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation"> <summary> Caller information class for tracing </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation.memberName"> <summary> Caller's member name </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation.filePath"> <summary> Caller's file path </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation.lineNumber"> <summary> Caller's line number </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation.#ctor(System.String,System.String,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation" /> class. </summary> <param name="memberName">Caller's member name</param> <param name="sourceFilePath">Caller's file path</param> <param name="sourceLineNumber">Caller's source line number</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation.ToString"> <summary> Override method to convert CallerInformation to string </summary> <returns>Returns a string of Caller's information</returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.LogLevel"> <summary> Enumeration for log levels </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LogLevel.Info"> <summary> Log level. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LogLevel.Warning"> <summary> Log level. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LogLevel.Error"> <summary> Log level. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LogLevel.None"> <summary> Initial value. Not used. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.Logger"> <summary> Logging class implementation. You must call Uninitialize before exiting your application to release resources properly. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.Delimiter"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.LogFilePrefix"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.InitializeLock"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.isInitialized"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.logStream"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.currentLogLevel"> <summary> Static variable. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.Logger.logPath"> <summary> Static variable. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.LogDirectory(System.String)"> <summary> Gets the directory where all log files should go </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.Initialize(Microsoft.Open.Azure.AD.CommonLibrary.LogLevel,System.String,System.Int32)"> <summary> Initialize the Logger Check if the log file has to be created </summary> <param name="logLevel">Log level to use as the "current log level".</param> <param name="filePath">File Path for the log.</param> <param name="historyLength">History length - how many log files to keep around.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteError(Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation,System.String,System.Object[])"> <summary> Logs an C# client error message. </summary> <param name="callerInfo">A new instance of CallerInformation class</param> <param name="message">Message you want to log.</param> <param name="args">Message args.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteError(System.Exception,System.String,System.String)"> <summary> Logs an PowerShell client error/ exception message. Recursively logs inner exceptions. </summary> <param name="exception">Exception to log.</param> <param name="moduleName">Module name.</param> <param name="methodName">Method name.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteWarning(System.String,System.String)"> <summary> Write a PowerShell client log message </summary> <param name="methodName">Module name.</param> <param name="message">Log message.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteInfo(Microsoft.Open.Azure.AD.CommonLibrary.CallerInformation,System.String,System.Object[])"> <summary> Logs an C# client information message. </summary> <param name="callerInfo">A new instance of CallerInformation class</param> <param name="message">Message you want to log.</param> <param name="args">Message args.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteInfo(System.String,System.String,System.String,System.Object[])"> <summary> PowerShell client Logs an information message. </summary> <param name="cmdletName"> Commandlet name.</param> <param name="methodName">Method name.</param> <param name="message">Message you want to log.</param> <param name="args">Message args.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteInfo(System.String,System.String,System.Object[])"> <summary> PowerShell client Logs an information message. </summary> <param name="methodName">Method name.</param> <param name="message">Message you want to log.</param> <param name="args">Message args.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.Write(System.Exception,System.String)"> <summary> Logs an exception message. Recursively logs inner exceptions. </summary> <param name="exception">Exception to log.</param> <param name="moduleName">Module name.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.WriteMessage(Microsoft.Open.Azure.AD.CommonLibrary.LogLevel,System.String,System.String,System.Object[])"> <summary> Parameterized log </summary> <param name="level">Log level.</param> <param name="caller">Module name.</param> <param name="message">Log message.</param> <param name="args">Message args.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.ContinueInitialization(Microsoft.Open.Azure.AD.CommonLibrary.LogLevel,System.Int32,System.String)"> <summary> Initialize the Logger Check if the log file has to be created </summary> <param name="logLevel">Log level to use as the "current log level".</param> <param name="historyLength">History length - how many log files to keep around.</param> <param name="filePath">File Path for the Log.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Logger.CleanupOldLogFiles(System.Int32,System.String)"> <summary> Cleanup log files (retaining the latest 'historyLength' of files </summary> <param name="historyLength">History length.</param> <param name="filePath">File Path for log.</param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.ConnectAzureAD"> <summary> Cmdlet to log into an environment and download the subscriptions </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.LoginType"> <summary> User log in type </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LoginType.OrgId"> <summary> User is logging in with orgid credentials </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LoginType.LiveId"> <summary> User is logging in with liveid credentials </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.LoginType.ManagedService"> <summary> User is logging in with Managed Service Identity credentials </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.NonListNavigationalProperties"> <summary> Response of get property of the folloing is not a list </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.NonListNavigationalProperties.Manager"> <summary> Direcotry object manager </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog"> <summary> Prompt behavior </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog.Auto"> <summary> Depends on need </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog.Always"> <summary> ALways </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog.Never"> <summary> Never </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog.RefreshSession"> <summary> RefreshSession </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException"> <summary> Base class representing an exception that occurs when authenticating against Azure Active Directory </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationException" /> class. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadNeedAuthenticationException"> <summary> Exception that gets thrown when the user has not authenticated before issuing requests/ using AAD cmdlets </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadNeedAuthenticationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadNeedAuthenticationException" /> class. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadResourceNotAvailableAuthenticationException"> <summary> Exception that gets thrown when the user has not authenticated before issuing requests/ using AAD cmdlets </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadResourceNotAvailableAuthenticationException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadNeedAuthenticationException" /> class. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCanceledException"> <summary> Exception that gets thrown when the user explicitly cancels an authentication operation. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCanceledException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCanceledException" /> class. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedWithoutPopupException"> <summary> Exception that gets thrown when the ADAL library is unable to authenticate without a popup dialog. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedWithoutPopupException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedWithoutPopupException" /> class. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedException"> <summary> Exception that gets thrown if an authentication operation fails on the server. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationFailedException" /> class. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException"> <summary> Exception thrown if a refresh token has expired. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AadAuthenticationCantRenewException" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.DictionaryExtensions.ForEach``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> <summary> Perform an action on each element of a sequence. </summary> <typeparam name="T">Type of elements in the sequence.</typeparam> <param name="sequence">The sequence.</param> <param name="action">The action to perform.</param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration"> <summary> Class storing the configuration information needed for ADAL to request token from the right AD tenant depending on environment. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration" /> class. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount"> <summary> Azure account class that records user input </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType"> <summary> User log-in type </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType.ServicePrincipal"> <summary> Log in using service principal certificate </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType.User"> <summary> Log in using user secret </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType.AccessToken"> <summary> Log in using access token </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType.ManagedService"> <summary> Log in using Managed Service Identity Auth </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property"> <summary> User input categories </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.Tenants"> <summary> Comma separated list of tenants on this account. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.AadAccessToken"> <summary> AAD Graph Access token. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.MsAccessToken"> <summary> AAD Graph Access token. </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.CertificateThumbprint"> <summary> Thumbprint for associated certificate </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.MSILoginSecret"> <summary> Secret that may be used with MSI login </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.MSILoginUri"> <summary> Uri for Managed Service Identity Login </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.Property.MSILoginUriBackup"> <summary> Backup uri for Managed Service Identity Login </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount" /> class. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext"> <summary> Represents current Azure session context. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.#ctor(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext" /> class. </summary> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.#ctor(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,Microsoft.Open.Azure.AD.CommonLibrary.AzureTenant)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext" /> class. </summary> <param name="account">The azure account object</param> <param name="environment">The azure environment object</param> <param name="tenant">The azure tenant object</param> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.Account"> <summary> Gets the azure account. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.Environment"> <summary> Gets the azure environment. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.Tenant"> <summary> Gets the azure tenant. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureContext.TokenCache"> <summary> Gets or sets the token cache contents. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment"> <summary> Azure environment class property fields </summary> <summary> AzureEnvironment class methods fields </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment" /> class. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.PublicEnvironments"> <summary> Gets Microsoft Azure environments </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint"> <summary> Endpoint keys for look up </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint.ActiveDirectory"> <summary> Authority root </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint.ActiveDirectoryServiceEndpointResourceId"> <summary> AAD core </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint.MsGraphEndpointResourceId"> <summary> AAD Graph </summary> </member> <member name="F:Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint.AadGraphEndpointResourceId"> <summary> MS Graph </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile"> <summary> Represents Azure Resource Manager profile structure with default context, environments and token cache. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile" /> class. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile.Environments"> <summary> Gets or sets Azure environments. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile.Context"> <summary> Gets or sets the default azure context object. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile.ProfilePath"> <summary> Gets the path of the profile file. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile.ToString"> <summary> Serializes the current profile and return its contents. </summary> <returns>The current string.</returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureRmProfileProvider"> <summary> AzureRmProfileProvider class that maintains a single profile. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureRmProfileProvider.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile" /> class. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession"> <summary> Represents current Azure session. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.AuthenticationFactory"> <summary> Gets or sets Azure authentication factory. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.DataStore"> <summary> Gets or sets data persistence store. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.TokenCache"> <summary> Gets or sets the token cache store. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.TokenCacheFile"> <summary> Gets or sets token cache file path. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.ProfileDirectory"> <summary> Gets or sets profile directory. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.ProfileFile"> <summary> Gets or sets profile file name. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.OldProfileFileBackup"> <summary> Gets or sets file name for the migration backup. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.OldProfileFile"> <summary> Gets or sets old profile file name. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.AccessTokens"> <summary> Gets or sets access token for resource(s) </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.AzureEnvironment"> <summary> Get or sets azure environment for the user, such as PROD, China, Germany, etc </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.CorrelationId"> <summary> Gets or sets the Correlation Id for the operation </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.GetCorrelationRequestHeader"> <summary> Returns the correlation header string based on the current correlation id Guid </summary> <returns>The correlation client request id header value as a string</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.ResetCorrelationRequestHeader"> <summary> Resets the correlation id stored in UserSessionState </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.ClientAuthenticated"> <summary> Checked the log-in state of user </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AzureSession.GetAccessToken(Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint)"> <summary> Returns the access token for user. </summary> <param name="endPoint">Resource endpoint key</param> <returns>Access token that match login type</returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AzureTenant"> <summary> Represents an AD tenant. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureTenant.Id"> <summary> Gets or sets the tenant id. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.AzureTenant.Domain"> <summary> Gets or sets the tenant domain. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.op_Implicit(Microsoft.Open.Azure.AD.CommonLibrary.AzureContext)~Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext"> <summary> Convert between implementations of the current connection context for Azure. </summary> <param name="context">The connection context to convert.</param> <returns>The converted context.</returns> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.Account"> <summary> Gets the azure account. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.Environment"> <summary> Gets the azure environment. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.Tenant"> <summary> Gets the azure tenant. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.TenantId"> <summary> Gets the azure tenant. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.PSAzureContext.TenantDomain"> <summary> Gets the azure tenant. </summary> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.RMProfileClient"> <summary> RM profile client class </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.RMProfileClient.#ctor(Microsoft.Open.Azure.AD.CommonLibrary.AzureRMProfile)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.RMProfileClient" /> class. </summary> <param name="profile">RM profile</param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider"> <summary> A token provider that uses ADAL to retrieve tokens from Azure Active Directory </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider.#ctor"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider" /> class. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider.GetAccessToken(Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog,System.String,System.Security.SecureString,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get access token based on crendential type </summary> <param name="config">ADAL configuration</param> <param name="promptBehavior">Prompt behavior</param> <param name="userId">User Id</param> <param name="password">User secret</param> <param name="credentialType">Credential type</param> <returns></returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider.GetManagedServiceToken(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get Managed Service Token </summary> <param name="account">AccountId</param> <param name="environment">Azure Environment</param> <param name="tenantId">TenantId</param> <param name="resourceId">Resource or EndpointId</param> <param name="credentialType">The account type</param> <returns>A Managed Service Token from the VM Identity endpoint</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.AdalTokenProvider.GetAccessTokenWithCertificate(Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,System.String,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get access token based on certificate </summary> <param name="config">ADAL configuration</param> <param name="clientId">Application Id</param> <param name="certificate">Certificate thumbprint</param> <param name="credentialType">Credential type</param> <returns></returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.ITokenProvider"> <summary> This interface represents objects that can be used to obtain and manage access tokens. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ITokenProvider.GetAccessToken(Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,Microsoft.Open.Azure.AD.CommonLibrary.ShowDialog,System.String,System.Security.SecureString,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get a new login token for the given environment, user credential, and credential type. </summary> <param name="config">Configuration.</param> <param name="promptBehavior">Prompt behavior.</param> <param name="userId">User ID/Service principal to get the token for.</param> <param name="password">Secure strings with password/service principal key.</param> <param name="credentialType">Credential type.</param> <returns>An access token.</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ITokenProvider.GetAccessTokenWithCertificate(Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,System.String,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get a new authentication token for the given environment </summary> <param name="config">The ADAL Configuration</param> <param name="principalId">The id for the given principal</param> <param name="certificateThumbprint">The certificate thumbprint for this user</param> <param name="credentialType">The account type</param> <returns>An access token, which can be renewed</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ITokenProvider.GetManagedServiceToken(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get Managed Service Token </summary> <param name="account">AccountId</param> <param name="environment">Azure Environment</param> <param name="tenantId">TenantId</param> <param name="resourceId">Resource or EndpointId</param> <param name="credentialType">The account type</param> <returns>A Managed Service Token from the VM Identity endpoint</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ManagedServiceTokenProvider.GetManagedServiceToken(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment,System.String,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint,Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount.AccountType)"> <summary> Get MSI Service Token </summary> <param name="account">Azure account</param> <param name="environment">Azure environment</param> <param name="tenantId">tenant id</param> <param name="resourceId">Resource id</param> <returns></returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ManagedServiceTokenProvider.GetResourceId(Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment.Endpoint,Microsoft.Open.Azure.AD.CommonLibrary.AzureEnvironment)"> <summary> Get Resource Id </summary> <param name="resourceIdorEndpointName">ResourceId or endpoint name</param> <param name="environment">Azure environment</param> <returns></returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.ManagedServiceTokenProvider.ManagedServiceTokenInfo"> <summary> Wire representation of MSI token </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.ServicePrincipalTokenProvider.ServicePrincipalAccessToken.#ctor(Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult,System.Func{Microsoft.Open.Azure.AD.CommonLibrary.AdalConfiguration,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult},System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.ServicePrincipalTokenProvider.ServicePrincipalAccessToken" /> class. </summary> <param name="configuration">ADAL configuration</param> <param name="authResult">Authentication result</param> <param name="tokenRenewer">Token renew methods</param> <param name="appId">Application id of client</param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken"> <summary> Provides access token information for a bearer token </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.AccessToken"> <summary> The access token to be applied to a request message </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.#ctor(Microsoft.Open.Azure.AD.CommonLibrary.AzureAccount,System.String,System.String,System.String)"> <summary> Initializes a new instance of the <see cref="T:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken" /> class. Create a new access token from the given account and tenant id </summary> <param name="account">The account, containing user id, access token information</param> <param name="tenantId">The tenant id for the given access token</param> <param name="token">The token value for access token</param> <param name="tokenType">The token type for the given token.</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.AuthorizeRequest(System.Action{System.String,System.String})"> <summary> Authorize a request using an authorization setter function. </summary> <param name="authTokenSetter">The authorization token setter function.</param> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.LoginType"> <summary> The login type for this token </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.TenantId"> <summary> The tenant Id for this token. </summary> </member> <member name="P:Microsoft.Open.Azure.AD.CommonLibrary.SimpleAccessToken.UserId"> <summary> The User Id associated with this token. </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Utilities.CmdletExtensions.IsBound(System.Management.Automation.PSCmdlet,System.String)"> <summary> Return the value of a paramater, or null if not set </summary> <typeparam name="T"></typeparam> <param name="cmdlet">the executing cmdlet</param> <param name="parameterName">The name of the parameter to return</param> <returns>true if the parameter was provided by the user, otherwise false</returns> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.Utilities.IHttpRetryAlgorithm"> <summary> Retry algorithm for Http messages </summary> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Utilities.IHttpRetryAlgorithm.ShouldRetry(System.Net.Http.HttpResponseMessage)"> <summary> Determine if a request should be retried </summary> <param name="message">The response to the request</param> <returns>True if the request should be retried</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.Utilities.IHttpRetryAlgorithm.WaitForRetry"> <summary> Wait for the appropriate retry interval </summary> <returns>A Task that dealys for the appropriate interval</returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.HttpClientOperationsFactory.HttpClientOperations`1.InvalidateCache(System.String)"> <summary> Invalidate a cache value due to an event (for example, the cache value was aritten) </summary> <param name="requestUri">The uri of the entity to cache</param> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.HttpClientOperationsFactory.HttpClientOperations`1.TryGetFromCache(System.String,`0@)"> <summary> Get The value from the cache </summary> <param name="requestUri"></param> <param name="value"></param> <returns></returns> </member> <member name="M:Microsoft.Open.Azure.AD.CommonLibrary.HttpClientOperationsFactory.HttpClientOperations`1.SaveInCache(System.String,`0)"> <summary> Save the given request payload in the cache </summary> <param name="requestUri">The request uri to save</param> <param name="value">The payload value to save</param> </member> <member name="T:Microsoft.Open.Azure.AD.CommonLibrary.IHttpOperationsFactory"> <summary> Abstract interface for acquiring Http Operations </summary> </member> </members> </doc> |