1. Packages
  2. Azure Native
  3. API Docs
  4. orbital
  5. listSpacecraftAvailableContacts
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.orbital.listSpacecraftAvailableContacts

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi

    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. Azure REST API version: 2022-11-01.

    Other available API versions: 2022-03-01.

    Using listSpacecraftAvailableContacts

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function listSpacecraftAvailableContacts(args: ListSpacecraftAvailableContactsArgs, opts?: InvokeOptions): Promise<ListSpacecraftAvailableContactsResult>
    function listSpacecraftAvailableContactsOutput(args: ListSpacecraftAvailableContactsOutputArgs, opts?: InvokeOptions): Output<ListSpacecraftAvailableContactsResult>
    def list_spacecraft_available_contacts(contact_profile: Optional[ContactParametersContactProfile] = None,
                                           end_time: Optional[str] = None,
                                           ground_station_name: Optional[str] = None,
                                           resource_group_name: Optional[str] = None,
                                           spacecraft_name: Optional[str] = None,
                                           start_time: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> ListSpacecraftAvailableContactsResult
    def list_spacecraft_available_contacts_output(contact_profile: Optional[pulumi.Input[ContactParametersContactProfileArgs]] = None,
                                           end_time: Optional[pulumi.Input[str]] = None,
                                           ground_station_name: Optional[pulumi.Input[str]] = None,
                                           resource_group_name: Optional[pulumi.Input[str]] = None,
                                           spacecraft_name: Optional[pulumi.Input[str]] = None,
                                           start_time: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[ListSpacecraftAvailableContactsResult]
    func ListSpacecraftAvailableContacts(ctx *Context, args *ListSpacecraftAvailableContactsArgs, opts ...InvokeOption) (*ListSpacecraftAvailableContactsResult, error)
    func ListSpacecraftAvailableContactsOutput(ctx *Context, args *ListSpacecraftAvailableContactsOutputArgs, opts ...InvokeOption) ListSpacecraftAvailableContactsResultOutput

    > Note: This function is named ListSpacecraftAvailableContacts in the Go SDK.

    public static class ListSpacecraftAvailableContacts 
    {
        public static Task<ListSpacecraftAvailableContactsResult> InvokeAsync(ListSpacecraftAvailableContactsArgs args, InvokeOptions? opts = null)
        public static Output<ListSpacecraftAvailableContactsResult> Invoke(ListSpacecraftAvailableContactsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<ListSpacecraftAvailableContactsResult> listSpacecraftAvailableContacts(ListSpacecraftAvailableContactsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:orbital:listSpacecraftAvailableContacts
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ContactProfile Pulumi.AzureNative.Orbital.Inputs.ContactParametersContactProfile
    The reference to the contact profile resource.
    EndTime string
    End time of a contact (ISO 8601 UTC standard).
    GroundStationName string
    Name of Azure Ground Station.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SpacecraftName string
    Spacecraft ID.
    StartTime string
    Start time of a contact (ISO 8601 UTC standard).
    ContactProfile ContactParametersContactProfile
    The reference to the contact profile resource.
    EndTime string
    End time of a contact (ISO 8601 UTC standard).
    GroundStationName string
    Name of Azure Ground Station.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SpacecraftName string
    Spacecraft ID.
    StartTime string
    Start time of a contact (ISO 8601 UTC standard).
    contactProfile ContactParametersContactProfile
    The reference to the contact profile resource.
    endTime String
    End time of a contact (ISO 8601 UTC standard).
    groundStationName String
    Name of Azure Ground Station.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    spacecraftName String
    Spacecraft ID.
    startTime String
    Start time of a contact (ISO 8601 UTC standard).
    contactProfile ContactParametersContactProfile
    The reference to the contact profile resource.
    endTime string
    End time of a contact (ISO 8601 UTC standard).
    groundStationName string
    Name of Azure Ground Station.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    spacecraftName string
    Spacecraft ID.
    startTime string
    Start time of a contact (ISO 8601 UTC standard).
    contact_profile ContactParametersContactProfile
    The reference to the contact profile resource.
    end_time str
    End time of a contact (ISO 8601 UTC standard).
    ground_station_name str
    Name of Azure Ground Station.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    spacecraft_name str
    Spacecraft ID.
    start_time str
    Start time of a contact (ISO 8601 UTC standard).
    contactProfile Property Map
    The reference to the contact profile resource.
    endTime String
    End time of a contact (ISO 8601 UTC standard).
    groundStationName String
    Name of Azure Ground Station.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    spacecraftName String
    Spacecraft ID.
    startTime String
    Start time of a contact (ISO 8601 UTC standard).

    listSpacecraftAvailableContacts Result

    The following output properties are available:

    NextLink string
    The URL to get the next set of results.
    Value List<Pulumi.AzureNative.Orbital.Outputs.AvailableContactsResponse>
    A list of available contacts.
    NextLink string
    The URL to get the next set of results.
    Value []AvailableContactsResponse
    A list of available contacts.
    nextLink String
    The URL to get the next set of results.
    value List<AvailableContactsResponse>
    A list of available contacts.
    nextLink string
    The URL to get the next set of results.
    value AvailableContactsResponse[]
    A list of available contacts.
    next_link str
    The URL to get the next set of results.
    value Sequence[AvailableContactsResponse]
    A list of available contacts.
    nextLink String
    The URL to get the next set of results.
    value List<Property Map>
    A list of available contacts.

    Supporting Types

    AvailableContactsResponse

    EndAzimuthDegrees double
    Azimuth of the antenna at the end of the contact in decimal degrees.
    EndElevationDegrees double
    Spacecraft elevation above the horizon at contact end.
    GroundStationName string
    Name of Azure Ground Station.
    MaximumElevationDegrees double
    Maximum elevation of the antenna during the contact in decimal degrees.
    RxEndTime string
    Time to lost receiving a signal (ISO 8601 UTC standard).
    RxStartTime string
    Earliest time to receive a signal (ISO 8601 UTC standard).
    StartAzimuthDegrees double
    Azimuth of the antenna at the start of the contact in decimal degrees.
    StartElevationDegrees double
    Spacecraft elevation above the horizon at contact start.
    TxEndTime string
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    TxStartTime string
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    Spacecraft Pulumi.AzureNative.Orbital.Inputs.AvailableContactsResponseSpacecraft
    The reference to the spacecraft resource.
    EndAzimuthDegrees float64
    Azimuth of the antenna at the end of the contact in decimal degrees.
    EndElevationDegrees float64
    Spacecraft elevation above the horizon at contact end.
    GroundStationName string
    Name of Azure Ground Station.
    MaximumElevationDegrees float64
    Maximum elevation of the antenna during the contact in decimal degrees.
    RxEndTime string
    Time to lost receiving a signal (ISO 8601 UTC standard).
    RxStartTime string
    Earliest time to receive a signal (ISO 8601 UTC standard).
    StartAzimuthDegrees float64
    Azimuth of the antenna at the start of the contact in decimal degrees.
    StartElevationDegrees float64
    Spacecraft elevation above the horizon at contact start.
    TxEndTime string
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    TxStartTime string
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    Spacecraft AvailableContactsResponseSpacecraft
    The reference to the spacecraft resource.
    endAzimuthDegrees Double
    Azimuth of the antenna at the end of the contact in decimal degrees.
    endElevationDegrees Double
    Spacecraft elevation above the horizon at contact end.
    groundStationName String
    Name of Azure Ground Station.
    maximumElevationDegrees Double
    Maximum elevation of the antenna during the contact in decimal degrees.
    rxEndTime String
    Time to lost receiving a signal (ISO 8601 UTC standard).
    rxStartTime String
    Earliest time to receive a signal (ISO 8601 UTC standard).
    startAzimuthDegrees Double
    Azimuth of the antenna at the start of the contact in decimal degrees.
    startElevationDegrees Double
    Spacecraft elevation above the horizon at contact start.
    txEndTime String
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    txStartTime String
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    spacecraft AvailableContactsResponseSpacecraft
    The reference to the spacecraft resource.
    endAzimuthDegrees number
    Azimuth of the antenna at the end of the contact in decimal degrees.
    endElevationDegrees number
    Spacecraft elevation above the horizon at contact end.
    groundStationName string
    Name of Azure Ground Station.
    maximumElevationDegrees number
    Maximum elevation of the antenna during the contact in decimal degrees.
    rxEndTime string
    Time to lost receiving a signal (ISO 8601 UTC standard).
    rxStartTime string
    Earliest time to receive a signal (ISO 8601 UTC standard).
    startAzimuthDegrees number
    Azimuth of the antenna at the start of the contact in decimal degrees.
    startElevationDegrees number
    Spacecraft elevation above the horizon at contact start.
    txEndTime string
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    txStartTime string
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    spacecraft AvailableContactsResponseSpacecraft
    The reference to the spacecraft resource.
    end_azimuth_degrees float
    Azimuth of the antenna at the end of the contact in decimal degrees.
    end_elevation_degrees float
    Spacecraft elevation above the horizon at contact end.
    ground_station_name str
    Name of Azure Ground Station.
    maximum_elevation_degrees float
    Maximum elevation of the antenna during the contact in decimal degrees.
    rx_end_time str
    Time to lost receiving a signal (ISO 8601 UTC standard).
    rx_start_time str
    Earliest time to receive a signal (ISO 8601 UTC standard).
    start_azimuth_degrees float
    Azimuth of the antenna at the start of the contact in decimal degrees.
    start_elevation_degrees float
    Spacecraft elevation above the horizon at contact start.
    tx_end_time str
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    tx_start_time str
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    spacecraft AvailableContactsResponseSpacecraft
    The reference to the spacecraft resource.
    endAzimuthDegrees Number
    Azimuth of the antenna at the end of the contact in decimal degrees.
    endElevationDegrees Number
    Spacecraft elevation above the horizon at contact end.
    groundStationName String
    Name of Azure Ground Station.
    maximumElevationDegrees Number
    Maximum elevation of the antenna during the contact in decimal degrees.
    rxEndTime String
    Time to lost receiving a signal (ISO 8601 UTC standard).
    rxStartTime String
    Earliest time to receive a signal (ISO 8601 UTC standard).
    startAzimuthDegrees Number
    Azimuth of the antenna at the start of the contact in decimal degrees.
    startElevationDegrees Number
    Spacecraft elevation above the horizon at contact start.
    txEndTime String
    Time at which antenna transmit will be disabled (ISO 8601 UTC standard).
    txStartTime String
    Time at which antenna transmit will be enabled (ISO 8601 UTC standard).
    spacecraft Property Map
    The reference to the spacecraft resource.

    AvailableContactsResponseSpacecraft

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    ContactParametersContactProfile

    Id string
    Resource ID.
    Id string
    Resource ID.
    id String
    Resource ID.
    id string
    Resource ID.
    id str
    Resource ID.
    id String
    Resource ID.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.30.0 published on Friday, Feb 23, 2024 by Pulumi