Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-orbital

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

ActionType

ActionType: string

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

AuthorizationStatus

AuthorizationStatus: "Allowed" | "Pending" | "Denied"

Defines values for AuthorizationStatus.

AutoTrackingConfiguration

AutoTrackingConfiguration: "disabled" | "xBand" | "sBand"

Defines values for AutoTrackingConfiguration.

AvailableGroundStationsGetResponse

AvailableGroundStationsGetResponse: AvailableGroundStation

Contains response data for the get operation.

AvailableGroundStationsListByCapabilityNextResponse

AvailableGroundStationsListByCapabilityNextResponse: AvailableGroundStationListResult

Contains response data for the listByCapabilityNext operation.

AvailableGroundStationsListByCapabilityResponse

AvailableGroundStationsListByCapabilityResponse: AvailableGroundStationListResult

Contains response data for the listByCapability operation.

Capability

Capability: string

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

Known values supported by the service

EarthObservation
Communication

Contact

Contact: ProxyResource & { contactProfile?: ResourceReference; endAzimuthDegrees?: undefined | number; endElevationDegrees?: undefined | number; errorMessage?: undefined | string; etag?: undefined | string; groundStationName?: undefined | string; maximumElevationDegrees?: undefined | number; reservationEndTime?: Date; reservationStartTime?: Date; rxEndTime?: Date; rxStartTime?: Date; startAzimuthDegrees?: undefined | number; startElevationDegrees?: undefined | number; status?: Status; txEndTime?: Date; txStartTime?: Date }

Customer creates a contact resource for a spacecraft resource.

ContactProfile

ContactProfile: TrackedResource & { autoTrackingConfiguration?: AutoTrackingConfiguration; etag?: undefined | string; eventHubUri?: undefined | string; links?: ContactProfileLink[]; minimumElevationDegrees?: undefined | number; minimumViableContactDuration?: undefined | string }

Customer creates a Contact Profile Resource, which will contain all of the configurations required for scheduling a contact.

ContactProfilesCreateOrUpdateResponse

ContactProfilesCreateOrUpdateResponse: ContactProfile

Contains response data for the createOrUpdate operation.

ContactProfilesGetResponse

ContactProfilesGetResponse: ContactProfile

Contains response data for the get operation.

ContactProfilesListBySubscriptionResponse

ContactProfilesListBySubscriptionResponse: ContactProfileListResult

Contains response data for the listBySubscription operation.

ContactProfilesListResponse

ContactProfilesListResponse: ContactProfileListResult

Contains response data for the list operation.

ContactProfilesUpdateTagsResponse

ContactProfilesUpdateTagsResponse: ContactProfile

Contains response data for the updateTags operation.

ContactsCreateResponse

ContactsCreateResponse: Contact

Contains response data for the create operation.

ContactsGetResponse

ContactsGetResponse: Contact

Contains response data for the get operation.

ContactsListResponse

ContactsListResponse: ContactListResult

Contains response data for the list operation.

CreatedByType

CreatedByType: string

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

Direction

Direction: string

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

Known values supported by the service

uplink
downlink

Enum6

Enum6: string

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

Known values supported by the service

EarthObservation
Communication

OperationsListResponse

OperationsListResponse: OperationListResult

Contains response data for the list operation.

Origin

Origin: string

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

Polarization

Polarization: string

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

Known values supported by the service

RHCP
LHCP
dualRhcpLhcp
linearVertical
linearHorizontal

Protocol

Protocol: string

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

Known values supported by the service

TCP
UDP

ProxyResource

ProxyResource: Resource & {}

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Spacecraft

Spacecraft: TrackedResource & { authorizationStatus?: AuthorizationStatus; authorizationStatusExtended?: undefined | string; etag?: undefined | string; links?: SpacecraftLink[]; noradId?: undefined | string; titleLine?: undefined | string; tleLine1?: undefined | string; tleLine2?: undefined | string }

Customer creates a spacecraft resource to schedule a contact.

SpacecraftsCreateOrUpdateResponse

SpacecraftsCreateOrUpdateResponse: Spacecraft

Contains response data for the createOrUpdate operation.

SpacecraftsGetResponse

SpacecraftsGetResponse: Spacecraft

Contains response data for the get operation.

SpacecraftsListAvailableContactsResponse

