@azure/arm-resources-subscriptions package

Classes

SubscriptionClient

Interfaces

AvailabilityZoneMappings	Availability zone mappings for the region
AvailabilityZonePeers	List of availability zones shared by the subscriptions.
CheckResourceNameOptionalParams	Optional parameters.
CheckResourceNameResult	Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word
CheckZonePeersRequest	Check zone peers request parameters.
CheckZonePeersResult	Result of the Check zone peers operation.
CloudError	An error response for a resource management request.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)
ErrorResponseAutoGenerated	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Location	Location information.
LocationListResult	Location list operation response.
LocationMetadata	Location metadata information
ManagedByTenant	Information about a tenant managing the subscription.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationAutoGenerated	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationDisplayAutoGenerated	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
OperationListResultAutoGenerated	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PairedRegion	Information regarding paired region.
Peers	Information about shared availability zone.
ResourceName	Name and Type of the Resource
Subscription	Subscription information.
SubscriptionClientOptionalParams	Optional parameters.
SubscriptionListResult	Subscription list operation response.
SubscriptionPolicies	Subscription policies.
Subscriptions	Interface representing a Subscriptions.
SubscriptionsCheckZonePeersOptionalParams	Optional parameters.
SubscriptionsGetOptionalParams	Optional parameters.
SubscriptionsListLocationsOptionalParams	Optional parameters.
SubscriptionsListNextOptionalParams	Optional parameters.
SubscriptionsListOptionalParams	Optional parameters.
TenantIdDescription	Tenant Id information.
TenantListResult	Tenant Ids information.
Tenants	Interface representing a Tenants.
TenantsListNextOptionalParams	Optional parameters.
TenantsListOptionalParams	Optional parameters.

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CheckResourceNameResponse	Contains response data for the checkResourceName operation.
LocationType	Defines values for LocationType.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
RegionCategory	Defines values for RegionCategory. KnownRegionCategory can be used interchangeably with RegionCategory, this enum contains the known values that the service supports. Known values supported by the service Recommended Extended Other
RegionType	Defines values for RegionType. KnownRegionType can be used interchangeably with RegionType, this enum contains the known values that the service supports. Known values supported by the service Physical Logical
ResourceNameStatus	Defines values for ResourceNameStatus. KnownResourceNameStatus can be used interchangeably with ResourceNameStatus, this enum contains the known values that the service supports. Known values supported by the service Allowed Reserved
SpendingLimit	Defines values for SpendingLimit.
SubscriptionState	Defines values for SubscriptionState.
SubscriptionsCheckZonePeersResponse	Contains response data for the checkZonePeers operation.
SubscriptionsGetResponse	Contains response data for the get operation.
SubscriptionsListLocationsResponse	Contains response data for the listLocations operation.
SubscriptionsListNextResponse	Contains response data for the listNext operation.
SubscriptionsListResponse	Contains response data for the list operation.
TenantCategory	Defines values for TenantCategory.
TenantsListNextResponse	Contains response data for the listNext operation.
TenantsListResponse	Contains response data for the list operation.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownRegionCategory	Known values of RegionCategory that the service accepts.
KnownRegionType	Known values of RegionType that the service accepts.
KnownResourceNameStatus	Known values of ResourceNameStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.