AuthAzureAD C# Reference Documentation

AuthAzureAD

Current Version: 9.5.0.75

Provides functionality for obtaining an Azure AD access token via OAuth2 for Service to Service Calls Using Client Credentials. (See https://msdn.microsoft.com/en-us/library/dn645543.aspx)

Object Creation

Chilkat.AuthAzureAD obj = new Chilkat.AuthAzureAD();

Properties

AccessToken
public string AccessToken {get; set; }
Introduced in version 9.5.0.58

The access token to be used in Azure AD REST API requests. This property is set on a successful call to ObtainAccessToken.

top
ClientId
public string ClientId {get; set; }
Introduced in version 9.5.0.58

Specifies the Azure AD client id of the calling web service. To find the calling application's client ID, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
ClientSecret
public string ClientSecret {get; set; }
Introduced in version 9.5.0.58

A key registered for the calling web service in Azure AD. To create a key, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
DebugLogFilePath
public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
public bool LastMethodSuccess {get; set; }
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumSecondsRemaining
public int NumSecondsRemaining {get; }
Introduced in version 9.5.0.58

If the access token is valid, contains the number of seconds remaining until it expires. A value of 0 indicates an invalid or expired access token.

top
Resource
public string Resource {get; set; }
Introduced in version 9.5.0.58

The App ID URI of the receiving web service. To find the App ID URI, in the Azure Management Portal, click Active Directory, click the directory, click the application, and then click Configure.

top
TenantId
public string TenantId {get; set; }
Introduced in version 9.5.0.58

true if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

top
Valid
public bool Valid {get; }
Introduced in version 9.5.0.58

true if the AccessToken property contains a valid non-expired access token obtained via the call to ObtainAccessToken.

top
VerboseLogging
public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
public string Version {get; }

Version of the component/library, such as "9.5.0.63"

top

Methods

ObtainAccessToken
public bool ObtainAccessToken(Socket connection);
Introduced in version 9.5.0.58

Sends the HTTP request to fetch the access token. When this method completes successfully, the access token is available in the AccessToken property. The connection is an existing connection to login.microsoftonline.com.

Returns true for success, false for failure.

top
ObtainAccessTokenAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task ObtainAccessTokenAsync(Socket connection);
Introduced in version 9.5.0.58

Creates an asynchronous task to call the ObtainAccessToken method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

top
SaveLastError
public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top

Events

AbortCheck
public event AbortCheckEventHandler OnAbortCheck;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void authazuread_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
authazuread.OnAbortCheck += authazuread_OnAbortCheck;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void AbortCheckEventHandler OnAbortCheck
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
// ...
Chilkat.AuthAzureAD.AbortCheck abortCheck = new Chilkat.AuthAzureAD.AbortCheck(handleAbortCheck);
authazuread.setAbortCheckCb(abortCheck);
top
PercentDone
public event PercentDoneEventHandler OnPercentDone;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void authazuread_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
authazuread.OnPercentDone += authazuread_OnPercentDone;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void PercentDoneEventHandler OnPercentDone
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
// ...
Chilkat.AuthAzureAD.PercentDone percentDone = new Chilkat.AuthAzureAD.PercentDone(handlePercentDone);
authazuread.setPercentDoneCb(percentDone);
top
ProgressInfo
public event ProgressInfoEventHandler OnProgressInfo;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void authazuread_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
authazuread.OnProgressInfo += authazuread_OnProgressInfo;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ProgressInfoEventHandler OnProgressInfo
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
// ...
Chilkat.AuthAzureAD.ProgressInfo progressInfo = new Chilkat.AuthAzureAD.ProgressInfo(handleProgressInfo);
authazuread.setProgressInfoCb(progressInfo);
top
TaskCompleted
public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

More Information and Examples

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void authazuread_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
authazuread.OnTaskCompleted += authazuread_OnTaskCompleted;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void TaskCompletedEventHandler OnTaskCompleted
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.AuthAzureAD authazuread = new Chilkat.AuthAzureAD();
// ...
Chilkat.AuthAzureAD.TaskIdCompleted taskIdCompleted = new Chilkat.AuthAzureAD.TaskIdCompleted(handleTaskIdCompleted);
authazuread.setTaskIdCompletedCb(taskIdCompleted);
top