ManagementGroupSubscriptions interface

  • Reference
Package:
@azure/arm-managementgroups

Interface representing a ManagementGroupSubscriptions.

Methods

create(string, string, ManagementGroupSubscriptionsCreateOptionalParams)

Associates existing subscription with the management group.
delete(string, string, ManagementGroupSubscriptionsDeleteOptionalParams)

De-associates subscription from the management group.
getSubscription(string, string, ManagementGroupSubscriptionsGetSubscriptionOptionalParams)

Retrieves details about given subscription which is associated with the management group.
listSubscriptionsUnderManagementGroup(string, ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams)

Retrieves details about all subscriptions which are associated with the management group.

Method Details

create(string, string, ManagementGroupSubscriptionsCreateOptionalParams)

Associates existing subscription with the management group.

function create(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsCreateOptionalParams): Promise<SubscriptionUnderManagementGroup>

Parameters

groupId

string

Management Group ID.

subscriptionId

string

Subscription ID.

options
ManagementGroupSubscriptionsCreateOptionalParams

The options parameters.

Returns

Promise<SubscriptionUnderManagementGroup>

delete(string, string, ManagementGroupSubscriptionsDeleteOptionalParams)

De-associates subscription from the management group.

function delete(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsDeleteOptionalParams): Promise<void>

Parameters

groupId

string

Management Group ID.

subscriptionId

string

Subscription ID.

options
ManagementGroupSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

getSubscription(string, string, ManagementGroupSubscriptionsGetSubscriptionOptionalParams)

Retrieves details about given subscription which is associated with the management group.

function getSubscription(groupId: string, subscriptionId: string, options?: ManagementGroupSubscriptionsGetSubscriptionOptionalParams): Promise<SubscriptionUnderManagementGroup>

Parameters

groupId

string

Management Group ID.

subscriptionId

string

Subscription ID.

options
ManagementGroupSubscriptionsGetSubscriptionOptionalParams

The options parameters.

Returns

Promise<SubscriptionUnderManagementGroup>

listSubscriptionsUnderManagementGroup(string, ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams)

Retrieves details about all subscriptions which are associated with the management group.

function listSubscriptionsUnderManagementGroup(groupId: string, options?: ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams): PagedAsyncIterableIterator<SubscriptionUnderManagementGroup, SubscriptionUnderManagementGroup[], PageSettings>

Parameters

groupId

string

Management Group ID.

options
ManagementGroupSubscriptionsGetSubscriptionsUnderManagementGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SubscriptionUnderManagementGroup, SubscriptionUnderManagementGroup[], PageSettings>