az orbital spacecraft contact

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 contact command. Learn more about extensions.

At the scheduled time, the selected ground station will contact the spacecraft and start data retrieval/delivery using the contact profile.

Commands

Name	Description	Type	Status
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 contact create

Create a contact.

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

Examples

Create Contact

az orbital spacecraft contact create -g <resource-group> --name <contact-name> --spacecraft-name <spacecraft-name> --contact-profile "{id:<contact-profile-id>}" --ground-station-name <ground-station-name> --reservation-start-time "2022-07-27T00:55:31.820Z" --reservation-end-time "2022-07-27T00:56:31.820Z"

Required Parameters

--contact-name --name -n

Contact name.

--resource-group -g

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

--spacecraft-name

Spacecraft ID.

Optional Parameters

--contact-profile

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

--ground-station-name

Azure Ground Station name.

--no-wait

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

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

--reservation-end-time

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

--reservation-start-time

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az orbital spacecraft contact delete

Delete a specified contact.

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

Examples

Delete Contact

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

Optional Parameters

--contact-name --name -n

Contact name.

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

--no-wait

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

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

--spacecraft-name

Spacecraft ID.

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az orbital spacecraft contact list

List contacts by spacecraft.

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

Examples

List Contacts

az orbital spacecraft contact list -g <resource-group> --spacecraft-name <spacecraft-name>

Required Parameters

--resource-group -g

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

--spacecraft-name

Spacecraft ID.

Optional Parameters

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az orbital spacecraft contact show

Get the specified contact in a specified resource group.

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

Examples

Get Contact

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

Optional Parameters

--contact-name --name -n

Contact name.

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

--resource-group -g

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

--spacecraft-name

Spacecraft ID.

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az orbital spacecraft contact wait

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

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

Optional Parameters

--contact-name --name -n

Contact name.

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30

--resource-group -g

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

--spacecraft-name

Spacecraft ID.

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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