SpacecraftsListAvailableContactsResponse: AvailableContactsListResult

Contains response data for the listAvailableContacts operation.

SpacecraftsListBySubscriptionResponse

SpacecraftsListBySubscriptionResponse: SpacecraftListResult

Contains response data for the listBySubscription operation.

SpacecraftsListResponse

SpacecraftsListResponse: SpacecraftListResult

Contains response data for the list operation.

SpacecraftsUpdateTagsResponse

SpacecraftsUpdateTagsResponse: Spacecraft

Contains response data for the updateTags operation.

Status

Status: "scheduled" | "cancelled" | "succeeded" | "failed" | "providerCancelled"

Defines values for Status.

TrackedResource

TrackedResource: Resource & { location: string; tags?: undefined | {} }

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

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 AvailableContacts

AvailableContacts: object

type

type: object

className

className: string = "AvailableContacts"

name

name: string = "Composite"

modelProperties

modelProperties: object

endAzimuthDegrees

endAzimuthDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.endAzimuthDegrees"

type

type: object

name

name: string = "Number"

endElevationDegrees

endElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.endElevationDegrees"

type

type: object

name

name: string = "Number"

groundStationName

groundStationName: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "groundStationName"

type

type: object

name

name: string = "String"

maximumElevationDegrees

maximumElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.maximumElevationDegrees"

type

type: object

name

name: string = "Number"

rxEndTime

rxEndTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.rxEndTime"

type

type: object

name

name: string = "DateTime"

rxStartTime

rxStartTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.rxStartTime"

type

type: object

name

name: string = "DateTime"

spacecraft

spacecraft: object

serializedName

serializedName: string = "spacecraft"

type

type: object

className

className: string = "ResourceReference"

name

name: string = "Composite"

startAzimuthDegrees

startAzimuthDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.startAzimuthDegrees"

type

type: object

name

name: string = "Number"

startElevationDegrees

startElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.startElevationDegrees"

type

type: object

name

name: string = "Number"

txEndTime

txEndTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.txEndTime"

type

type: object

name

name: string = "DateTime"

txStartTime

txStartTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.txStartTime"

type

type: object

name

name: string = "DateTime"

Const AvailableContactsListResult

AvailableContactsListResult: object

type

type: object

className

className: string = "AvailableContactsListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "AvailableContacts"

name

name: string = "Composite"

Const AvailableGroundStation

AvailableGroundStation: object

type

type: object

className

className: string = "AvailableGroundStation"

name

name: string = "Composite"

modelProperties

modelProperties: object

altitudeMeters

altitudeMeters: object

serializedName

serializedName: string = "properties.altitudeMeters"

type

type: object

name

name: string = "Number"

city

city: object

serializedName

serializedName: string = "properties.city"

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"

latitudeDegrees

latitudeDegrees: object

serializedName

serializedName: string = "properties.latitudeDegrees"

type

type: object

name

name: string = "Number"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

longitudeDegrees

longitudeDegrees: object

serializedName

serializedName: string = "properties.longitudeDegrees"

type

type: object

name

name: string = "Number"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

providerName

providerName: object

serializedName

serializedName: string = "properties.providerName"

type

type: object

name

name: string = "String"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const AvailableGroundStationListResult

AvailableGroundStationListResult: object

type

type: object

className

className: string = "AvailableGroundStationListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "AvailableGroundStation"

name

name: string = "Composite"

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 = "CloudErrorBody"

name

name: string = "Composite"

Const CloudErrorBody

CloudErrorBody: object

type

type: object

className

className: string = "CloudErrorBody"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudErrorBody"

name

name: string = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

target

target: object

serializedName

serializedName: string = "target"

type

type: object

name

name: string = "String"

Const Contact

Contact: object

type

type: object

className

className: string = "Contact"

name

name: string = "Composite"

modelProperties

modelProperties: object

contactProfile

contactProfile: object

serializedName

serializedName: string = "properties.contactProfile"

type

type: object

className

className: string = "ResourceReference"

name

name: string = "Composite"

endAzimuthDegrees

endAzimuthDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.endAzimuthDegrees"

type

type: object

name

name: string = "Number"

endElevationDegrees

endElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.endElevationDegrees"

type

type: object

name

name: string = "Number"

errorMessage

errorMessage: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.errorMessage"

