SubscriptionClient class

Package:

@azure/arm-subscriptions

Extends

ServiceClient

Constructors

SubscriptionClient(TokenCredential, SubscriptionClientOptionalParams)

Initializes a new instance of the SubscriptionClient class.

Properties

$host
alias
billingAccount
operations
subscriptionOperations
subscriptionPolicy
subscriptions
tenants

Inherited Properties

pipeline

The pipeline used by this client to make requests

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

alias

alias: Alias

Property Value

Alias

billingAccount

billingAccount: BillingAccount

Property Value

BillingAccount

operations

operations: Operations

Property Value

Operations

subscriptionOperations

subscriptionOperations: SubscriptionOperations

Property Value

SubscriptionOperations

subscriptionPolicy

subscriptionPolicy: SubscriptionPolicy

Property Value

SubscriptionPolicy

subscriptions

subscriptions: Subscriptions

Property Value

Subscriptions

tenants

tenants: Tenants

Property Value

Tenants

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

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