SubscriptionClient class

Extends

Constructors

SubscriptionClient(TokenCredential, SubscriptionClientOptionalParams)

Initializes a new instance of the SubscriptionClient class.

Properties

$host
apiVersion
operations
subscriptions
tenants

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

checkResourceName(CheckResourceNameOptionalParams)

A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

SubscriptionClient(TokenCredential, SubscriptionClientOptionalParams)

Initializes a new instance of the SubscriptionClient class.

new SubscriptionClient(credentials: TokenCredential, options?: SubscriptionClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

options
SubscriptionClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

operations

operations: Operations

Property Value

subscriptions

subscriptions: Subscriptions

Property Value

tenants

tenants: Tenants

Property Value

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Inherited From coreClient.ServiceClient.pipeline

Method Details

checkResourceName(CheckResourceNameOptionalParams)

A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word

function checkResourceName(options?: CheckResourceNameOptionalParams): Promise<CheckResourceNameResult>

Parameters

options
CheckResourceNameOptionalParams

The options parameters.

Returns

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest