az orbital spacecraft

Note

This reference is part of the orbital extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az orbital spacecraft command. Learn more about extensions.

Satellites must be registered as a spacecraft with Azure Orbital to establish contacts with the satellite.

Commands

Name	Description	Type	Status
az orbital spacecraft contact	At the scheduled time, the selected ground station will contact the spacecraft and start data retrieval/delivery using the contact profile.	Extension	GA
az orbital spacecraft contact create	Create a contact.	Extension	GA
az orbital spacecraft contact delete	Delete a specified contact.	Extension	GA
az orbital spacecraft contact list	List contacts by spacecraft.	Extension	GA
az orbital spacecraft contact show	Get the specified contact in a specified resource group.	Extension	GA
az orbital spacecraft contact wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az orbital spacecraft create	Create a spacecraft resource.	Extension	GA
az orbital spacecraft delete	Delete a specified spacecraft resource.	Extension	GA
az orbital spacecraft list	List spacecrafts.	Extension	GA
az orbital spacecraft list-available-contact	List 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.	Extension	GA
az orbital spacecraft show	Get the specified spacecraft in a specified resource group.	Extension	GA
az orbital spacecraft update	Update spacecraft.	Extension	GA
az orbital spacecraft wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az orbital spacecraft create

Create a spacecraft resource.

az orbital spacecraft create --name --spacecraft-name
                             --resource-group
                             [--links]
                             [--location]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--norad-id]
                             [--tags]
                             [--title-line]
                             [--tle-line1]
                             [--tle-line2]

Examples

Create a Spacecraft

az orbital spacecraft create --name <spacecraft-name> --resource-group <resource-group> -l eastus --norad-id 27424 --title-line "AQUA" --tle-line1 "1 27424U 02022A   22192.74014189  .00000435  00000+0  10624-3 0  9992" --tle-line2 "2 27424  98.2482 134.4016 0001650 100.5984  12.3416 14.57323336 73769" --links "[{name:downlink,bandwidth-m-hz:15,center-frequency-m-hz:8160,polarization:RHCP,direction:Downlink}]"

Required Parameters

--name --spacecraft-name -n

Spacecraft ID.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--links

Immutable list of Spacecraft links. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Parameters Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--norad-id

NORAD ID of the spacecraft.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--title-line

Title line of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

--tle-line1

Line 1 of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

--tle-line2

Line 2 of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft delete

Delete a specified spacecraft resource.

az orbital spacecraft delete [--ids]
                             [--name --spacecraft-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Examples

Delete Spacecraft

az orbital spacecraft delete --name <spacecraft-name> --resource-group <resource-group>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --spacecraft-name -n

Spacecraft ID.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft list

List spacecrafts.

az orbital spacecraft list [--resource-group]
                           [--skiptoken]

Examples

List Spacecrafts by Subscription

az orbital spacecraft list

List Spacecrafts by Resource Group

az orbital spacecraft list -g <resource-group>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--skiptoken

An opaque string that the resource provider uses to skip over previously-returned results. This is used when a previous list operation call returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft list-available-contact

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

az orbital spacecraft list-available-contact --contact-profile
                                             --end-time
                                             --ground-station-name
                                             --resource-group
                                             --spacecraft-name
                                             --start-time
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

List Available Contacts

az orbital spacecraft list-available-contact -g <resource-group> --spacecraft-name <spacecraft-name> --contact-profile "{id:<contact-profile-id>}" --ground-station-name <ground-station-name> --start-time "2022-11-14T00:55:31.820Z" --end-time "2022-11-15T00:55:31.820Z"

Required Parameters

--contact-profile

The reference to the contact profile resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--end-time

End time of a contact (ISO 8601 UTC standard).

Property	Value
Parameter group:	Parameters Arguments

--ground-station-name

Name of Azure Ground Station.

Property	Value
Parameter group:	Parameters Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--spacecraft-name

Spacecraft ID.

--start-time

Start time of a contact (ISO 8601 UTC standard).

Property	Value
Parameter group:	Parameters Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft show

Get the specified spacecraft in a specified resource group.

az orbital spacecraft show [--ids]
                           [--name --spacecraft-name]
                           [--resource-group]
                           [--subscription]

Examples

Get Spacecraft

az orbital spacecraft show --name <spacecraft-name> --resource-group <resource-group>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --spacecraft-name -n

Spacecraft ID.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft update

Update spacecraft.

az orbital spacecraft update [--add]
                             [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                             [--ids]
                             [--location]
                             [--name --spacecraft-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--norad-id]
                             [--remove]
                             [--resource-group]
                             [--set]
                             [--subscription]
                             [--tags]
                             [--title-line]
                             [--tle-line1]
                             [--tle-line2]

Examples

Update Spacecraft Tags

az orbital spacecraft update --name <spacecraft-name> --resource-group <resource-group> --tags "{tag1:value1,tag2:value2}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--location -l

The geo-location where the resource lives.

Property	Value
Parameter group:	Parameters Arguments

--name --spacecraft-name -n

Spacecraft ID.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--norad-id

NORAD ID of the spacecraft.

Property	Value
Parameter group:	Properties Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters Arguments

--title-line

Title line of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

--tle-line1

Line 1 of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

--tle-line2

Line 2 of the two-line element set (TLE).

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az orbital spacecraft wait

Place the CLI in a waiting state until a condition is met.

az orbital spacecraft wait [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--ids]
                           [--interval]
                           [--name --spacecraft-name]
                           [--resource-group]
                           [--subscription]
                           [--timeout]
                           [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --spacecraft-name -n

Spacecraft ID.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False