SubscriptionOperations interface

Package:

@azure/arm-subscriptions

Interface representing a SubscriptionOperations.

Methods

acceptOwnershipStatus(string, SubscriptionAcceptOwnershipStatusOptionalParams)	Accept subscription ownership status.
beginAcceptOwnership(string, AcceptOwnershipRequest, SubscriptionAcceptOwnershipOptionalParams)	Accept subscription ownership.
beginAcceptOwnershipAndWait(string, AcceptOwnershipRequest, SubscriptionAcceptOwnershipOptionalParams)	Accept subscription ownership.
cancel(string, SubscriptionCancelOptionalParams)	The operation to cancel a subscription
enable(string, SubscriptionEnableOptionalParams)	The operation to enable a subscription
rename(string, SubscriptionName, SubscriptionRenameOptionalParams)	The operation to rename a subscription

Method Details

acceptOwnershipStatus(string, SubscriptionAcceptOwnershipStatusOptionalParams)

Accept subscription ownership status.

function acceptOwnershipStatus(subscriptionId: string, options?: SubscriptionAcceptOwnershipStatusOptionalParams): Promise<AcceptOwnershipStatusResponse>

Parameters

subscriptionId

string

Subscription Id.

options

SubscriptionAcceptOwnershipStatusOptionalParams

The options parameters.

Returns

Promise<AcceptOwnershipStatusResponse>

beginAcceptOwnership(string, AcceptOwnershipRequest, SubscriptionAcceptOwnershipOptionalParams)

Accept subscription ownership.

function beginAcceptOwnership(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise<PollerLike<PollOperationState<SubscriptionAcceptOwnershipHeaders>, SubscriptionAcceptOwnershipHeaders>>

Parameters

subscriptionId

string

Subscription Id.

body

AcceptOwnershipRequest

The parameters required to accept subscription ownership.

options

SubscriptionAcceptOwnershipOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<SubscriptionAcceptOwnershipHeaders>, SubscriptionAcceptOwnershipHeaders>>

beginAcceptOwnershipAndWait(string, AcceptOwnershipRequest, SubscriptionAcceptOwnershipOptionalParams)

Accept subscription ownership.

function beginAcceptOwnershipAndWait(subscriptionId: string, body: AcceptOwnershipRequest, options?: SubscriptionAcceptOwnershipOptionalParams): Promise<SubscriptionAcceptOwnershipHeaders>

Parameters

subscriptionId

string

Subscription Id.

body

AcceptOwnershipRequest

The parameters required to accept subscription ownership.

options

SubscriptionAcceptOwnershipOptionalParams

The options parameters.

Returns

Promise<SubscriptionAcceptOwnershipHeaders>

cancel(string, SubscriptionCancelOptionalParams)

The operation to cancel a subscription

function cancel(subscriptionId: string, options?: SubscriptionCancelOptionalParams): Promise<CanceledSubscriptionId>

Parameters

subscriptionId

string

Subscription Id.

options

SubscriptionCancelOptionalParams

The options parameters.

Returns

Promise<CanceledSubscriptionId>

enable(string, SubscriptionEnableOptionalParams)

The operation to enable a subscription

function enable(subscriptionId: string, options?: SubscriptionEnableOptionalParams): Promise<EnabledSubscriptionId>

Parameters

subscriptionId

string

Subscription Id.

options

SubscriptionEnableOptionalParams

The options parameters.

Returns

Promise<EnabledSubscriptionId>

rename(string, SubscriptionName, SubscriptionRenameOptionalParams)

The operation to rename a subscription

function rename(subscriptionId: string, body: SubscriptionName, options?: SubscriptionRenameOptionalParams): Promise<RenamedSubscriptionId>

Parameters

subscriptionId

string

Subscription Id.

body

SubscriptionName

Subscription Name

options

SubscriptionRenameOptionalParams

The options parameters.

Returns

Promise<RenamedSubscriptionId>