type

type: object

name

name: string = "String"

etag

etag: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

groundStationName

groundStationName: object

serializedName

serializedName: string = "properties.groundStationName"

type

type: object

name

name: string = "String"

maximumElevationDegrees

maximumElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.maximumElevationDegrees"

type

type: object

name

name: string = "Number"

reservationEndTime

reservationEndTime: object

serializedName

serializedName: string = "properties.reservationEndTime"

type

type: object

name

name: string = "DateTime"

reservationStartTime

reservationStartTime: object

serializedName

serializedName: string = "properties.reservationStartTime"

type

type: object

name

name: string = "DateTime"

rxEndTime

rxEndTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.rxEndTime"

type

type: object

name

name: string = "DateTime"

rxStartTime

rxStartTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.rxStartTime"

type

type: object

name

name: string = "DateTime"

startAzimuthDegrees

startAzimuthDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.startAzimuthDegrees"

type

type: object

name

name: string = "Number"

startElevationDegrees

startElevationDegrees: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.startElevationDegrees"

type

type: object

name

name: string = "Number"

status

status: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["scheduled","cancelled","succeeded","failed","providerCancelled"]

name

name: string = "Enum"

txEndTime

txEndTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.txEndTime"

type

type: object

name

name: string = "DateTime"

txStartTime

txStartTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.txStartTime"

type

type: object

name

name: string = "DateTime"

Const ContactListResult

ContactListResult: object

type

type: object

className

className: string = "ContactListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "Contact"

name

name: string = "Composite"

Const ContactParameters

ContactParameters: object

type

type: object

className

className: string = "ContactParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

contactProfile

contactProfile: object

serializedName

serializedName: string = "contactProfile"

type

type: object

className

className: string = "ResourceReference"

name

name: string = "Composite"

endTime

endTime: object

required

required: boolean = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: string = "DateTime"

groundStationName

groundStationName: object

required

required: boolean = true

serializedName

serializedName: string = "groundStationName"

type

type: object

name

name: string = "String"

startTime

startTime: object

required

required: boolean = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

Const ContactProfile

ContactProfile: object

type

type: object

className

className: string = "ContactProfile"

name

name: string = "Composite"

modelProperties

modelProperties: object

autoTrackingConfiguration

autoTrackingConfiguration: object

serializedName

serializedName: string = "properties.autoTrackingConfiguration"

type

type: object

allowedValues

allowedValues: string[] = ["disabled", "xBand", "sBand"]

name

name: string = "Enum"

etag

etag: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

eventHubUri

eventHubUri: object

serializedName

serializedName: string = "properties.eventHubUri"

type

type: object

name

name: string = "String"

links

links: object

serializedName

serializedName: string = "properties.links"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ContactProfileLink"

name

name: string = "Composite"

minimumElevationDegrees

minimumElevationDegrees: object

serializedName

serializedName: string = "properties.minimumElevationDegrees"

type

type: object

name

name: string = "Number"

minimumViableContactDuration

minimumViableContactDuration: object

serializedName

serializedName: string = "properties.minimumViableContactDuration"

type

type: object

name

name: string = "String"

Const ContactProfileLink

ContactProfileLink: object

type

type: object

className

className: string = "ContactProfileLink"

name

name: string = "Composite"

modelProperties

modelProperties: object

channels

channels: object

required

required: boolean = true

serializedName

serializedName: string = "channels"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ContactProfileLinkChannel"

name

name: string = "Composite"

direction

direction: object

required

required: boolean = true

serializedName

serializedName: string = "direction"

type

type: object

name

name: string = "String"

eirpdBW

eirpdBW: object

serializedName

serializedName: string = "eirpdBW"

type

type: object

name

name: string = "Number"

gainOverTemperature

gainOverTemperature: object

serializedName

serializedName: string = "gainOverTemperature"

type

type: object

name

name: string = "Number"

polarization

polarization: object

required

required: boolean = true

serializedName

serializedName: string = "polarization"

type

type: object

name

name: string = "String"

Const ContactProfileLinkChannel

ContactProfileLinkChannel: object

type

type: object

className

className: string = "ContactProfileLinkChannel"

name

name: string = "Composite"

modelProperties

modelProperties: object

bandwidthMHz

bandwidthMHz: object

required

