@azure/arm-subscriptions package
Classes
| SubscriptionClient |
Interfaces
| AcceptOwnershipRequest |
The parameters required to accept subscription ownership. |
| AcceptOwnershipRequestProperties |
Accept subscription ownership request properties. |
| AcceptOwnershipStatusResponse |
Subscription Accept Ownership Response |
| Alias |
Interface representing a Alias. |
| AliasCreateOptionalParams |
Optional parameters. |
| AliasDeleteOptionalParams |
Optional parameters. |
| AliasGetOptionalParams |
Optional parameters. |
| AliasListOptionalParams |
Optional parameters. |
| BillingAccount |
Interface representing a BillingAccount. |
| BillingAccountGetPolicyOptionalParams |
Optional parameters. |
| BillingAccountPoliciesResponse |
Billing account policies information. |
| BillingAccountPoliciesResponseProperties |
Put billing account policies response properties. |
| CanceledSubscriptionId |
The ID of the canceled subscription |
| EnabledSubscriptionId |
The ID of the subscriptions that is being enabled |
| ErrorResponse |
Describes the format of Error response. |
| ErrorResponseBody |
Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. |
| GetTenantPolicyListResponse |
Tenant policy information list. |
| GetTenantPolicyResponse |
Tenant policy Information. |
| Location |
Location information. |
| LocationListResult |
Location list operation response. |
| Operation |
REST API operation |
| OperationDisplay |
The object that represents the operation. |
| OperationListResult |
Result of the request to list operations. It contains a list of operations and a URL link to get the next set of results. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PutAliasRequest |
The parameters required to create a new subscription. |
| PutAliasRequestAdditionalProperties |
Put subscription additional properties. |
| PutAliasRequestProperties |
Put subscription properties. |
| PutTenantPolicyRequestProperties |
Put tenant policy request properties. |
| RenamedSubscriptionId |
The ID of the subscriptions that is being renamed |
| ServiceTenantResponse |
Billing account service tenant. |
| Subscription |
Subscription information. |
| SubscriptionAcceptOwnershipHeaders |
Defines headers for Subscription_acceptOwnership operation. |
| SubscriptionAcceptOwnershipOptionalParams |
Optional parameters. |
| SubscriptionAcceptOwnershipStatusOptionalParams |
Optional parameters. |
| SubscriptionAliasListResult |
The list of aliases. |
| SubscriptionAliasResponse |
Subscription Information with the alias. |
| SubscriptionAliasResponseProperties |
Put subscription creation result properties. |
| SubscriptionCancelOptionalParams |
Optional parameters. |
| SubscriptionClientOptionalParams |
Optional parameters. |
| SubscriptionEnableOptionalParams |
Optional parameters. |
| SubscriptionListResult |
Subscription list operation response. |
| SubscriptionName |
The new name of the subscription. |
| SubscriptionOperations |
Interface representing a SubscriptionOperations. |
| SubscriptionPolicies |
Subscription policies. |
| SubscriptionPolicy |
Interface representing a SubscriptionPolicy. |
| SubscriptionPolicyAddUpdatePolicyForTenantOptionalParams |
Optional parameters. |
| SubscriptionPolicyGetPolicyForTenantOptionalParams |
Optional parameters. |
| SubscriptionPolicyListPolicyForTenantNextOptionalParams |
Optional parameters. |
| SubscriptionPolicyListPolicyForTenantOptionalParams |
Optional parameters. |
| SubscriptionRenameOptionalParams |
Optional parameters. |
| Subscriptions |
Interface representing a Subscriptions. |
| SubscriptionsGetOptionalParams |
Optional parameters. |
| SubscriptionsListLocationsOptionalParams |
Optional parameters. |
| SubscriptionsListNextOptionalParams |
Optional parameters. |
| SubscriptionsListOptionalParams |
Optional parameters. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TenantIdDescription |
Tenant Id information. |
| TenantListResult |
Tenant Ids information. |
| TenantPolicy |
Tenant policy. |
| Tenants |
Interface representing a Tenants. |
| TenantsListNextOptionalParams |
Optional parameters. |
| TenantsListOptionalParams |
Optional parameters. |
Type Aliases
| AcceptOwnership |
Defines values for AcceptOwnership. Known values supported by the servicePending |
| AliasCreateResponse |
Contains response data for the create operation. |
| AliasGetResponse |
Contains response data for the get operation. |
| AliasListResponse |
Contains response data for the list operation. |
| BillingAccountGetPolicyResponse |
Contains response data for the getPolicy operation. |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| Provisioning |
Defines values for Provisioning. Known values supported by the servicePending |
| ProvisioningState |
Defines values for ProvisioningState. Known values supported by the serviceAccepted |
| SpendingLimit |
Defines values for SpendingLimit. |
| SubscriptionAcceptOwnershipResponse |
Contains response data for the acceptOwnership operation. |
| SubscriptionAcceptOwnershipStatusResponse |
Contains response data for the acceptOwnershipStatus operation. |
| SubscriptionCancelResponse |
Contains response data for the cancel operation. |
| SubscriptionEnableResponse |
Contains response data for the enable operation. |
| SubscriptionPolicyAddUpdatePolicyForTenantResponse |
Contains response data for the addUpdatePolicyForTenant operation. |
| SubscriptionPolicyGetPolicyForTenantResponse |
Contains response data for the getPolicyForTenant operation. |
| SubscriptionPolicyListPolicyForTenantNextResponse |
Contains response data for the listPolicyForTenantNext operation. |
| SubscriptionPolicyListPolicyForTenantResponse |
Contains response data for the listPolicyForTenant operation. |
| SubscriptionRenameResponse |
Contains response data for the rename operation. |
| SubscriptionState |
Defines values for SubscriptionState. |
| 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. |
| TenantsListNextResponse |
Contains response data for the listNext operation. |
| TenantsListResponse |
Contains response data for the list operation. |
| Workload |
Defines values for Workload. Known values supported by the serviceProduction |
Enums
| KnownAcceptOwnership |
Known values of AcceptOwnership that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownProvisioning |
Known values of Provisioning that the service accepts. |
| KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
| KnownWorkload |
Known values of Workload that the service accepts. |
Functions
| get |
Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later. |
Function Details
getContinuationToken(unknown)
Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.
function getContinuationToken(page: unknown): string | undefinedParameters
- page
-
unknown
A result object from calling .byPage() on a paged operation.
Returns
string | undefined
The continuation token that can be passed into byPage().