Share via

Subscriptions interface

  • Reference
Package:
@azure/arm-resources-subscriptions

Interface representing a Subscriptions.

Methods

checkZonePeers(string, CheckZonePeersRequest, SubscriptionsCheckZonePeersOptionalParams)

Compares a subscriptions logical zone mapping
get(string, SubscriptionsGetOptionalParams)

Gets details about a specified subscription.
list(SubscriptionsListOptionalParams)

Gets all subscriptions for a tenant.
listLocations(string, SubscriptionsListLocationsOptionalParams)

This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

Method Details

checkZonePeers(string, CheckZonePeersRequest, SubscriptionsCheckZonePeersOptionalParams)

Compares a subscriptions logical zone mapping

function checkZonePeers(subscriptionId: string, parameters: CheckZonePeersRequest, options?: SubscriptionsCheckZonePeersOptionalParams): Promise<CheckZonePeersResult>

Parameters

subscriptionId

string

The ID of the target subscription.

parameters
CheckZonePeersRequest

Parameters for checking zone peers.

options
SubscriptionsCheckZonePeersOptionalParams

The options parameters.

Returns

Promise<CheckZonePeersResult>

get(string, SubscriptionsGetOptionalParams)

Gets details about a specified subscription.

function get(subscriptionId: string, options?: SubscriptionsGetOptionalParams): Promise<Subscription>

Parameters

subscriptionId

string

The ID of the target subscription.

options
SubscriptionsGetOptionalParams

The options parameters.

Returns

Promise<Subscription>

list(SubscriptionsListOptionalParams)

Gets all subscriptions for a tenant.

function list(options?: SubscriptionsListOptionalParams): PagedAsyncIterableIterator<Subscription, Subscription[], PageSettings>

Parameters

options
SubscriptionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Subscription, Subscription[], PageSettings>

listLocations(string, SubscriptionsListLocationsOptionalParams)

This operation provides all the locations that are available for resource providers; however, each resource provider may support a subset of this list.

function listLocations(subscriptionId: string, options?: SubscriptionsListLocationsOptionalParams): PagedAsyncIterableIterator<Location_2, Location_2[], PageSettings>

Parameters

subscriptionId

string

The ID of the target subscription.

options
SubscriptionsListLocationsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Location, Location[], PageSettings>