Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. orbital
  5. GroundStation
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.orbital.GroundStation

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Ground Station contains one or more antennas.

Uses Azure REST API version 2024-03-01-preview. In version 2.x of the Azure Native provider, it used API version 2024-03-01-preview.

Other available API versions: 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native orbital [ApiVersion]. See the version guide for details.

Example Usage

Create a ground station

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var groundStation = new AzureNative.Orbital.GroundStation("groundStation", new()
    {
        AltitudeMeters = 1500.83,
        Capabilities = new[]
        {
            AzureNative.Orbital.Capability.Communication,
        },
        City = "redmond",
        GlobalCommunicationsSite = new AzureNative.Orbital.Inputs.GroundStationsPropertiesGlobalCommunicationsSiteArgs
        {
            Id = "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
        },
        GroundStationName = "westus_gs1",
        LatitudeDegrees = -122.122,
        Location = "westus",
        LongitudeDegrees = 47.674,
        ProviderName = "Microsoft",
        ResourceGroupName = "rg1",
        Tags = 
        {
            { "key1", "value1" },
            { "key2", "value2" },
        },
    });

});
Copy
package main

import (
	orbital "github.com/pulumi/pulumi-azure-native-sdk/orbital/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := orbital.NewGroundStation(ctx, "groundStation", &orbital.GroundStationArgs{
			AltitudeMeters: pulumi.Float64(1500.83),
			Capabilities: pulumi.StringArray{
				pulumi.String(orbital.CapabilityCommunication),
			},
			City: pulumi.String("redmond"),
			GlobalCommunicationsSite: &orbital.GroundStationsPropertiesGlobalCommunicationsSiteArgs{
				Id: pulumi.String("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon"),
			},
			GroundStationName: pulumi.String("westus_gs1"),
			LatitudeDegrees:   pulumi.Float64(-122.122),
			Location:          pulumi.String("westus"),
			LongitudeDegrees:  pulumi.Float64(47.674),
			ProviderName:      pulumi.String("Microsoft"),
			ResourceGroupName: pulumi.String("rg1"),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("value1"),
				"key2": pulumi.String("value2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.orbital.GroundStation;
import com.pulumi.azurenative.orbital.GroundStationArgs;
import com.pulumi.azurenative.orbital.inputs.GroundStationsPropertiesGlobalCommunicationsSiteArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var groundStation = new GroundStation("groundStation", GroundStationArgs.builder()
            .altitudeMeters(1500.83)
            .capabilities("Communication")
            .city("redmond")
            .globalCommunicationsSite(GroundStationsPropertiesGlobalCommunicationsSiteArgs.builder()
                .id("/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon")
                .build())
            .groundStationName("westus_gs1")
            .latitudeDegrees(-122.122)
            .location("westus")
            .longitudeDegrees(47.674)
            .providerName("Microsoft")
            .resourceGroupName("rg1")
            .tags(Map.ofEntries(
                Map.entry("key1", "value1"),
                Map.entry("key2", "value2")
            ))
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const groundStation = new azure_native.orbital.GroundStation("groundStation", {
    altitudeMeters: 1500.83,
    capabilities: [azure_native.orbital.Capability.Communication],
    city: "redmond",
    globalCommunicationsSite: {
        id: "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
    },
    groundStationName: "westus_gs1",
    latitudeDegrees: -122.122,
    location: "westus",
    longitudeDegrees: 47.674,
    providerName: "Microsoft",
    resourceGroupName: "rg1",
    tags: {
        key1: "value1",
        key2: "value2",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

ground_station = azure_native.orbital.GroundStation("groundStation",
    altitude_meters=1500.83,
    capabilities=[azure_native.orbital.Capability.COMMUNICATION],
    city="redmond",
    global_communications_site={
        "id": "/subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon",
    },
    ground_station_name="westus_gs1",
    latitude_degrees=-122.122,
    location="westus",
    longitude_degrees=47.674,
    provider_name="Microsoft",
    resource_group_name="rg1",
    tags={
        "key1": "value1",
        "key2": "value2",
    })
Copy
resources:
  groundStation:
    type: azure-native:orbital:GroundStation
    properties:
      altitudeMeters: 1500.83
      capabilities:
        - Communication
      city: redmond
      globalCommunicationsSite:
        id: /subscriptions/c1be1141-a7c9-4aac-9608-3c2e2f1152c3/providers/Microsoft.Orbital/globalCommunicationsSites/contoso-Vernon
      groundStationName: westus_gs1
      latitudeDegrees: -122.122
      location: westus
      longitudeDegrees: 47.674
      providerName: Microsoft
      resourceGroupName: rg1
      tags:
        key1: value1
        key2: value2
Copy

Create GroundStation Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GroundStation(name: string, args: GroundStationArgs, opts?: CustomResourceOptions);
@overload
def GroundStation(resource_name: str,
                  args: GroundStationArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GroundStation(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  capabilities: Optional[Sequence[Union[str, Capability]]] = None,
                  global_communications_site: Optional[GroundStationsPropertiesGlobalCommunicationsSiteArgs] = None,
                  resource_group_name: Optional[str] = None,
                  altitude_meters: Optional[float] = None,
                  city: Optional[str] = None,
                  ground_station_name: Optional[str] = None,
                  latitude_degrees: Optional[float] = None,
                  location: Optional[str] = None,
                  longitude_degrees: Optional[float] = None,
                  provider_name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewGroundStation(ctx *Context, name string, args GroundStationArgs, opts ...ResourceOption) (*GroundStation, error)
public GroundStation(string name, GroundStationArgs args, CustomResourceOptions? opts = null)
public GroundStation(String name, GroundStationArgs args)
public GroundStation(String name, GroundStationArgs args, CustomResourceOptions options)

type: azure-native:orbital:GroundStation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GroundStationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GroundStationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GroundStationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GroundStationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroundStationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var groundStationResource = new AzureNative.Orbital.GroundStation("groundStationResource", new()
{
    Capabilities = new[]
    {
        "string",
    },
    GlobalCommunicationsSite = new AzureNative.Orbital.Inputs.GroundStationsPropertiesGlobalCommunicationsSiteArgs
    {
        Id = "string",
    },
    ResourceGroupName = "string",
    AltitudeMeters = 0,
    City = "string",
    GroundStationName = "string",
    LatitudeDegrees = 0,
    Location = "string",
    LongitudeDegrees = 0,
    ProviderName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := orbital.NewGroundStation(ctx, "groundStationResource", &orbital.GroundStationArgs{
	Capabilities: pulumi.StringArray{
		pulumi.String("string"),
	},
	GlobalCommunicationsSite: &orbital.GroundStationsPropertiesGlobalCommunicationsSiteArgs{
		Id: pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	AltitudeMeters:    pulumi.Float64(0),
	City:              pulumi.String("string"),
	GroundStationName: pulumi.String("string"),
	LatitudeDegrees:   pulumi.Float64(0),
	Location:          pulumi.String("string"),
	LongitudeDegrees:  pulumi.Float64(0),
	ProviderName:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var groundStationResource = new GroundStation("groundStationResource", GroundStationArgs.builder()
    .capabilities("string")
    .globalCommunicationsSite(GroundStationsPropertiesGlobalCommunicationsSiteArgs.builder()
        .id("string")
        .build())
    .resourceGroupName("string")
    .altitudeMeters(0)
    .city("string")
    .groundStationName("string")
    .latitudeDegrees(0)
    .location("string")
    .longitudeDegrees(0)
    .providerName("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
ground_station_resource = azure_native.orbital.GroundStation("groundStationResource",
    capabilities=["string"],
    global_communications_site={
        "id": "string",
    },
    resource_group_name="string",
    altitude_meters=0,
    city="string",
    ground_station_name="string",
    latitude_degrees=0,
    location="string",
    longitude_degrees=0,
    provider_name="string",
    tags={
        "string": "string",
    })
Copy
const groundStationResource = new azure_native.orbital.GroundStation("groundStationResource", {
    capabilities: ["string"],
    globalCommunicationsSite: {
        id: "string",
    },
    resourceGroupName: "string",
    altitudeMeters: 0,
    city: "string",
    groundStationName: "string",
    latitudeDegrees: 0,
    location: "string",
    longitudeDegrees: 0,
    providerName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:orbital:GroundStation
properties:
    altitudeMeters: 0
    capabilities:
        - string
    city: string
    globalCommunicationsSite:
        id: string
    groundStationName: string
    latitudeDegrees: 0
    location: string
    longitudeDegrees: 0
    providerName: string
    resourceGroupName: string
    tags:
        string: string
Copy

GroundStation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GroundStation resource accepts the following input properties:

Capabilities This property is required. List<Union<string, Pulumi.AzureNative.Orbital.Capability>>
Ground station capabilities.
GlobalCommunicationsSite This property is required. Pulumi.AzureNative.Orbital.Inputs.GroundStationsPropertiesGlobalCommunicationsSite
A reference to global communications site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AltitudeMeters double
Altitude of the ground station.
City string
City of ground station.
GroundStationName Changes to this property will trigger replacement. string
Ground Station name.
LatitudeDegrees double
Latitude of the ground station in decimal degrees.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
LongitudeDegrees double
Longitude of the ground station in decimal degrees.
ProviderName string
Ground station provider name.
Tags Dictionary<string, string>
Resource tags.
Capabilities This property is required. []string
Ground station capabilities.
GlobalCommunicationsSite This property is required. GroundStationsPropertiesGlobalCommunicationsSiteArgs
A reference to global communications site.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AltitudeMeters float64
Altitude of the ground station.
City string
City of ground station.
GroundStationName Changes to this property will trigger replacement. string
Ground Station name.
LatitudeDegrees float64
Latitude of the ground station in decimal degrees.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
LongitudeDegrees float64
Longitude of the ground station in decimal degrees.
ProviderName string
Ground station provider name.
Tags map[string]string
Resource tags.
capabilities This property is required. List<Either<String,Capability>>
Ground station capabilities.
globalCommunicationsSite This property is required. GroundStationsPropertiesGlobalCommunicationsSite
A reference to global communications site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
altitudeMeters Double
Altitude of the ground station.
city String
City of ground station.
groundStationName Changes to this property will trigger replacement. String
Ground Station name.
latitudeDegrees Double
Latitude of the ground station in decimal degrees.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
longitudeDegrees Double
Longitude of the ground station in decimal degrees.
providerName String
Ground station provider name.
tags Map<String,String>
Resource tags.
capabilities This property is required. (string | Capability)[]
Ground station capabilities.
globalCommunicationsSite This property is required. GroundStationsPropertiesGlobalCommunicationsSite
A reference to global communications site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
altitudeMeters number
Altitude of the ground station.
city string
City of ground station.
groundStationName Changes to this property will trigger replacement. string
Ground Station name.
latitudeDegrees number
Latitude of the ground station in decimal degrees.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
longitudeDegrees number
Longitude of the ground station in decimal degrees.
providerName string
Ground station provider name.
tags {[key: string]: string}
Resource tags.
capabilities This property is required. Sequence[Union[str, Capability]]
Ground station capabilities.
global_communications_site This property is required. GroundStationsPropertiesGlobalCommunicationsSiteArgs
A reference to global communications site.
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.
altitude_meters float
Altitude of the ground station.
city str
City of ground station.
ground_station_name Changes to this property will trigger replacement. str
Ground Station name.
latitude_degrees float
Latitude of the ground station in decimal degrees.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
longitude_degrees float
Longitude of the ground station in decimal degrees.
provider_name str
Ground station provider name.
tags Mapping[str, str]
Resource tags.
capabilities This property is required. List<String | "EarthObservation" | "Communication">
Ground station capabilities.
globalCommunicationsSite This property is required. Property Map
A reference to global communications site.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
altitudeMeters Number
Altitude of the ground station.
city String
City of ground station.
groundStationName Changes to this property will trigger replacement. String
Ground Station name.
latitudeDegrees Number
Latitude of the ground station in decimal degrees.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
longitudeDegrees Number
Longitude of the ground station in decimal degrees.
providerName String
Ground station provider name.
tags Map<String>
Resource tags.

Outputs

All input properties are implicitly available as output properties. Additionally, the GroundStation resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ReleaseMode string
Release Status of a ground station.
SystemData Pulumi.AzureNative.Orbital.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
ReleaseMode string
Release Status of a ground station.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
releaseMode String
Release Status of a ground station.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
releaseMode string
Release Status of a ground station.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
release_mode str
Release Status of a ground station.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
releaseMode String
Release Status of a ground station.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

Capability
, CapabilityArgs

EarthObservation
EarthObservation
Communication
Communication
CapabilityEarthObservation
EarthObservation
CapabilityCommunication
Communication
EarthObservation
EarthObservation
Communication
Communication
EarthObservation
EarthObservation
Communication
Communication
EARTH_OBSERVATION
EarthObservation
COMMUNICATION
Communication
"EarthObservation"
EarthObservation
"Communication"
Communication

GroundStationsPropertiesGlobalCommunicationsSite
, GroundStationsPropertiesGlobalCommunicationsSiteArgs

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.

GroundStationsPropertiesResponseGlobalCommunicationsSite
, GroundStationsPropertiesResponseGlobalCommunicationsSiteArgs

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
, SystemDataResponseArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:orbital:GroundStation westus_gs1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Orbital/groundStations/{groundStationName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native