WebSiteManagementClient Class

Article
08/13/2015

Represents a Websites service management client.

Namespace: Microsoft.WindowsAzure.Management.WebSites
Assembly: Microsoft.WindowsAzure.Management.WebSites (in Microsoft.WindowsAzure.Management.WebSites.dll)

Inheritance Hierarchy

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

Syntax

public class WebSiteManagementClient : ServiceClient<WebSiteManagementClient>, 
    IWebSiteManagementClient, IDisposable

public ref class WebSiteManagementClient : ServiceClient<WebSiteManagementClient^>, 
    IWebSiteManagementClient, IDisposable

type WebSiteManagementClient = 
    class
        inherit ServiceClient<WebSiteManagementClient>
        interface IWebSiteManagementClient
        interface IDisposable
    end

Public Class WebSiteManagementClient
    Inherits ServiceClient(Of WebSiteManagementClient)
    Implements IWebSiteManagementClient, IDisposable

Constructors

	Name	Description
	WebSiteManagementClient(SubscriptionCloudCredentials)	Initializes a new instance of the WebSiteManagementClient class.
	WebSiteManagementClient(SubscriptionCloudCredentials, HttpClient)	Initializes a new instance of the WebSiteManagementClient class.
	WebSiteManagementClient(SubscriptionCloudCredentials, Uri)	Initializes a new instance of the WebSiteManagementClient class.
	WebSiteManagementClient(SubscriptionCloudCredentials, Uri, HttpClient)	Initializes a new instance of the WebSiteManagementClient class.

Properties

	Name	Description
	ApiVersion	Gets the API version.
	BaseUri	Gets the URI that is used as the base for all Service Management requests.
	Credentials	Gets an SubscriptionCloudCredentials object that specifies the subscription credentials.
	HttpClient	Gets the HttpClient that is used for making HTTP requests.(Inherited from ServiceClient<T>.)
	HttpMessageHandler	Gets a reference to an HTTP handler.(Inherited from ServiceClient<T>.)
	LongRunningOperationInitialTimeout	Gets or sets the initial timeout for Long Running Operations.
	LongRunningOperationRetryTimeout	Gets or sets the retry timeout for Long Running Operations.
	UserAgent	Gets the UserAgent collection. This collection can be modified with custom user agent strings.(Inherited from ServiceClient<T>.)
	WebHostingPlans	Operations for managing web hosting plans beneath your subscription.
	WebSites	Gets an IWebSiteOperations object that specifies the operations for managing the websites in a web space.
	WebSpaces	Gets an IWebSpaceOperations object that specifies the operations for managing web spaces in a subscription.

Methods

	Name	Description
	Clone(ServiceClient<WebSiteManagementClient>)	Creates a deep copy of the WebSiteManagementClient object.(Overrides ServiceClient<T>.Clone(ServiceClient<T>).)
	Create(IDictionary<String, Object>)	Creates a Websites service management client.
	Dispose()	Releases the resources that are used by the current instance of the ServiceClient<T> class.(Inherited from ServiceClient<T>.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetOperationStatusAsync(String, String, String, CancellationToken)	The Get Operation Status operation returns the status of the specified operation. After calling a long-running operation, you can call Get Operation Status to determine whether the operation has succeeded, failed, timed out, or is still in progress. (see https://msdn.microsoft.com/en-us/library/windowsazure/ee460783.aspx for more information)
	GetType()	(Inherited from Object.)
	InitializeHttpClient(HttpMessageHandler)	Initializes HttpClient.(Inherited from ServiceClient<T>.)
	MemberwiseClone()	(Inherited from Object.)
	RegisterSubscriptionAsync(CancellationToken)	Asynchronously registers a subscription to use Microsoft Azure Websites.
	ToString()	(Inherited from Object.)
	UnregisterSubscriptionAsync(CancellationToken)	Asynchronously unregisters a subscription to use Microsoft Azure Websites.
	WithHandler(DelegatingHandler)	Creates a Websites service management client with a specified handler.(Overrides ServiceClient<T>.WithHandler(DelegatingHandler).)
	WithHandler(ServiceClient<T>, DelegatingHandler)	Extends the ServiceClient with a new handler.(Inherited from ServiceClient<T>.)
	WithHandlers(IEnumerable<DelegatingHandler>)	(Inherited from ServiceClient<T>.)

Extension Methods

	Name	Description
	GetOperationStatus(String, String, String)	The Get Operation Status operation returns the status of the specified operation. After calling a long-running operation, you can call Get Operation Status to determine whether the operation has succeeded, failed, timed out, or is still in progress. (see https://msdn.microsoft.com/en-us/library/windowsazure/ee460783.aspx for more information)(Defined by WebSiteManagementClientExtensions.)
	GetOperationStatusAsync(String, String, String)	The Get Operation Status operation returns the status of the specified operation. After calling a long-running operation, you can call Get Operation Status to determine whether the operation has succeeded, failed, timed out, or is still in progress. (see https://msdn.microsoft.com/en-us/library/windowsazure/ee460783.aspx for more information)(Defined by WebSiteManagementClientExtensions.)
	RegisterSubscription()	Register your subscription to use Azure Web Sites.(Defined by WebSiteManagementClientExtensions.)
	RegisterSubscriptionAsync()	Register your subscription to use Azure Web Sites.(Defined by WebSiteManagementClientExtensions.)
	UnregisterSubscription()	Unregister your subscription to use Azure Web Sites.(Defined by WebSiteManagementClientExtensions.)
	UnregisterSubscriptionAsync()	Unregister your subscription to use Azure Web Sites.(Defined by WebSiteManagementClientExtensions.)

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.