ServiceClient<T> Class

 

Represents the base ServiceClient class.

Namespace:   Microsoft.WindowsAzure.Common
Assembly:  Microsoft.WindowsAzure.Common (in Microsoft.WindowsAzure.Common.dll)

Inheritance Hierarchy

System.Object
  Microsoft.WindowsAzure.Common.ServiceClient<T>
    Microsoft.WindowsAzure.Management.WebSites.WebSiteManagementClient
    Microsoft.WindowsAzure.WebSitesExtensions.WebSiteExtensionsClient

Syntax

public abstract class ServiceClient<T> : IDisposable
where T : ServiceClient<T>
generic<typename T>
where T : ServiceClient<T>
public ref class ServiceClient abstract : IDisposable
[<AbstractClass>]
type ServiceClient<'T when 'T : ServiceClient<'T>> = 
    class
        interface IDisposable
    end
Public MustInherit Class ServiceClient(Of T As ServiceClient(Of T))
    Implements IDisposable

Type Parameters

  • T
    The type of ServiceClient.

Constructors

Name Description
System_CAPS_pubmethod ServiceClient<T>()

Initializes a new instance of the ServiceClient<T> class.

System_CAPS_pubmethod ServiceClient<T>(HttpClient)

Initializes a new instance of the ServiceClient class.

Properties

Name Description
System_CAPS_pubproperty HttpClient

Gets the HttpClient that is used for making HTTP requests.

System_CAPS_protproperty HttpMessageHandler

Gets a reference to an HTTP handler.

System_CAPS_pubproperty UserAgent

Gets the UserAgent collection. This collection can be modified with custom user agent strings.

Methods

Name Description
System_CAPS_protmethod Clone(ServiceClient<T>)

Clones the service client.

System_CAPS_pubmethod Dispose()

Releases the resources that are used by the current instance of the ServiceClient<T> class.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod InitializeHttpClient(HttpMessageHandler)

Initializes HttpClient.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

System_CAPS_pubmethod WithHandler(DelegatingHandler)

System_CAPS_protmethod WithHandler(ServiceClient<T>, DelegatingHandler)

Extends the ServiceClient with a new handler.

System_CAPS_pubmethod WithHandlers(IEnumerable<DelegatingHandler>)

Extension Methods

Name Description
System_CAPS_pubmethod AddHandlerToPipeline<T>(DelegatingHandler)

Adds a handler to the end of the HTTP pipeline of the client.(Defined by CloudExtensions.)

System_CAPS_pubmethod GetAssemblyVersion<T>()

Gets the assembly version of a service client.(Defined by CloudExtensions.)

System_CAPS_pubmethod GetHttpPipeline<T>()

Overloaded. Gets the HTTP pipeline for the specified service client.(Defined by CloudExtensions.)

System_CAPS_pubmethod SetRetryPolicy<T>(RetryPolicy)

Sets retry policy for the client.(Defined by CloudExtensions.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.WindowsAzure.Common Namespace

Return to top