Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-resources-subscriptions

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

LocationType

LocationType: "Region" | "EdgeZone"

Defines values for LocationType.

RegionCategory

RegionCategory: string

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

RegionType: string

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

ResourceNameStatus: string

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

SpendingLimit: "On" | "Off" | "CurrentPeriodOff"

Defines values for SpendingLimit.

SubscriptionClientCheckResourceNameResponse

SubscriptionClientCheckResourceNameResponse: CheckResourceNameResult

Contains response data for the checkResourceName operation.

SubscriptionState

SubscriptionState: "Enabled" | "Warned" | "PastDue" | "Disabled" | "Deleted"

Defines values for SubscriptionState.

SubscriptionsGetResponse

SubscriptionsGetResponse: Subscription

Contains response data for the get operation.

SubscriptionsListLocationsResponse

SubscriptionsListLocationsResponse: LocationListResult

Contains response data for the listLocations operation.

SubscriptionsListNextResponse

SubscriptionsListNextResponse: SubscriptionListResult

Contains response data for the listNext operation.

SubscriptionsListResponse

SubscriptionsListResponse: SubscriptionListResult

Contains response data for the list operation.

TenantCategory

TenantCategory: "Home" | "ProjectedBy" | "ManagedBy"

Defines values for TenantCategory.

TenantsListNextResponse

TenantsListNextResponse: TenantListResult

Contains response data for the listNext operation.

TenantsListResponse

TenantsListResponse: TenantListResult

Contains response data for the list operation.

Variables

Const serializer

serializer: any = coreClient.createSerializer(Mappers, /* isXml */ false)

Object literals

Const $host

$host: object

parameterPath

parameterPath: string = "$host"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "$host"

type

type: object

name

name: string = "String"

Const CheckResourceNameResult

CheckResourceNameResult: object

type

type: object

className

className: string = "CheckResourceNameResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const CloudError

CloudError: object

type

type: object

className

className: string = "CloudError"

name

name: string = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

Const ErrorAdditionalInfo

ErrorAdditionalInfo: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

info

info: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "info"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "any"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ErrorResponse

ErrorResponse: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

modelProperties

modelProperties: object

additionalInfo

additionalInfo: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "additionalInfo"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorAdditionalInfo"

name

name: string = "Composite"

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorResponse"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const Location

Location: object

type

type: object

className

className: string = "Location"

name

name: string = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

className

className: string = "LocationMetadata"

name

name: string = "Composite"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

regionalDisplayName

regionalDisplayName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "regionalDisplayName"

type

type: object

name

name: string = "String"

subscriptionId

subscriptionId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: string = "String"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["Region", "EdgeZone"]

name

name: string = "Enum"

Const LocationListResult

LocationListResult: object

type

type: object

className

className: string = "LocationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Location"

name

name: string = "Composite"

Const LocationMetadata

LocationMetadata: object

type

type: object

className

className: string = "LocationMetadata"

name

name: string = "Composite"

modelProperties

modelProperties: object

geographyGroup

geographyGroup: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "geographyGroup"

type

type: object

name

name: string = "String"

homeLocation

homeLocation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "homeLocation"

type

type: object

name

name: string = "String"

latitude

latitude: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "latitude"

type

type: object

name

name: string = "String"

longitude

longitude: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "longitude"

type

type: object

name

name: string = "String"

pairedRegion

pairedRegion: object

serializedName

serializedName: string = "pairedRegion"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "PairedRegion"

name

name: string = "Composite"

physicalLocation

physicalLocation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "physicalLocation"

type

type: object

name

name: string = "String"

regionCategory

regionCategory: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "regionCategory"

type

type: object

name

name: string = "String"

regionType

regionType: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "regionType"

type

type: object

name

name: string = "String"

Const ManagedByTenant

ManagedByTenant: object

type

type: object

className

className: string = "ManagedByTenant"

name

name: string = "Composite"

modelProperties

modelProperties: object

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "String"

Const Operation

Operation: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const OperationDisplay

OperationDisplay: object

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: string = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: string = "String"

Const OperationListResult

OperationListResult: object

type

type: object

className

className: string = "OperationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: string = "Composite"

Const PairedRegion

PairedRegion: object

type

type: object

className

className: string = "PairedRegion"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

subscriptionId

subscriptionId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: string = "String"

Const ResourceName

ResourceName: object

