Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. orbital
  5. getContact
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.orbital.getContact

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified contact in a specified resource group. Azure REST API version: 2022-11-01.

Other available API versions: 2022-03-01.

Using getContact

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 getContact(args: GetContactArgs, opts?: InvokeOptions): Promise<GetContactResult>
function getContactOutput(args: GetContactOutputArgs, opts?: InvokeOptions): Output<GetContactResult>
Copy
def get_contact(contact_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                spacecraft_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetContactResult
def get_contact_output(contact_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                spacecraft_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetContactResult]
Copy
func LookupContact(ctx *Context, args *LookupContactArgs, opts ...InvokeOption) (*LookupContactResult, error)
func LookupContactOutput(ctx *Context, args *LookupContactOutputArgs, opts ...InvokeOption) LookupContactResultOutput
Copy

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

public static class GetContact 
{
    public static Task<GetContactResult> InvokeAsync(GetContactArgs args, InvokeOptions? opts = null)
    public static Output<GetContactResult> Invoke(GetContactInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetContactResult> getContact(GetContactArgs args, InvokeOptions options)
public static Output<GetContactResult> getContact(GetContactArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:orbital:getContact
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ContactName
This property is required.
Changes to this property will trigger replacement.
string
Contact name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SpacecraftName
This property is required.
Changes to this property will trigger replacement.
string
Spacecraft ID.
ContactName
This property is required.
Changes to this property will trigger replacement.
string
Contact name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SpacecraftName
This property is required.
Changes to this property will trigger replacement.
string
Spacecraft ID.
contactName
This property is required.
Changes to this property will trigger replacement.
String
Contact name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
spacecraftName
This property is required.
Changes to this property will trigger replacement.
String
Spacecraft ID.
contactName
This property is required.
Changes to this property will trigger replacement.
string
Contact name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
spacecraftName
This property is required.
Changes to this property will trigger replacement.
string
Spacecraft ID.
contact_name
This property is required.
Changes to this property will trigger replacement.
str
Contact name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
spacecraft_name
This property is required.
Changes to this property will trigger replacement.
str
Spacecraft ID.
contactName
This property is required.
Changes to this property will trigger replacement.
String
Contact name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
spacecraftName
This property is required.
Changes to this property will trigger replacement.
String
Spacecraft ID.

getContact Result

The following output properties are available:

AntennaConfiguration Pulumi.AzureNative.Orbital.Outputs.ContactsPropertiesResponseAntennaConfiguration
The configuration associated with the allocated antenna.
ContactProfile Pulumi.AzureNative.Orbital.Outputs.ContactsPropertiesResponseContactProfile
The reference to the contact profile 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.
ErrorMessage string
Any error message while scheduling a contact.
GroundStationName string
Azure Ground Station name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
MaximumElevationDegrees double
Maximum elevation of the antenna during the contact in decimal degrees.
Name string
The name of the resource
ReservationEndTime string
Reservation end time of a contact (ISO 8601 UTC standard).
ReservationStartTime string
Reservation start time of a contact (ISO 8601 UTC standard).
RxEndTime string
Receive end time of a contact (ISO 8601 UTC standard).
RxStartTime string
Receive start time of a contact (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.
Status string
Status of a contact.
SystemData Pulumi.AzureNative.Orbital.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TxEndTime string
Transmit end time of a contact (ISO 8601 UTC standard).
TxStartTime string
Transmit start time of a contact (ISO 8601 UTC standard).
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AntennaConfiguration ContactsPropertiesResponseAntennaConfiguration
The configuration associated with the allocated antenna.
ContactProfile ContactsPropertiesResponseContactProfile
The reference to the contact profile 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.
ErrorMessage string
Any error message while scheduling a contact.
GroundStationName string
Azure Ground Station name.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
MaximumElevationDegrees float64
Maximum elevation of the antenna during the contact in decimal degrees.
Name string
The name of the resource
ReservationEndTime string
Reservation end time of a contact (ISO 8601 UTC standard).
ReservationStartTime string
Reservation start time of a contact (ISO 8601 UTC standard).
RxEndTime string
Receive end time of a contact (ISO 8601 UTC standard).
RxStartTime string
Receive start time of a contact (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.
Status string
Status of a contact.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
TxEndTime string
Transmit end time of a contact (ISO 8601 UTC standard).
TxStartTime string
Transmit start time of a contact (ISO 8601 UTC standard).
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
antennaConfiguration ContactsPropertiesResponseAntennaConfiguration
The configuration associated with the allocated antenna.
contactProfile ContactsPropertiesResponseContactProfile
The reference to the contact profile 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.
errorMessage String
Any error message while scheduling a contact.
groundStationName String
Azure Ground Station name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
maximumElevationDegrees Double
Maximum elevation of the antenna during the contact in decimal degrees.
name String
The name of the resource
reservationEndTime String
Reservation end time of a contact (ISO 8601 UTC standard).
reservationStartTime String
Reservation start time of a contact (ISO 8601 UTC standard).
rxEndTime String
Receive end time of a contact (ISO 8601 UTC standard).
rxStartTime String
Receive start time of a contact (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.
status String
Status of a contact.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
txEndTime String
Transmit end time of a contact (ISO 8601 UTC standard).
txStartTime String
Transmit start time of a contact (ISO 8601 UTC standard).
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
antennaConfiguration ContactsPropertiesResponseAntennaConfiguration
The configuration associated with the allocated antenna.
contactProfile ContactsPropertiesResponseContactProfile
The reference to the contact profile 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.
errorMessage string
Any error message while scheduling a contact.
groundStationName string
Azure Ground Station name.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
maximumElevationDegrees number
Maximum elevation of the antenna during the contact in decimal degrees.
name string
The name of the resource
reservationEndTime string
Reservation end time of a contact (ISO 8601 UTC standard).
reservationStartTime string
Reservation start time of a contact (ISO 8601 UTC standard).
rxEndTime string
Receive end time of a contact (ISO 8601 UTC standard).
rxStartTime string
Receive start time of a contact (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.
status string
Status of a contact.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
txEndTime string
Transmit end time of a contact (ISO 8601 UTC standard).
txStartTime string
Transmit start time of a contact (ISO 8601 UTC standard).
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
antenna_configuration ContactsPropertiesResponseAntennaConfiguration
The configuration associated with the allocated antenna.
contact_profile ContactsPropertiesResponseContactProfile
The reference to the contact profile 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.
error_message str
Any error message while scheduling a contact.
ground_station_name str
Azure Ground Station name.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
maximum_elevation_degrees float
Maximum elevation of the antenna during the contact in decimal degrees.
name str
The name of the resource
reservation_end_time str
Reservation end time of a contact (ISO 8601 UTC standard).
reservation_start_time str
Reservation start time of a contact (ISO 8601 UTC standard).
rx_end_time str
Receive end time of a contact (ISO 8601 UTC standard).
rx_start_time str
Receive start time of a contact (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.
status str
Status of a contact.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
tx_end_time str
Transmit end time of a contact (ISO 8601 UTC standard).
tx_start_time str
Transmit start time of a contact (ISO 8601 UTC standard).
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
antennaConfiguration Property Map
The configuration associated with the allocated antenna.
contactProfile Property Map
The reference to the contact profile 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.
errorMessage String
Any error message while scheduling a contact.
groundStationName String
Azure Ground Station name.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
maximumElevationDegrees Number
Maximum elevation of the antenna during the contact in decimal degrees.
name String
The name of the resource
reservationEndTime String
Reservation end time of a contact (ISO 8601 UTC standard).
reservationStartTime String
Reservation start time of a contact (ISO 8601 UTC standard).
rxEndTime String
Receive end time of a contact (ISO 8601 UTC standard).
rxStartTime String
Receive start time of a contact (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.
status String
Status of a contact.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
txEndTime String
Transmit end time of a contact (ISO 8601 UTC standard).
txStartTime String
Transmit start time of a contact (ISO 8601 UTC standard).
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

ContactsPropertiesResponseAntennaConfiguration

DestinationIp string
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
SourceIps List<string>
List of Source IP
DestinationIp string
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
SourceIps []string
List of Source IP
destinationIp String
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
sourceIps List<String>
List of Source IP
destinationIp string
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
sourceIps string[]
List of Source IP
destination_ip str
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
source_ips Sequence[str]
List of Source IP
destinationIp String
The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to.
sourceIps List<String>
List of Source IP

ContactsPropertiesResponseContactProfile

Id This property is required. string
Resource ID.
Id This property is required. string
Resource ID.
id This property is required. String
Resource ID.
id This property is required. string
Resource ID.
id This property is required. str
Resource ID.
id This property is required. String
Resource ID.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native