@azure/arm-resources-subscriptions package

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.

Location

Location information.

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

OperationDisplay

Localized display information for an operation.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PairedRegion

Information regarding paired region.

Peers

Information about shared availability zone.

ResourceName

Name and Type of the Resource

Subscription

Subscription information.

SubscriptionClientOptionalParams

Optional parameters for the client.

SubscriptionPolicies

Subscription policies.

SubscriptionsCheckZonePeersOptionalParams

Optional parameters.

SubscriptionsGetOptionalParams

Optional parameters.

SubscriptionsListLocationsOptionalParams

Optional parameters.

SubscriptionsListOptionalParams

Optional parameters.

SubscriptionsOperations

Interface representing a Subscriptions operations.

TenantIdDescription

Tenant Id information.

TenantsListOptionalParams

Optional parameters.

TenantsOperations

Interface representing a Tenants operations.

Type Aliases

ActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports.

Known values supported by the service

Internal: Actions are for internal-only APIs.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

ContinuablePage

An interface that describes a page of results.

LocationType

The location type.

Origin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

user: Indicates the operation is initiated by a user.
system: Indicates the operation is initiated by a system.
user,system: Indicates the operation is initiated by a user or system.

RegionCategory

The category of the region.
KnownRegionCategory can be used interchangeably with RegionCategory, this enum contains the known values that the service supports.

Known values supported by the service

Recommended: Recommended
Extended: Extended
Other: Other

RegionType

The type of the region.
KnownRegionType can be used interchangeably with RegionType, this enum contains the known values that the service supports.

Known values supported by the service

Physical: Physical
Logical: Logical

ResourceNameStatus

Is the resource name Allowed or Reserved
KnownResourceNameStatus can be used interchangeably with ResourceNameStatus, this enum contains the known values that the service supports.

Known values supported by the service

Allowed: Allowed
Reserved: Reserved

SpendingLimit

The subscription spending limit.

SubscriptionState

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

TenantCategory

Category of the tenant.

Enums

AzureClouds

An enum to describe Azure Cloud environments.

KnownActionType

Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.

KnownOrigin

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

KnownRegionCategory

The category of the region.

KnownRegionType

The type of the region.

KnownResourceNameStatus

Is the resource name Allowed or Reserved

KnownVersions

The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type