@azure/arm-orbital package
Classes
| AzureOrbital |
Interfaces
| AuthorizedGroundstation |
Authorized groundstation. |
| AvailableContacts |
Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact. |
| AvailableContactsListResult |
Response for the ListAvailableContacts API service call. |
| AvailableContactsProperties |
Properties of Contact resource. |
| AvailableContactsSpacecraft |
The reference to the spacecraft resource. |
| AvailableGroundStation |
Ground Stations available to schedule Contacts. |
| AvailableGroundStationListResult |
Response for the AvailableGroundStations API service call. |
| AvailableGroundStationProperties |
The properties bag for this resource. |
| AvailableGroundStationPropertiesAutoGenerated |
Properties object for Available groundstation. |
| AvailableGroundStations |
Interface representing a AvailableGroundStations. |
| AvailableGroundStationsListByCapabilityNextOptionalParams |
Optional parameters. |
| AvailableGroundStationsListByCapabilityOptionalParams |
Optional parameters. |
| AzureOrbitalOptionalParams |
Optional parameters. |
| Contact |
Customer creates a contact resource for a spacecraft resource. |
| ContactInstanceProperties |
Contact Instance Properties. |
| ContactListResult |
Response for the ListContacts API service call. |
| ContactParameters |
Parameters that define the contact resource. |
| ContactParametersContactProfile |
The reference to the contact profile resource. |
| ContactProfile |
Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact. |
| ContactProfileLink |
Contact Profile Link. |
| ContactProfileLinkChannel |
Contact Profile Link Channel. |
| ContactProfileListResult |
Response for the ListContactProfiles API service call. |
| ContactProfileProperties |
Properties of the contact profile resource. |
| ContactProfileThirdPartyConfiguration |
Contact Profile third-party partner configuration. |
| ContactProfiles |
Interface representing a ContactProfiles. |
| ContactProfilesCreateOrUpdateHeaders |
Defines headers for ContactProfiles_createOrUpdate operation. |
| ContactProfilesCreateOrUpdateOptionalParams |
Optional parameters. |
| ContactProfilesDeleteHeaders |
Defines headers for ContactProfiles_delete operation. |
| ContactProfilesDeleteOptionalParams |
Optional parameters. |
| ContactProfilesGetOptionalParams |
Optional parameters. |
| ContactProfilesListBySubscriptionNextOptionalParams |
Optional parameters. |
| ContactProfilesListBySubscriptionOptionalParams |
Optional parameters. |
| ContactProfilesListNextOptionalParams |
Optional parameters. |
| ContactProfilesListOptionalParams |
Optional parameters. |
| ContactProfilesProperties |
List of Contact Profile Resource Properties. |
| ContactProfilesPropertiesNetworkConfiguration |
Network configuration of customer virtual network. |
| ContactProfilesUpdateTagsHeaders |
Defines headers for ContactProfiles_updateTags operation. |
| ContactProfilesUpdateTagsOptionalParams |
Optional parameters. |
| Contacts |
Interface representing a Contacts. |
| ContactsCreateHeaders |
Defines headers for Contacts_create operation. |
| ContactsCreateOptionalParams |
Optional parameters. |
| ContactsDeleteHeaders |
Defines headers for Contacts_delete operation. |
| ContactsDeleteOptionalParams |
Optional parameters. |
| ContactsGetOptionalParams |
Optional parameters. |
| ContactsListNextOptionalParams |
Optional parameters. |
| ContactsListOptionalParams |
Optional parameters. |
| ContactsPropertiesAntennaConfiguration |
The configuration associated with the allocated antenna. |
| ContactsPropertiesContactProfile |
The reference to the contact profile resource. |
| EndPoint |
Customer end point to store and retrieve data during a contact with the spacecraft. |
| 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.). |
| 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. |
| OperationResult |
Operation Result Entity. |
| OperationResultErrorProperties |
Operation result error properties. |
| Operations |
Interface representing a Operations. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsResults |
Interface representing a OperationsResults. |
| OperationsResultsGetHeaders |
Defines headers for OperationsResults_get operation. |
| OperationsResultsGetOptionalParams |
Optional parameters. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| ResourceIdListResult |
Response for an API service call that lists the resource IDs of resources associated with another resource. |
| ResourceIdListResultValueItem | |
| ResourceReference |
Resource Reference. |
| Spacecraft |
Customer creates a spacecraft resource to schedule a contact. |
| SpacecraftLink |
List of authorized spacecraft links per ground station and the expiration date of the authorization. |
| SpacecraftListResult |
Response for the ListSpacecrafts API service call. |
| Spacecrafts |
Interface representing a Spacecrafts. |
| SpacecraftsCreateOrUpdateHeaders |
Defines headers for Spacecrafts_createOrUpdate operation. |
| SpacecraftsCreateOrUpdateOptionalParams |
Optional parameters. |
| SpacecraftsDeleteHeaders |
Defines headers for Spacecrafts_delete operation. |
| SpacecraftsDeleteOptionalParams |
Optional parameters. |
| SpacecraftsGetOptionalParams |
Optional parameters. |
| SpacecraftsListAvailableContactsHeaders |
Defines headers for Spacecrafts_listAvailableContacts operation. |
| SpacecraftsListAvailableContactsNextHeaders |
Defines headers for Spacecrafts_listAvailableContactsNext operation. |
| SpacecraftsListAvailableContactsNextOptionalParams |
Optional parameters. |
| SpacecraftsListAvailableContactsOptionalParams |
Optional parameters. |
| SpacecraftsListBySubscriptionNextOptionalParams |
Optional parameters. |
| SpacecraftsListBySubscriptionOptionalParams |
Optional parameters. |
| SpacecraftsListNextOptionalParams |
Optional parameters. |
| SpacecraftsListOptionalParams |
Optional parameters. |
| SpacecraftsUpdateTagsHeaders |
Defines headers for Spacecrafts_updateTags operation. |
| SpacecraftsUpdateTagsOptionalParams |
Optional parameters. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TagsObject |
Tags object for patch operations. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
Type Aliases
| ActionType |
Defines values for ActionType. Known values supported by the serviceInternal |
| AutoTrackingConfiguration |
Defines values for AutoTrackingConfiguration. |
| AvailableGroundStationsListByCapabilityNextResponse |
Contains response data for the listByCapabilityNext operation. |
| AvailableGroundStationsListByCapabilityResponse |
Contains response data for the listByCapability operation. |
| Capability |
Defines values for Capability. Known values supported by the serviceEarthObservation |
| CapabilityParameter |
Defines values for CapabilityParameter. Known values supported by the serviceEarthObservation |
| ContactProfilesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| ContactProfilesGetResponse |
Contains response data for the get operation. |
| ContactProfilesListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| ContactProfilesListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| ContactProfilesListNextResponse |
Contains response data for the listNext operation. |
| ContactProfilesListResponse |
Contains response data for the list operation. |
| ContactProfilesPropertiesProvisioningState |
Defines values for ContactProfilesPropertiesProvisioningState. Known values supported by the servicecreating |
| ContactProfilesUpdateTagsResponse |
Contains response data for the updateTags operation. |
| ContactsCreateResponse |
Contains response data for the create operation. |
| ContactsGetResponse |
Contains response data for the get operation. |
| ContactsListNextResponse |
Contains response data for the listNext operation. |
| ContactsListResponse |
Contains response data for the list operation. |
| ContactsPropertiesProvisioningState |
Defines values for ContactsPropertiesProvisioningState. Known values supported by the servicecreating |
| ContactsStatus |
Defines values for ContactsStatus. Known values supported by the servicescheduled |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| Direction |
Defines values for Direction. Known values supported by the serviceUplink |
| OperationsListResponse |
Contains response data for the list operation. |
| OperationsResultsGetResponse |
Contains response data for the get operation. |
| Origin |
Defines values for Origin. Known values supported by the serviceuser |
| Polarization |
Defines values for Polarization. Known values supported by the serviceRHCP |
| Protocol |
Defines values for Protocol. Known values supported by the serviceTCP |
| ProvisioningState |
Defines values for ProvisioningState. Known values supported by the servicecreating |
| ReleaseMode |
Defines values for ReleaseMode. Known values supported by the servicePreview |
| SpacecraftsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| SpacecraftsGetResponse |
Contains response data for the get operation. |
| SpacecraftsListAvailableContactsNextResponse |
Contains response data for the listAvailableContactsNext operation. |
| SpacecraftsListAvailableContactsResponse |
Contains response data for the listAvailableContacts operation. |
| SpacecraftsListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| SpacecraftsListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| SpacecraftsListNextResponse |
Contains response data for the listNext operation. |
| SpacecraftsListResponse |
Contains response data for the list operation. |
| SpacecraftsPropertiesProvisioningState |
Defines values for SpacecraftsPropertiesProvisioningState. Known values supported by the servicecreating |
| SpacecraftsUpdateTagsResponse |
Contains response data for the updateTags operation. |
| Status |
Defines values for Status. Known values supported by the serviceSucceeded |
Enums
| KnownActionType |
Known values of ActionType that the service accepts. |
| KnownCapability |
Known values of Capability that the service accepts. |
| KnownCapabilityParameter |
Known values of CapabilityParameter that the service accepts. |
| KnownContactProfilesPropertiesProvisioningState |
Known values of ContactProfilesPropertiesProvisioningState that the service accepts. |
| KnownContactsPropertiesProvisioningState |
Known values of ContactsPropertiesProvisioningState that the service accepts. |
| KnownContactsStatus |
Known values of ContactsStatus that the service accepts. |
| KnownCreatedByType |
Known values of CreatedByType that the service accepts. |
| KnownDirection |
Known values of Direction that the service accepts. |
| KnownOrigin |
Known values of Origin that the service accepts. |
| KnownPolarization |
Known values of Polarization that the service accepts. |
| KnownProtocol |
Known values of Protocol that the service accepts. |
| KnownProvisioningState |
Known values of ProvisioningState that the service accepts. |
| KnownReleaseMode |
Known values of ReleaseMode that the service accepts. |
| KnownSpacecraftsPropertiesProvisioningState |
Known values of SpacecraftsPropertiesProvisioningState that the service accepts. |
| KnownStatus |
Known values of Status that the service accepts. |
Functions
| get |
Given the last |
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.