required: boolean = true

serializedName

serializedName: string = "bandwidthMHz"

type

type: object

name

name: string = "Number"

centerFrequencyMHz

centerFrequencyMHz: object

required

required: boolean = true

serializedName

serializedName: string = "centerFrequencyMHz"

type

type: object

name

name: string = "Number"

decodingConfiguration

decodingConfiguration: object

serializedName

serializedName: string = "decodingConfiguration"

type

type: object

name

name: string = "String"

demodulationConfiguration

demodulationConfiguration: object

serializedName

serializedName: string = "demodulationConfiguration"

type

type: object

name

name: string = "String"

encodingConfiguration

encodingConfiguration: object

serializedName

serializedName: string = "encodingConfiguration"

type

type: object

name

name: string = "String"

endPoint

endPoint: object

serializedName

serializedName: string = "endPoint"

type

type: object

className

className: string = "EndPoint"

name

name: string = "Composite"

modulationConfiguration

modulationConfiguration: object

serializedName

serializedName: string = "modulationConfiguration"

type

type: object

name

name: string = "String"

Const ContactProfileListResult

ContactProfileListResult: object

type

type: object

className

className: string = "ContactProfileListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "ContactProfile"

name

name: string = "Composite"

Const EndPoint

EndPoint: object

type

type: object

className

className: string = "EndPoint"

name

name: string = "Composite"

modelProperties

modelProperties: object

endPointName

endPointName: object

required

required: boolean = true

serializedName

serializedName: string = "endPointName"

type

type: object

name

name: string = "String"

ipAddress

ipAddress: object

required

required: boolean = true

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: string = "String"

port

port: object

required

required: boolean = true

serializedName

serializedName: string = "port"

type

type: object

name

name: string = "String"

protocol

protocol: object

required

required: boolean = true

serializedName

serializedName: string = "protocol"

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

actionType

actionType: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "actionType"

type

type: object

name

name: string = "String"

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: string = "Composite"

isDataAction

isDataAction: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "isDataAction"

type

type: object

name

name: string = "Boolean"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

origin

origin: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "origin"

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

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

operation

operation: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "operation"

type

type: object

name

name: string = "String"

provider

provider: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "provider"

type

type: object

name

name: string = "String"

resource

resource: object

readOnly

readOnly: boolean = true

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

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: string = "String"

value

value: object

readOnly

readOnly: boolean = true

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 ProxyResource

ProxyResource: object

type

type: object

className

className: string = "ProxyResource"

name

name: string = "Composite"

modelProperties

modelProperties: object

Const Resource

Resource: object

type

type: object

className

className: string = "Resource"

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"

systemData

systemData: object

serializedName

serializedName: string = "systemData"

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

type

type: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const ResourceIdListResult

ResourceIdListResult: object

type

type: object

className

className: string = "ResourceIdListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "ResourceIdListResultValueItem"

name

name: string = "Composite"

Const ResourceIdListResultValueItem

ResourceIdListResultValueItem: object

type

type: object

className

className: string = "ResourceIdListResultValueItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const ResourceReference

ResourceReference: object

type

type: object

className

className: string = "ResourceReference"

name

name: string = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: string = "String"

Const Spacecraft

Spacecraft: object

type

type: object

className

className: string = "Spacecraft"

name

name: string = "Composite"

modelProperties

modelProperties: object

authorizationStatus

authorizationStatus: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.authorizationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Allowed", "Pending", "Denied"]

name

name: string = "Enum"

authorizationStatusExtended

authorizationStatusExtended: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.authorizationStatusExtended"

type

type: object

name

name: string = "String"

etag

etag: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "etag"

type

type: object

name

name: string = "String"

links

links: object

serializedName

serializedName: string = "properties.links"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SpacecraftLink"

name

name: string = "Composite"

noradId

noradId: object

serializedName

serializedName: string = "properties.noradId"

type

type: object

name

name: string = "String"

titleLine

titleLine: object

serializedName

serializedName: string = "properties.titleLine"

type

type: object

name

name: string = "String"

tleLine1

tleLine1: object

serializedName

serializedName: string = "properties.tleLine1"

type

type: object

name

name: string = "String"

tleLine2

tleLine2: object

serializedName

serializedName: string = "properties.tleLine2"

type

type: object

name

name: string = "String"

