Spacecrafts | @azure/arm-orbital

Interface representing a Spacecrafts.

Hierarchy

Spacecrafts

Implemented by

SpacecraftsImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, spacecraftName: string, location: string, options?: SpacecraftsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SpacecraftsCreateOrUpdateResponse>, SpacecraftsCreateOrUpdateResponse>>

- Defined in operationsInterfaces/spacecrafts.ts:65
Creates or updates a spacecraft resource

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
- Optional options: SpacecraftsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SpacecraftsCreateOrUpdateResponse>, SpacecraftsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, spacecraftName: string, location: string, options?: SpacecraftsCreateOrUpdateOptionalParams): Promise<SpacecraftsCreateOrUpdateResponse>

- Defined in operationsInterfaces/spacecrafts.ts:83
Creates or updates a spacecraft resource

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
- Optional options: SpacecraftsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SpacecraftsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

- Defined in operationsInterfaces/spacecrafts.ts:95
Deletes a specified spacecraft resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- spacecraftName: string
  
  Spacecraft ID
- Optional options: SpacecraftsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/spacecrafts.ts:106
Deletes a specified spacecraft resource.

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- spacecraftName: string
  
  Spacecraft ID
- Optional options: SpacecraftsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginListAvailableContacts

beginListAvailableContacts(resourceGroupName: string, spacecraftName: string, contactProfile: ResourceReference, groundStationName: string, startTime: Date, endTime: Date, options?: SpacecraftsListAvailableContactsOptionalParams): Promise<PollerLike<PollOperationState<SpacecraftsListAvailableContactsResponse>, SpacecraftsListAvailableContactsResponse>>

- Defined in operationsInterfaces/spacecrafts.ts:134
Return list of available contacts

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- spacecraftName: string
  
  Spacecraft ID
- contactProfile: ResourceReference
  
  The reference to the contact profile resource.
- groundStationName: string
  
  Name of Azure Ground Station.
- startTime: Date
  
  Start time of a contact.
- endTime: Date
  
  End time of a contact.
- Optional options: SpacecraftsListAvailableContactsOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SpacecraftsListAvailableContactsResponse>, SpacecraftsListAvailableContactsResponse>>

beginListAvailableContactsAndWait

beginListAvailableContactsAndWait(resourceGroupName: string, spacecraftName: string, contactProfile: ResourceReference, groundStationName: string, startTime: Date, endTime: Date, options?: SpacecraftsListAvailableContactsOptionalParams): Promise<SpacecraftsListAvailableContactsResponse>

- Defined in operationsInterfaces/spacecrafts.ts:158
Return list of available contacts

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- spacecraftName: string
  
  Spacecraft ID
- contactProfile: ResourceReference
  
  The reference to the contact profile resource.
- groundStationName: string
  
  Name of Azure Ground Station.
- startTime: Date
  
  Start time of a contact.
- endTime: Date
  
  End time of a contact.
- Optional options: SpacecraftsListAvailableContactsOptionalParams
  
  The options parameters.
Returns Promise<SpacecraftsListAvailableContactsResponse>

get

get(resourceGroupName: string, spacecraftName: string, options?: SpacecraftsGetOptionalParams): Promise<SpacecraftsGetResponse>

- Defined in operationsInterfaces/spacecrafts.ts:53
Gets the specified spacecraft in a specified resource group

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- spacecraftName: string
  
  Spacecraft ID
- Optional options: SpacecraftsGetOptionalParams
  
  The options parameters.
Returns Promise<SpacecraftsGetResponse>

list

list(resourceGroupName: string, options?: SpacecraftsListOptionalParams): PagedAsyncIterableIterator<Spacecraft>

- Defined in operationsInterfaces/spacecrafts.ts:43
Return list of spacecrafts

Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- Optional options: SpacecraftsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Spacecraft>

listBySubscription

listBySubscription(options?: SpacecraftsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Spacecraft>

- Defined in operationsInterfaces/spacecrafts.ts:35
Return list of spacecrafts

Parameters
- Optional options: SpacecraftsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Spacecraft>

updateTags

updateTags(resourceGroupName: string, spacecraftName: string, parameters: TagsObject, options?: SpacecraftsUpdateTagsOptionalParams): Promise<SpacecraftsUpdateTagsResponse>

- Defined in operationsInterfaces/spacecrafts.ts:118
Updates the specified spacecraft tags.

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.
- Optional options: SpacecraftsUpdateTagsOptionalParams
  
  The options parameters.
Returns Promise<SpacecraftsUpdateTagsResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

spacecraftName: string

location: string

Optional options: SpacecraftsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SpacecraftsCreateOrUpdateResponse>, SpacecraftsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

spacecraftName: string

location: string

Optional options: SpacecraftsCreateOrUpdateOptionalParams

Returns Promise<SpacecraftsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

spacecraftName: string

Optional options: SpacecraftsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

spacecraftName: string

Optional options: SpacecraftsDeleteOptionalParams

Returns Promise<void>

beginListAvailableContacts

Parameters

resourceGroupName: string

spacecraftName: string

contactProfile: ResourceReference

groundStationName: string

startTime: Date

endTime: Date

Optional options: SpacecraftsListAvailableContactsOptionalParams

Returns Promise<PollerLike<PollOperationState<SpacecraftsListAvailableContactsResponse>, SpacecraftsListAvailableContactsResponse>>

beginListAvailableContactsAndWait

Parameters

resourceGroupName: string

spacecraftName: string

contactProfile: ResourceReference

groundStationName: string

startTime: Date

endTime: Date

Optional options: SpacecraftsListAvailableContactsOptionalParams

Returns Promise<SpacecraftsListAvailableContactsResponse>

get

Parameters

resourceGroupName: string

spacecraftName: string

Optional options: SpacecraftsGetOptionalParams

Returns Promise<SpacecraftsGetResponse>

list

Parameters

resourceGroupName: string

Optional options: SpacecraftsListOptionalParams

Returns PagedAsyncIterableIterator<Spacecraft>

listBySubscription

Parameters

Optional options: SpacecraftsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<Spacecraft>

updateTags

Parameters

resourceGroupName: string

spacecraftName: string

parameters: TagsObject

Optional options: SpacecraftsUpdateTagsOptionalParams

Returns Promise<SpacecraftsUpdateTagsResponse>