Contact interface

Package:

@azure/arm-orbital

Customer creates a contact resource for a spacecraft resource.

Extends

ProxyResource

Properties

antennaConfiguration	The configuration associated with the allocated antenna. NOTE: This property will not be serialized. It can only be populated by the server.
contactProfile	The reference to the contact profile resource.
endAzimuthDegrees	Azimuth of the antenna at the end of the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.
endElevationDegrees	Spacecraft elevation above the horizon at contact end. NOTE: This property will not be serialized. It can only be populated by the server.
errorMessage	Any error message while scheduling a contact. NOTE: This property will not be serialized. It can only be populated by the server.
groundStationName	Azure Ground Station name.
maximumElevationDegrees	Maximum elevation of the antenna during the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState	The current state of the resource's creation, deletion, or modification.
reservationEndTime	Reservation end time of a contact (ISO 8601 UTC standard).
reservationStartTime	Reservation start time of a contact (ISO 8601 UTC standard).
rxEndTime	Receive end time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.
rxStartTime	Receive start time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.
startAzimuthDegrees	Azimuth of the antenna at the start of the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.
startElevationDegrees	Spacecraft elevation above the horizon at contact start. NOTE: This property will not be serialized. It can only be populated by the server.
status	Status of a contact. NOTE: This property will not be serialized. It can only be populated by the server.
txEndTime	Transmit end time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.
txStartTime	Transmit start time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

antennaConfiguration

The configuration associated with the allocated antenna. NOTE: This property will not be serialized. It can only be populated by the server.

antennaConfiguration?: ContactsPropertiesAntennaConfiguration

Property Value

ContactsPropertiesAntennaConfiguration

contactProfile

The reference to the contact profile resource.

contactProfile: ContactsPropertiesContactProfile

Property Value

ContactsPropertiesContactProfile

endAzimuthDegrees

Azimuth of the antenna at the end of the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.

endAzimuthDegrees?: number

Property Value

number

endElevationDegrees

Spacecraft elevation above the horizon at contact end. NOTE: This property will not be serialized. It can only be populated by the server.

endElevationDegrees?: number

Property Value

number

errorMessage

Any error message while scheduling a contact. NOTE: This property will not be serialized. It can only be populated by the server.

errorMessage?: string

Property Value

string

groundStationName

Azure Ground Station name.

groundStationName: string

Property Value

string

maximumElevationDegrees

Maximum elevation of the antenna during the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.

maximumElevationDegrees?: number

Property Value

number

provisioningState

The current state of the resource's creation, deletion, or modification.

provisioningState?: string

Property Value

string

reservationEndTime

Reservation end time of a contact (ISO 8601 UTC standard).

reservationEndTime: Date

Property Value

Date

reservationStartTime

Reservation start time of a contact (ISO 8601 UTC standard).

reservationStartTime: Date

Property Value

Date

rxEndTime

Receive end time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.

rxEndTime?: Date

Property Value

Date

rxStartTime

Receive start time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.

rxStartTime?: Date

Property Value

Date

startAzimuthDegrees

Azimuth of the antenna at the start of the contact in decimal degrees. NOTE: This property will not be serialized. It can only be populated by the server.

startAzimuthDegrees?: number

Property Value

number

startElevationDegrees

Spacecraft elevation above the horizon at contact start. NOTE: This property will not be serialized. It can only be populated by the server.

startElevationDegrees?: number

Property Value

number

status

Status of a contact. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

txEndTime

Transmit end time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.

txEndTime?: Date

Property Value

Date

txStartTime

Transmit start time of a contact (ISO 8601 UTC standard). NOTE: This property will not be serialized. It can only be populated by the server.

txStartTime?: Date

Property Value

Date

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type