type

type: object

className

className: string = "ResourceName"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const Subscription

Subscription: object

type

type: object

className

className: string = "Subscription"

name

name: string = "Composite"

modelProperties

modelProperties: object

authorizationSource

authorizationSource: object

serializedName

serializedName: string = "authorizationSource"

type

type: object

name

name: string = "String"

displayName

displayName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

managedByTenants

managedByTenants: object

serializedName

serializedName: string = "managedByTenants"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ManagedByTenant"

name

name: string = "Composite"

state

state: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled", "Warned", "PastDue", "Disabled", "Deleted"]

name

name: string = "Enum"

subscriptionId

subscriptionId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: string = "String"

subscriptionPolicies

subscriptionPolicies: object

serializedName

serializedName: string = "subscriptionPolicies"

type

type: object

className

className: string = "SubscriptionPolicies"

name

name: string = "Composite"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "String"

Const SubscriptionListResult

SubscriptionListResult: object

type

type: object

className

className: string = "SubscriptionListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Subscription"

name

name: string = "Composite"

Const SubscriptionPolicies

SubscriptionPolicies: object

type

type: object

className

className: string = "SubscriptionPolicies"

name

name: string = "Composite"

modelProperties

modelProperties: object

locationPlacementId

locationPlacementId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "locationPlacementId"

type

type: object

name

name: string = "String"

quotaId

quotaId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "quotaId"

type

type: object

name

name: string = "String"

spendingLimit

spendingLimit: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "spendingLimit"

type

type: object

allowedValues

allowedValues: string[] = ["On", "Off", "CurrentPeriodOff"]

name

name: string = "Enum"

Const TenantIdDescription

TenantIdDescription: object

type

type: object

className

className: string = "TenantIdDescription"

name

name: string = "Composite"

modelProperties

modelProperties: object

country

country: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "country"

type

type: object

name

name: string = "String"

countryCode

countryCode: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "countryCode"

type

type: object

name

name: string = "String"

defaultDomain

defaultDomain: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "defaultDomain"

type

type: object

name

name: string = "String"

displayName

displayName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: string = "String"

domains

domains: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "domains"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

tenantBrandingLogoUrl

tenantBrandingLogoUrl: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantBrandingLogoUrl"

type

type: object

name

name: string = "String"

tenantCategory

tenantCategory: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantCategory"

type

type: object

allowedValues

allowedValues: string[] = ["Home", "ProjectedBy", "ManagedBy"]

name

name: string = "Enum"

tenantId

tenantId: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: string = "String"

tenantType

tenantType: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "tenantType"

type

type: object

name

name: string = "String"

Const TenantListResult

TenantListResult: object

type

type: object

className

className: string = "TenantListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TenantIdDescription"

name

name: string = "Composite"

Const accept

accept: object

parameterPath

parameterPath: string = "accept"

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Accept"

type

type: object

name

name: string = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

defaultValue

defaultValue: string = "2021-01-01"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const checkResourceNameOperationSpec

checkResourceNameOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept, Parameters.contentType]

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/providers/Microsoft.Resources/checkResourceName"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.resourceNameDefinition

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.CheckResourceNameResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const contentType

contentType: object

parameterPath

parameterPath: string[] = ["options", "contentType"]

mapper

mapper: object

defaultValue

defaultValue: string = "application/json"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "Content-Type"

type

type: object

name

name: string = "String"

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Subscription

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const includeExtendedLocations

includeExtendedLocations: object

parameterPath

parameterPath: string[] = ["options", "includeExtendedLocations"]

mapper

mapper: object

serializedName

serializedName: string = "includeExtendedLocations"

type

type: object

name

name: string = "Boolean"

Const listLocationsOperationSpec

listLocationsOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/locations"

queryParameters

queryParameters: any[] = [Parameters.apiVersion, Parameters.includeExtendedLocations]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.subscriptionId]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.LocationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listNextOperationSpec

listNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host, Parameters.nextLink]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.TenantListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/tenants"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.$host]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.TenantListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const nextLink

nextLink: object

parameterPath

parameterPath: string = "nextLink"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

Const resourceNameDefinition

resourceNameDefinition: object

mapper

mapper: any = ResourceNameMapper

parameterPath

parameterPath: string[] = ["options", "resourceNameDefinition"]

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: string = "String"

Generated using TypeDoc