@azure/arm-astro package

Classes

AstroManagementClient

Interfaces

AstroManagementClientOptionalParams

Optional parameters.

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.).

LiftrBaseDataOrganizationProperties

Properties specific to Data Organization resource

LiftrBaseDataPartnerOrganizationProperties

Properties specific to Partner's organization

LiftrBaseDataPartnerOrganizationPropertiesUpdate

Properties specific to Partner's organization

LiftrBaseMarketplaceDetails

Marketplace details for an organization

LiftrBaseOfferDetails

Offer details for the marketplace that is selected by the user

LiftrBaseSingleSignOnProperties

Properties specific to Single Sign On Resource

LiftrBaseUserDetails

User details for an organization

LiftrBaseUserDetailsUpdate

User details for an organization

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

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.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

OrganizationResource

Organization Resource by Astronomer

OrganizationResourceListResult

The response of a OrganizationResource list operation.

OrganizationResourceUpdate

The type used for update operations of the OrganizationResource.

OrganizationResourceUpdateProperties

The updatable properties of the OrganizationResource.

Organizations

Interface representing a Organizations.

OrganizationsCreateOrUpdateHeaders

Defines headers for Organizations_createOrUpdate operation.

OrganizationsCreateOrUpdateOptionalParams

Optional parameters.

OrganizationsDeleteHeaders

Defines headers for Organizations_delete operation.

OrganizationsDeleteOptionalParams

Optional parameters.

OrganizationsGetOptionalParams

Optional parameters.

OrganizationsListByResourceGroupNextOptionalParams

Optional parameters.

OrganizationsListByResourceGroupOptionalParams

Optional parameters.

OrganizationsListBySubscriptionNextOptionalParams

Optional parameters.

OrganizationsListBySubscriptionOptionalParams

Optional parameters.

OrganizationsUpdateHeaders

Defines headers for Organizations_update operation.

OrganizationsUpdateOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

SystemData

Metadata pertaining to creation and last modification of the resource.

TrackedResource

The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

UserAssignedIdentity

User assigned identity properties

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

CreatedByType

Defines values for CreatedByType.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

ManagedServiceIdentityType

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

MarketplaceSubscriptionStatus

Defines values for MarketplaceSubscriptionStatus.
KnownMarketplaceSubscriptionStatus can be used interchangeably with MarketplaceSubscriptionStatus, this enum contains the known values that the service supports.

Known values supported by the service

PendingFulfillmentStart: Purchased but not yet activated
Subscribed: Marketplace subscription is activated
Suspended: This state indicates that a customer's payment for the Marketplace service was not received
Unsubscribed: Customer has cancelled the subscription

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OrganizationsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

OrganizationsDeleteResponse

Contains response data for the delete operation.

OrganizationsGetResponse

Contains response data for the get operation.

OrganizationsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

OrganizationsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

OrganizationsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

OrganizationsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

OrganizationsUpdateResponse

Contains response data for the update 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

ResourceProvisioningState

Defines values for ResourceProvisioningState.
KnownResourceProvisioningState can be used interchangeably with ResourceProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.

SingleSignOnStates

Defines values for SingleSignOnStates.
KnownSingleSignOnStates can be used interchangeably with SingleSignOnStates, this enum contains the known values that the service supports.

Known values supported by the service

Initial: Initial state of the SSO resource
Enable: State of the SSO resource when it is enabled
Disable: State of the SSO resource when it is disabled

Versions

Defines values for Versions.
KnownVersions can be used interchangeably with Versions, this enum contains the known values that the service supports.

Known values supported by the service

2023-08-01: Dependent on Azure.ResourceManager.Versions.v1_0_Preview_1, LiftrBase.Versions.v1_preview, LiftrBase.Data.Versions.v1_preview

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownMarketplaceSubscriptionStatus

Known values of MarketplaceSubscriptionStatus that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownResourceProvisioningState

Known values of ResourceProvisioningState that the service accepts.

KnownSingleSignOnStates

Known values of SingleSignOnStates that the service accepts.

KnownVersions

Known values of Versions 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.