Const SpacecraftLink

SpacecraftLink: object

type

type: object

className

className: string = "SpacecraftLink"

name

name: string = "Composite"

modelProperties

modelProperties: object

bandwidthMHz

bandwidthMHz: object

required

required: boolean = true

serializedName

serializedName: string = "bandwidthMHz"

type

type: object

name

name: string = "Number"

centerFrequencyMHz

centerFrequencyMHz: object

required

required: boolean = true

serializedName

serializedName: string = "centerFrequencyMHz"

type

type: object

name

name: string = "Number"

direction

direction: object

required

required: boolean = true

serializedName

serializedName: string = "direction"

type

type: object

name

name: string = "String"

polarization

polarization: object

required

required: boolean = true

serializedName

serializedName: string = "polarization"

type

type: object

name

name: string = "String"

Const SpacecraftListResult

SpacecraftListResult: object

type

type: object

className

className: string = "SpacecraftListResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: 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 = "Spacecraft"

name

name: string = "Composite"

Const SystemData

SystemData: object

type

type: object

className

className: string = "SystemData"

name

name: string = "Composite"

modelProperties

modelProperties: object

createdAt

createdAt: object

serializedName

serializedName: string = "createdAt"

type

type: object

name

name: string = "DateTime"

createdBy

createdBy: object

serializedName

serializedName: string = "createdBy"

type

type: object

name

name: string = "String"

createdByType

createdByType: object

serializedName

serializedName: string = "createdByType"

type

type: object

name

name: string = "String"

lastModifiedAt

lastModifiedAt: object

serializedName

serializedName: string = "lastModifiedAt"

type

type: object

name

name: string = "DateTime"

lastModifiedBy

lastModifiedBy: object

serializedName

serializedName: string = "lastModifiedBy"

type

type: object

name

name: string = "String"

lastModifiedByType

lastModifiedByType: object

serializedName

serializedName: string = "lastModifiedByType"

type

type: object

name

name: string = "String"

Const TagsObject

TagsObject: object

type

type: object

className

className: string = "TagsObject"

name

name: string = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

Const TrackedResource

TrackedResource: object

type

type: object

className

className: string = "TrackedResource"

name

name: string = "Composite"

modelProperties

modelProperties: object

location

location: object

required

required: boolean = true

serializedName

serializedName: string = "location"

type

type: object

name

name: string = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

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-04-04-preview"

isConstant

isConstant: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const autoTrackingConfiguration

autoTrackingConfiguration: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

Const capability

capability: object

parameterPath

parameterPath: string = "capability"

mapper

mapper: object

defaultValue

defaultValue: string = "EarthObservation"

required

required: boolean = true

serializedName

serializedName: string = "capability"

type

type: object

name

name: string = "String"

Const contactName

contactName: object

parameterPath

parameterPath: string = "contactName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "contactName"

type

type: object

name

name: string = "String"

Const contactProfile

contactProfile: object

mapper

mapper: any = ContactParametersMapper

parameterPath

parameterPath: string = "contactProfile"

Const contactProfileName

contactProfileName: object

parameterPath

parameterPath: string = "contactProfileName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "contactProfileName"

type

type: object

name

name: string = "String"

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 createOperationSpec

createOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/contacts/{contactName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.parameters3

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.Contact

201

201: object

bodyMapper

bodyMapper: any = Mappers.Contact

202

202: object

bodyMapper

bodyMapper: any = Mappers.Contact

204

204: object

bodyMapper

bodyMapper: any = Mappers.Contact

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const createOrUpdateOperationSpec

createOrUpdateOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PUT"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

autoTrackingConfiguration

autoTrackingConfiguration: string[] = ["options", "autoTrackingConfiguration"]

eventHubUri

eventHubUri: string[] = ["options", "eventHubUri"]

links

links: string[] = ["options", "links"]

location

location: string[] = ["location"]

minimumElevationDegrees

minimumElevationDegrees: string[] = ["options", "minimumElevationDegrees"]

minimumViableContactDuration

minimumViableContactDuration: string[] = ["options", "minimumViableContactDuration"]

noradId

noradId: string[] = ["options", "noradId"]

tags

tags: string[] = ["options", "tags"]

titleLine

titleLine: string[] = ["options", "titleLine"]

tleLine1

tleLine1: string[] = ["options", "tleLine1"]

tleLine2

tleLine2: string[] = ["options", "tleLine2"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ContactProfile

201

201: object

bodyMapper

bodyMapper: any = Mappers.ContactProfile

202

202: object

bodyMapper

bodyMapper: any = Mappers.ContactProfile

204

204: object

bodyMapper

bodyMapper: any = Mappers.ContactProfile

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const deleteOperationSpec

deleteOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: {}

Type declaration

201

201: {}

Type declaration

202

202: {}

Type declaration

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const endTime

endTime: object

mapper

mapper: any = ContactParametersMapper

parameterPath

parameterPath: string = "endTime"

Const eventHubUri

eventHubUri: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

Const getOperationSpec

getOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations/{groundStationName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AvailableGroundStation

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const groundStationName

groundStationName: object

mapper

mapper: any = ContactParametersMapper

parameterPath

parameterPath: string = "groundStationName"

Const groundStationName1

groundStationName1: object

parameterPath

parameterPath: string = "groundStationName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "groundStationName"

type

type: object

name

name: string = "String"

Const links

links: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const links1

links1: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

Const listAvailableContactsOperationSpec

listAvailableContactsOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "POST"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/spacecrafts/{spacecraftName}/listAvailableContacts"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

requestBody

requestBody: object

mapper

mapper: object

required

required: boolean = true

parameterPath

parameterPath: object

contactProfile

contactProfile: string[] = ["contactProfile"]

endTime

endTime: string[] = ["endTime"]

groundStationName

groundStationName: string[] = ["groundStationName"]

startTime

startTime: string[] = ["startTime"]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AvailableContactsListResult

201

201: object

bodyMapper

bodyMapper: any = Mappers.AvailableContactsListResult

202

202: object

bodyMapper

bodyMapper: any = Mappers.AvailableContactsListResult

204

204: object

bodyMapper

bodyMapper: any = Mappers.AvailableContactsListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listByCapabilityNextOperationSpec

listByCapabilityNextOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "{nextLink}"

queryParameters

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

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AvailableGroundStationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listByCapabilityOperationSpec

listByCapabilityOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/availableGroundStations"

queryParameters

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

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AvailableGroundStationListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listBySubscriptionOperationSpec

listBySubscriptionOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/providers/Microsoft.Orbital/contactProfiles"

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

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const listOperationSpec

listOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.accept]

httpMethod

httpMethod: string = "GET"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ContactProfileListResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Const location

location: object

mapper

mapper: any = SpacecraftMapper

parameterPath

parameterPath: string = "location"

Const location1

location1: object

mapper

mapper: any = ContactProfileMapper

parameterPath

parameterPath: string = "location"

Const minimumElevationDegrees

minimumElevationDegrees: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

Const minimumViableContactDuration

minimumViableContactDuration: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

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 noradId

noradId: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const parameters1

parameters1: object

mapper

mapper: any = TagsObjectMapper

parameterPath

parameterPath: string = "parameters"

Const parameters3

parameters3: object

mapper

mapper: any = ContactMapper

parameterPath

parameterPath: string = "parameters"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const spacecraftName

spacecraftName: object

parameterPath

parameterPath: string = "spacecraftName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "spacecraftName"

type

type: object

name

name: string = "String"

Const startTime

startTime: object

mapper

mapper: any = ContactParametersMapper

parameterPath

parameterPath: string = "startTime"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

constraints

constraints: object

MinLength

MinLength: number = 1

type

type: object

name

name: string = "String"

Const tags

tags: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const tags1

tags1: object

mapper

mapper: any = ContactProfileMapper

parameterPath

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

Const titleLine

titleLine: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const tleLine1

tleLine1: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const tleLine2

tleLine2: object

mapper

mapper: any = SpacecraftMapper

parameterPath

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

Const updateTagsOperationSpec

updateTagsOperationSpec: object

headerParameters

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

httpMethod

httpMethod: string = "PATCH"

mediaType

mediaType: string = "json"

path

path: string = "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/contactProfiles/{contactProfileName}"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

requestBody

requestBody: any = Parameters.parameters1

serializer

serializer: any

urlParameters

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

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ContactProfile

default

default: object

bodyMapper

bodyMapper: any = Mappers.CloudError

Generated using TypeDoc