LinkedSubscriptions interface

Package:

@azure/arm-azurestack

Interface representing a LinkedSubscriptions.

Methods

createOrUpdate(string, string, LinkedSubscriptionParameter, LinkedSubscriptionsCreateOrUpdateOptionalParams)	Create or update a linked subscription resource.
delete(string, string, LinkedSubscriptionsDeleteOptionalParams)	Delete the requested Linked Subscription resource.
get(string, string, LinkedSubscriptionsGetOptionalParams)	Returns the properties of a Linked Subscription resource.
listByResourceGroup(string, LinkedSubscriptionsListByResourceGroupOptionalParams)	Returns a list of all linked subscriptions under current resource group.
listBySubscription(LinkedSubscriptionsListBySubscriptionOptionalParams)	Returns a list of all linked subscriptions under current subscription.
update(string, string, LinkedSubscriptionParameter, LinkedSubscriptionsUpdateOptionalParams)	Patch a Linked Subscription resource.

Method Details

createOrUpdate(string, string, LinkedSubscriptionParameter, LinkedSubscriptionsCreateOrUpdateOptionalParams)

Create or update a linked subscription resource.

function createOrUpdate(resourceGroup: string, linkedSubscriptionName: string, resource: LinkedSubscriptionParameter, options?: LinkedSubscriptionsCreateOrUpdateOptionalParams): Promise<LinkedSubscription>

Parameters

resourceGroup

string

Name of the resource group.

linkedSubscriptionName

string

Name of the Linked Subscription resource.

resource

LinkedSubscriptionParameter

Linked subscription resource parameter.

options

LinkedSubscriptionsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<LinkedSubscription>

delete(string, string, LinkedSubscriptionsDeleteOptionalParams)

Delete the requested Linked Subscription resource.

function delete(resourceGroup: string, linkedSubscriptionName: string, options?: LinkedSubscriptionsDeleteOptionalParams): Promise<void>

Parameters

resourceGroup

string

Name of the resource group.

linkedSubscriptionName

string

Name of the Linked Subscription resource.

options

LinkedSubscriptionsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, LinkedSubscriptionsGetOptionalParams)

Returns the properties of a Linked Subscription resource.

function get(resourceGroup: string, linkedSubscriptionName: string, options?: LinkedSubscriptionsGetOptionalParams): Promise<LinkedSubscription>

Parameters

resourceGroup

string

Name of the resource group.

linkedSubscriptionName

string

Name of the Linked Subscription resource.

options

LinkedSubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<LinkedSubscription>

listByResourceGroup(string, LinkedSubscriptionsListByResourceGroupOptionalParams)

Returns a list of all linked subscriptions under current resource group.

function listByResourceGroup(resourceGroup: string, options?: LinkedSubscriptionsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<LinkedSubscription, LinkedSubscription[], PageSettings>

Parameters

resourceGroup

string

Name of the resource group.

options

LinkedSubscriptionsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LinkedSubscription, LinkedSubscription[], PageSettings>

listBySubscription(LinkedSubscriptionsListBySubscriptionOptionalParams)

Returns a list of all linked subscriptions under current subscription.

function listBySubscription(options?: LinkedSubscriptionsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<LinkedSubscription, LinkedSubscription[], PageSettings>

Parameters

options

LinkedSubscriptionsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<LinkedSubscription, LinkedSubscription[], PageSettings>

update(string, string, LinkedSubscriptionParameter, LinkedSubscriptionsUpdateOptionalParams)

Patch a Linked Subscription resource.

function update(resourceGroup: string, linkedSubscriptionName: string, resource: LinkedSubscriptionParameter, options?: LinkedSubscriptionsUpdateOptionalParams): Promise<LinkedSubscription>

Parameters

resourceGroup

string

Name of the resource group.

linkedSubscriptionName

string

Name of the Linked Subscription resource.

resource

LinkedSubscriptionParameter

Linked subscription resource parameter.

options

LinkedSubscriptionsUpdateOptionalParams

The options parameters.

Returns

Promise<LinkedSubscription>