Spacecrafts interface
Interface representing a Spacecrafts.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, string, string, SpacecraftLink[], SpacecraftsCreateOrUpdateOptionalParams)
Creates or updates a spacecraft resource.
function beginCreateOrUpdate(resourceGroupName: string, spacecraftName: string, location: string, titleLine: string, tleLine1: string, tleLine2: string, links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Spacecraft>, Spacecraft>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- location
-
string
The geo-location where the resource lives
- titleLine
-
string
Title line of the two-line element set (TLE).
- tleLine1
-
string
Line 1 of the two-line element set (TLE).
- tleLine2
-
string
Line 2 of the two-line element set (TLE).
- links
Immutable list of Spacecraft links.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Spacecraft>, Spacecraft>>
beginCreateOrUpdateAndWait(string, string, string, string, string, string, SpacecraftLink[], SpacecraftsCreateOrUpdateOptionalParams)
Creates or updates a spacecraft resource.
function beginCreateOrUpdateAndWait(resourceGroupName: string, spacecraftName: string, location: string, titleLine: string, tleLine1: string, tleLine2: string, links: SpacecraftLink[], options?: SpacecraftsCreateOrUpdateOptionalParams): Promise<Spacecraft>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- location
-
string
The geo-location where the resource lives
- titleLine
-
string
Title line of the two-line element set (TLE).
- tleLine1
-
string
Line 1 of the two-line element set (TLE).
- tleLine2
-
string
Line 2 of the two-line element set (TLE).
- links
Immutable list of Spacecraft links.
The options parameters.
Returns
Promise<Spacecraft>
beginDelete(string, string, SpacecraftsDeleteOptionalParams)
Deletes a specified spacecraft resource.
function beginDelete(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- options
- SpacecraftsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, SpacecraftsDeleteOptionalParams)
Deletes a specified spacecraft resource.
function beginDeleteAndWait(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- options
- SpacecraftsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginListAvailableContactsAndWait(string, string, ContactParametersContactProfile, string, Date, Date, SpacecraftsListAvailableContactsOptionalParams)
Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station for more than the minimum viable contact duration provided in the contact profile.
function beginListAvailableContactsAndWait(resourceGroupName: string, spacecraftName: string, contactProfile: ContactParametersContactProfile, groundStationName: string, startTime: Date, endTime: Date, options?: SpacecraftsListAvailableContactsOptionalParams): PagedAsyncIterableIterator<AvailableContacts, AvailableContacts[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- contactProfile
- ContactParametersContactProfile
The reference to the contact profile resource.
- groundStationName
-
string
Name of Azure Ground Station.
- startTime
-
Date
Start time of a contact (ISO 8601 UTC standard).
- endTime
-
Date
End time of a contact (ISO 8601 UTC standard).
The options parameters.
Returns
beginUpdateTags(string, string, TagsObject, SpacecraftsUpdateTagsOptionalParams)
Updates the specified spacecraft tags.
function beginUpdateTags(resourceGroupName: string, spacecraftName: string, parameters: TagsObject, options?: SpacecraftsUpdateTagsOptionalParams): Promise<SimplePollerLike<OperationState<Spacecraft>, Spacecraft>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- parameters
- TagsObject
Parameters supplied to update spacecraft tags.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Spacecraft>, Spacecraft>>
beginUpdateTagsAndWait(string, string, TagsObject, SpacecraftsUpdateTagsOptionalParams)
Updates the specified spacecraft tags.
function beginUpdateTagsAndWait(resourceGroupName: string, spacecraftName: string, parameters: TagsObject, options?: SpacecraftsUpdateTagsOptionalParams): Promise<Spacecraft>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- parameters
- TagsObject
Parameters supplied to update spacecraft tags.
The options parameters.
Returns
Promise<Spacecraft>
get(string, string, SpacecraftsGetOptionalParams)
Gets the specified spacecraft in a specified resource group.
function get(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsGetOptionalParams): Promise<Spacecraft>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- spacecraftName
-
string
Spacecraft ID.
- options
- SpacecraftsGetOptionalParams
The options parameters.
Returns
Promise<Spacecraft>
list(string, SpacecraftsListOptionalParams)
Returns list of spacecrafts by resource group.
function list(resourceGroupName: string, options?: SpacecraftsListOptionalParams): PagedAsyncIterableIterator<Spacecraft, Spacecraft[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- options
- SpacecraftsListOptionalParams
The options parameters.
Returns
listBySubscription(SpacecraftsListBySubscriptionOptionalParams)
Returns list of spacecrafts by subscription.
function listBySubscription(options?: SpacecraftsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Spacecraft, Spacecraft[], PageSettings>Parameters
The options parameters.