Class SubscriptionClient

The subscription client

Inheritance

Object

ServiceClient<T>

SubscriptionClient

Inherited Members

ServiceClient<T>.CreateHttpHandlerPipeline(HttpClientHandler, DelegatingHandler[])

ServiceClient<T>.Dispose()

ServiceClient<T>.Dispose(Boolean)

ServiceClient<T>.FirstMessageHandler

ServiceClient<T>.HttpClient

ServiceClient<T>.HttpClientHandler

ServiceClient<T>.HttpMessageHandlers

ServiceClient<T>.InitializeHttpClient(HttpClient, HttpClientHandler, DelegatingHandler[])

ServiceClient<T>.InitializeHttpClient(HttpClientHandler, DelegatingHandler[])

ServiceClient<T>.SetRetryPolicy(RetryPolicy)

ServiceClient<T>.SetUserAgent(String)

ServiceClient<T>.SetUserAgent(String, String)

ServiceClient<T>.UserAgent

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Subscription.dll

Syntax

public class SubscriptionClient : Microsoft.Rest.ServiceClient<Microsoft.Azure.Management.Subscription.SubscriptionClient>, IDisposable, Microsoft.Azure.Management.Subscription.ISubscriptionClient, Microsoft.Rest.Azure.IAzureClient

Constructors

SubscriptionClient(DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

protected SubscriptionClient (params System.Net.Http.DelegatingHandler[] handlers);

Parameters

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

SubscriptionClient(ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

public SubscriptionClient (Microsoft.Rest.ServiceClientCredentials credentials, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

ServiceClientCredentials credentials Required. Credentials needed for the client to connect to Azure.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(HttpClient, Boolean)

Initializes a new instance of the SubscriptionClient class.

Declaration

protected SubscriptionClient (System.Net.Http.HttpClient httpClient, bool disposeHttpClient);

Parameters

HttpClient httpClient HttpClient to be used

Boolean disposeHttpClient True: will dispose the provided httpClient on calling SubscriptionClient.Dispose(). False: will not dispose provided httpClient

SubscriptionClient(HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

protected SubscriptionClient (System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

HttpClientHandler rootHandler Optional. The http client handler used to handle http transport.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

SubscriptionClient(Uri, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

protected SubscriptionClient (Uri baseUri, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

Uri baseUri Optional. The base URI of the service.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(ServiceClientCredentials, HttpClient, Boolean)

Initializes a new instance of the SubscriptionClient class.

Declaration

public SubscriptionClient (Microsoft.Rest.ServiceClientCredentials credentials, System.Net.Http.HttpClient httpClient, bool disposeHttpClient);

Parameters

ServiceClientCredentials credentials Required. Credentials needed for the client to connect to Azure.

HttpClient httpClient HttpClient to be used

Boolean disposeHttpClient True: will dispose the provided httpClient on calling SubscriptionClient.Dispose(). False: will not dispose provided httpClient

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

public SubscriptionClient (Microsoft.Rest.ServiceClientCredentials credentials, System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

ServiceClientCredentials credentials Required. Credentials needed for the client to connect to Azure.

HttpClientHandler rootHandler Optional. The http client handler used to handle http transport.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(Uri, ServiceClientCredentials, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

public SubscriptionClient (Uri baseUri, Microsoft.Rest.ServiceClientCredentials credentials, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

Uri baseUri Optional. The base URI of the service.

ServiceClientCredentials credentials Required. Credentials needed for the client to connect to Azure.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(Uri, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

protected SubscriptionClient (Uri baseUri, System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

Uri baseUri Optional. The base URI of the service.

HttpClientHandler rootHandler Optional. The http client handler used to handle http transport.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

SubscriptionClient(Uri, ServiceClientCredentials, HttpClientHandler, DelegatingHandler[])

Initializes a new instance of the SubscriptionClient class.

Declaration

public SubscriptionClient (Uri baseUri, Microsoft.Rest.ServiceClientCredentials credentials, System.Net.Http.HttpClientHandler rootHandler, params System.Net.Http.DelegatingHandler[] handlers);

Parameters

Uri baseUri Optional. The base URI of the service.

ServiceClientCredentials credentials Required. Credentials needed for the client to connect to Azure.

HttpClientHandler rootHandler Optional. The http client handler used to handle http transport.

DelegatingHandler[] handlers Optional. The delegating handlers to add to the http client pipeline.

Exceptions

System.ArgumentNullException Thrown when a required parameter is null

Properties

AcceptLanguage

The preferred language for the response.

Declaration

public string AcceptLanguage { get; set; }

Property Value

String

Implements

ISubscriptionClient.AcceptLanguage

BaseUri

The base URI of the service.

Declaration

public Uri BaseUri { get; set; }

Property Value

Uri

Implements

ISubscriptionClient.BaseUri

Credentials

Credentials needed for the client to connect to Azure.

Declaration

public Microsoft.Rest.ServiceClientCredentials Credentials { get; }

Property Value

ServiceClientCredentials

DeserializationSettings

Gets or sets json deserialization settings.

Declaration

public Newtonsoft.Json.JsonSerializerSettings DeserializationSettings { get; }

Property Value

JsonSerializerSettings

GenerateClientRequestId

Whether a unique x-ms-client-request-id should be generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Declaration

public Nullable<bool> GenerateClientRequestId { get; set; }

Property Value

Nullable<Boolean>

Implements

ISubscriptionClient.GenerateClientRequestId

IAzureClient.GenerateClientRequestId

LongRunningOperationRetryTimeout

The retry timeout in seconds for Long Running Operations. Default value is 30.

Declaration

public Nullable<int> LongRunningOperationRetryTimeout { get; set; }

Property Value

Nullable<Int32>

Implements

ISubscriptionClient.LongRunningOperationRetryTimeout

IAzureClient.LongRunningOperationRetryTimeout

Operations

Gets the IOperations.

Declaration

public Microsoft.Azure.Management.Subscription.IOperations Operations { get; }

Property Value

IOperations

SerializationSettings

Gets or sets json serialization settings.

Declaration

public Newtonsoft.Json.JsonSerializerSettings SerializationSettings { get; }

Property Value

JsonSerializerSettings

SubscriptionFactory

Gets the ISubscriptionFactoryOperations.

Declaration

public Microsoft.Azure.Management.Subscription.ISubscriptionFactoryOperations SubscriptionFactory { get; }

Property Value

ISubscriptionFactoryOperations

SubscriptionOperation

Gets the ISubscriptionOperationOperations.

Declaration

public Microsoft.Azure.Management.Subscription.ISubscriptionOperationOperations SubscriptionOperation { get; }

Property Value

ISubscriptionOperationOperations

SubscriptionOperations

Gets the ISubscriptionOperations.

Declaration

public Microsoft.Azure.Management.Subscription.ISubscriptionOperations SubscriptionOperations { get; }

Property Value

ISubscriptionOperations

Subscriptions

Gets the ISubscriptionsOperations.

Declaration

public Microsoft.Azure.Management.Subscription.ISubscriptionsOperations Subscriptions { get; }

Property Value

ISubscriptionsOperations

Tenants

Gets the ITenantsOperations.

Declaration

public Microsoft.Azure.Management.Subscription.ITenantsOperations Tenants { get; }

Property Value

ITenantsOperations

Extension Methods

AzureClientExtensions.GetLongRunningOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetLongRunningOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetLongRunningOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetLongRunningOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPostOrDeleteOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPostOrDeleteOperationResultAsync<THeader>(IAzureClient, AzureOperationHeaderResponse<THeader>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPostOrDeleteOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPostOrDeleteOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPutOrPatchOperationResultAsync(IAzureClient, AzureOperationResponse, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPutOrPatchOperationResultAsync<TBody>(IAzureClient, AzureOperationResponse<TBody>, Dictionary<String,List<String>>, CancellationToken)

AzureClientExtensions.GetPutOrPatchOperationResultAsync<TBody,THeader>(IAzureClient, AzureOperationResponse<TBody,THeader>, Dictionary<String,List<String>>, CancellationToken)